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

همانطور که در نوشته های قبلی توضیح داده شد ، هدر یا بخش عنوان فایل php افرونه ، قسمت اصلی افزونه برای معرفی آن به وردپرس می باشد .

در ساده ترین حالت هدر فایل افزونه ، می تواند تنها شامل نام افزونه باشد ، اما بخش های دیگری نیز وجود دارند که اطلاعات بیشتری در مورد افزونه را به نمایش می گذارند و معمولا باید مورد استفاده قرار گیرند .

نام افزونه   ( plugin name) : نام افزونه شما ، که در بخش مدیریت وردپرس و در لیست افزونه ها نمایش داده می شود .

صفحه اصلی افزونه (plugin URI): صفحه خانه یا صفحه اصلی افزونه شما که می تواند سایت wordpress.org یا سایت اختصاصی افزونه باشد .

توضیحات (description): یک توضیح کوتاه از افزونه شما که در مدیریت وردپرس نمایش داده می شود از حداکثر ۱۴۰ کاراکتر جهت توضیحات استفاده کنید .

نسخه (version): نسخه کنونی افزونه ، مثلا ۱.۰ یا ۱.۰.۳  . به این نکته توجه داشته باشید که وردپرس و API های افزونه از تابع  version_compare() جهت مقایسه نسخه افزونه با سایر قسمتهای وردپرس استفاده می کنند . مثلا ۱.۰۲ بزرگتر از ۱.۱ است .

نویسنده (author) : نام نویسنده افزونه . یک افزونه می تواند چند نویسنده داشته باشد . در مخزن وردپرس و در صفحه اصلی افزونه ، نام نویسندگان لیست می شود .

صفحه نویسنده (author URI): آدرس وب سایت یا صفحه پروفایل نویسنده افزونه

مجوز (license): نام کوتاه مجوز افزونه ، به عنوان مثال GPL2 اطلاعات بیشتر در مورد مجوزها را میتوانید در راهنمای wordpress.org مطالعه کنید .

آدرس مجوز (license URI ): یک لینک به مجوز افزونه ، به عنوان مثال https://www.gnu.org/licenses/gpl-2.0.html

دامنه متن (text domain ) : دامنه متن افزونه . برای اطلاعات بیشتر اینجا را ببینید

مسیر دامنه (domain path): آدرس دامنه استفاده شده که توسط آن وردپرس میتواند ترجمه های افزونه را پیدا کند .

یک هدر معتبر می تواند کدی مانند زیر داشته باشد :

<?php
/*
Plugin Name: My Toolset
Plugin URI:  https://URI_Of_Page_Describing_Plugin_and_Updates
Description: This describes my plugin in a short sentence
Version:     1.5
Author:      John Smith
Author URI:  https://URI_Of_The_Plugin_Author
License:     GPL2
License URI: httpss://www.gnu.org/licenses/gpl-2.0.html
Domain Path: /languages
Text Domain: my-toolset
*/

حداقل نیازمندی ها برای هدر یک افزونه به صورت زیر است :

<?php
/*
Plugin Name: My Toolset
*/