مقدمه
با عرض سلام و وقت به خیر خدمت کاربران سایت پی وی لرن به ویژه کاربرانی که به سیستم مدیریت محتوای قدرتمند وردپرس علاقمند هستند.
به ” دوره متخصص وردپرس ” خوش آمدید!
در این دوره قرار است توسعه و ارتقاء پلاگین های وردپرس را به صورت جامع و کامل بیاموزیم.
فرقی نمی کند که در شرف نوشتن اولین پلاگین خود هستید و یا این که پنجاهمین پلاگین خود را می نویسید! امیدوارم این دوره برایتان مفید باشد.
در جلسه قبل با کی مقدمه مفصل با شاکله یک پلاگین آشنا شدیم و اصول و موارد ابتدایی که برای نوشتن یک پلاگین به آن احتیاج است؛ را شناختیم.
یکی از موراد لازم برای ساخت پلاگین، آشنایی با تنظیمات هدر پلاگین است که در این جلسه قرار است به آموزش آن بپردازیم.
تنظیمات هدر پلاگین
همان طور که در جلسات قبل اشاره شد؛ فایل اصلی PHP باید شامل عبارت هدر باشد.
عبارت هدر به وردپرس توضیح می دهد که فایل مورد نظر، فایل یک پلاگین است و اطلاعاتی را نیز راجع به آن پلاگین ارائه می دهد.
حداقل زمینه برای تنظیمات هدر پلاگین
عبارت هدر باید حداقل حاوی نام پلاگین Plugin Name باشد :
مثال :
| <?php /** * Plugin Name: YOUR PLUGIN NAME */ |
زمینه های هدر موجود عبارتند از :
- نام پلاگین Plugin Nam (الزامی)
نام پلاگین شما که در لیست پلاگین ها در مدیریت وردپرس نمایش داده می شود. - آدرس پلاگین Plugin URI
صفحه اصلی افزونه، که ترجیحا در وب سایت شما باید یک URL منحصر به فرد باشد.
در این جا نمی توان ز یک URL WordPress.org استفاده کرد. - توضیحات Description
شرح مختصری از افزونه تا در قسمت Plugins در مدیریت وردپرس نمایش داده شود.
سعی کنیداین شرح پلاگین تان بیش از ۱۴۰ کاراکتر نشود. - نسخه Version
شماره نسخه فعلی افزونه، مانند ۱٫۰ یا ۱٫۰٫۳٫ - حداقل نسخه وردپرس مورد نیاز Requires at least
تعیین حداقل نسخه وردپرس که می تواند پلاگین شما را در خود نصب کند. - حداقل نسخه PHP مورد نیاز Requires PHP
- نویسنده Author
تعیین نام نویسنده افزونه.
اگر افزونه دارای چندین نویسنده باشد؛ نام آن ها با کمک کاما از یک دیگر جدا می شود. - آدرس وب سایت نوینده پلاگین Author URI
- مجوز License
نام کوتاه مجوز استفاده از پلاگین. برای مثال (e.g. GPL2). - آدرس مجوز License URI
لینکی به متن کامل مجوز، برای مثال (https://www.gnu.org/licenses/gpl-2.0.html) - دامنه متن Text Domain
دامنه متن gettext پلاگین مورد نظر.
از طریق بخش Text Domain می توان اطلاعات بیشتری را راجع به نحوه بین المللی سازی پلاگین شما دانست. - مسیر دامنه Domain Path
مسیر دامنه به وردپرس اجازه می دهد که مکان ترجمه پلاگین را بداند.
این اطلاعات بیشتر را می توان در بخش مسیر Domain در صفحه How to Internationalize Plugin خود یافت. - شبکه Network
آیا افزونه تنها می تواند در سراسر شبکه فعال شود؟
آیا این پلاگین می تواند به درستی تنظیم شود و زمانی که به آن نیازی نیست می توان به راحتی از آن خارج شد یا خیر.
یک فایل php معتبر با یک عبارت هدر، شکلی شبیه به شکل زیر دارد :
مثال :
| <?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 * Text Domain: my-basics-plugin * Domain Path: /languages */ |
می توانید با استفاده از تولید کننده هدر پلاگین، زمینه های هدر متفاوتی را اجرا نمایید:
در ادامه مثال دیگری را مشاهده می کنید که مانند فایل هدر پلاگین وردپرس اجازه اجرای file-level PHPDoc DocBlock را می دهد :
مثال :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | <?php /** * 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 */ |
نکته
هنگام اختصاص شماره نسخه به پروژه خود، به یاد داشته باشید که وردپرس از تابع ()version_compare برای مقایسه نسخه های قبلی افزونه استفاده می کند.
بنابراین، قبل از انتشار یک نسخه جدید از افزونه خود، باید اطمینان حاصل کنید که این تابع php نسخه جدید را “بزرگتر” تر از قدیمی تر می دهد.
به عنوان مثال، ۱٫۰۲ در واقع بیشتر از ۱٫۱ است.
کلام آخر
در این جلسات با تنظمات هدر پلاگین آشنا شدیم و آموختیم که چه موارد برای ایجاد یک هدر لازم است.
در جلسه بعدی به نحوه ایجاد لایسنس پلاگین می پردازیم.
با پی وی لرن همراه باشید.
فروشگاه
فیلم های آموزشی
کتاب های آموزشی
مقالات آموزشی
وردپرس
