مستندات افزونه تاریخ شمسی و فارسی‌ساز وردپرس

مستندات فنی افزونه تاریخ شمسی و فارسی‌ساز وردپرس یا WP Shamsi برنامه نویسی شده توسط wpvar.com و منتشر شده در wordpress.org در این صفحه توضیح داده خواهد شد.

این مستندات مناسب برنامه‌نویسان و افراد آشنا با برنامه‌نویسی به زبان PHP می‌باشد.

سیستم افزودنی‌ها

سیستم افزودنی‌ها یک سیستم ماژولار طراحی شده در داخل افزونه است که قابلیت تشخیص و آنالیز اتوماتیک فایل های PHP را دارد. برای ثبت افزودنی باید فایل PHP آن را در پوشه addons داخل افزونه قرار دهید.

نمونه فایل افزودنی:

<?php
/**
 * @package WPSH
 */

defined('ABSPATH') or die();

class WPSH_Addon_Example extends WPSH_Addons
{

    function __construct()
    {
        global $wpsh_addon;

        // نامک افزودنی - به انگلیسی
        $slug = 'wpsh_example_addon';
        // نسخه افزودنی
        $version = '1.0.0';
        // نام افزودنی
        $name = __('افزودنی آزمایشی', 'wpsh');
        // توضیحات افزودنی
        $desc = __('توضیحات افزودنی آزمایشی', 'wpsh');
        // نام نویسنده افزودنی
        $author = 'نام نویسنده';
        // وبسایت نویسنده افزودنی
        $website = 'https://wpvar.com';
        // صفحه معرفی افزودنی برای کسب اطلاعات بیشتر
        $addon_home = 'https://wpvar.com/example';
        // آیا افزودنی به صورت پیشفرض فعال باشد
        $is_active = true;
 
        $wpsh_addon[] = array(
            'slug' => $slug,
            'version' => $version,
            'name' => $name,
            'desc' => $desc,
            'author' => $author,
            'website' => $website,
            'addon_home' => $addon_home,
            'is_active' => $is_active,
        );

        if (!parent::validate($slug, $is_active))
        {
            return false;
            die();

        }

    }
}

new WPSH_Addon_Example();


افزودنی های ثبت شده با نام و آدرس وبسایت شما در افزونه منتشر خواهند شد. برای انتشار افزودنی همراه با افزونه، فایل خود را به ایمیل ما ارسال کنید ویا در مخزن گیتاب ثبت کنید:

ایمیل: [email protected]
مخزن گیتاب: Github Repo

هوک‌های Filter

هوک‌ها در وردپرس محتویات فانکشن را تغییر می‌دهند. در ادامه هوک‌های ثبت شده توسط افزونه توضیح داده خواهند شد.

wpsh_date

خروجی اصلی تاریخ را هوک می کند. برای مثال برای عدم نمایش تاریخ در صفحات:

if(is_page())
{
	add_filter('wpsh_date', '__return_false');
}

wpsh_date_replace_formats

از این هوک برای ویرایش فرمت های تاریخ استفاده می‌شود. برای مثال:

add_filter('wpsh_date_replace_formats', 'wpvar_edit_filter');

function wpvar_edit_filter($filter)
{
	$filter = str_replace('F j, Y', 'Y-m-d', $filter);

	return $filter;
}

wpsh_date_skip_formats

فرمت های اضافه شده به این هوک توسط افزونه شمسی‌سازی نخواهند شد و به صورت میلادی نمایش داده خواهد شد. برای مثال:

add_filter('wpsh_date_skip_formats', 'wpvar_skip_filter');

function wpvar_skip_filter($skip_formats)
{
	$add_format = array('F j, Y');

	$skip_formats = array_merge($skip_formats, $add_format);

	return $skip_formats;
}