نیازمندی های هدر

همانطور که در مقالات قبلی توضیح داده شد ، فایل اصلی PHP باید شامل توضیحات هدر باشد که به وردپرس می گوید که این فایل یک پلاگین است و اطلاعاتی در مورد پلاگین ارائه می دهد.

حداقل فیلدها

حداقل، یک توضیح هدر باید حاوی نام پلاگین باشد:

/*
 * Plugin Name: YOUR PLUGIN NAME
 */

فیلدهای هدر

فیلدهای هدر موجود:

• Plugin Name: ( الزامی ) نام پلاگین شما که در لیست پلاگین ها در مدیریت وردپرس نمایش داده می شود.
• Plugin URI: صفحه وب پلاگین، که باید یک URL منحصر به فرد باشد، ترجیحاً در وب سایت خودتان. این آدرس باید منحصر به فرد پلاگین شما باشد. برای مثال، نمی توانید از URL WordPress.org استفاده کنید.
• Description: شرح کوتاهی از پلاگین، که در بخش پلاگین ها در مدیریت وردپرس نمایش داده می‌شود. این توضیحات کمتر از 140 کاراکتر باشد.
• Version: شماره نسخه فعلی پلاگین، مانند 1.0 یا 1.0.3.
•  Requires at least: پایین ترین نسخه وردپرس که پلاگین روی آن کار می کند.
• Requires PHP: حداقل نسخه PHP مورد نیاز.
• Author: نام نویسنده پلاگین. ممکن است چندین نویسنده با استفاده از کاما فهرست شوند.
• Author URI: وب سایت یا نمایه نویسنده در وب سایت دیگر، مانند  WordPress.org.
• License: نام کوتاه (slug) مجوز پلاگین (به عنوان مثال  GPLv2). برای کسب اطلاعات بیشتر در مورد صدور مجوز به آدرس WordPress.org guidelines مراجعه نمایید.
• License URI: پیوندی به متن کامل مجوز (به عنوان مثالhttps://www.gnu.org/licenses/gpl-2.0.html ).
• Text Domain: دامنه متنی  gettextپلاگین. برای اطلاعات بیشتر، بخش Text Domain را در صفحه نحوه بین‌المللی کردن(چندزبانه سازی) پلاگین، مطالعه کنید.
• Domain Path: مسیر دامنه به وردپرس اجازه می دهد تا بداند ترجمه ها را کجا پیدا کند. برای اطلاعات بیشتر، بخش Domain Path  در صفحه نحوه بین‌المللی کردن پلاگین را مطالعه کنید .
• Network: آیا این پلاگین فقط در سراسر شبکه قابل فعال شدن است یا خیر. و فقط می‌تواند با مقدار  true  تنظیم شود و در مواقعی که مورد نیاز نیست باید بدون مقدار باشد.
• Update URI: هنگام  به‌روزرسانی پلاگین با نام مشابه از دایرکتوری پلاگین  WordPress.org، مانع رونویسی تصادفی پلاگین های شخص ثالث  خواهد شد. برای اطلاعات بیشتر، نکات توسعه را مطالعه کنید.
• Requires Plugins: یک لیست جدا شده با کاما از Slugs های با فرمت WordPress.org برای وابستگی های آن، مانند  my-plugin ( my-plugin/my-plugin.php  پشتیبانی نمی شود). در slug های پلاگین از کاما پشتیبانی نمی کند. برای اطلاعات بیشتر، یادداشت توسعه را مطالعه کنید.

یک فایل PHP معتبر با توضیحات هدر ممکن است به شکل زیر باشد:

/*
 * Plugin Name:       My Basics Plugin
 * Plugin URI:        https://example.com/plugins/the-basics/
 * Description:       Handle the basics with this plugin.
 * Version:           1.10.3
 * Requires at least: 5.2
 * Requires PHP:      7.2
 * Author:            John Smith
 * Author URI:        https://author.example.com/
 * License:           GPL v2 or later
 * License URI:       https://www.gnu.org/licenses/gpl-2.0.html
 * Update URI:        https://example.com/my-plugin/
 * Text Domain:       my-basics-plugin
 * Domain Path:       /languages
 * Requires Plugins:  my-plugin, yet-another-plugin
 */

در مثال زیر از  PHPDoc DocBlock در سطح فایل و همچنین هدرهای فایل پلاگین وردپرس استفاده شده است:

/**
 * Plugin Name
 *
 * @package           PluginPackage
 * @author            Your Name
 * @copyright         2019 Your Name or Company Name
 * @license           GPL-2.0-or-later
 *
 * @wordpress-plugin
 * Plugin Name:       Plugin Name
 * Plugin URI:        https://example.com/plugin-name
 * Description:       Description of the plugin.
 * Version:           1.0.0
 * Requires at least: 5.2
 * Requires PHP:      7.2
 * Author:            Your Name
 * Author URI:        https://example.com
 * Text Domain:       plugin-slug
 * License:           GPL v2 or later
 * License URI:       http://www.gnu.org/licenses/gpl-2.0.txt
 * Update URI:        https://example.com/my-plugin/
 * Requires Plugins:  my-plugin, yet-another-plugin
 */

نکته

هنگام اختصاص شماره نسخه به پروژه خود، به خاطر داشته باشید که وردپرس از تابع PHP version_compare() برای مقایسه شماره نسخه پلاگین استفاده می کند. بنابراین، نسخه بروز رسانی جدید، باید بزرگتر از نسخه قبلی باشد.