طراحی پلاگین وردپرس

نام، فایل ها و موقعیت ها

نام پلاگین

اولین کار برای طراحی یک پلاگین فکر کردن به اینکه پلاگین چه کاری انجام میدهد و انتخاب یک نام منحصر به فرد برای آن است و سرچ منابع و مخازن وردپرس و در نهایت سرچ در گوگل برای اطمینان به اینکه نام پلاگین منحصر به فرد باشد. نام پلاگین به کاربرد آن نیز باید اشاره داشته باشد.برای مثال یک پلاگین آب و هوا احتمالاً در نام خود از آب و هوا نیز استفاده میکند.

فایل های پلاگین

مرحله بعد برای ساخت پلاگین ایجاد فایل های php است. برای مثال اگر پلاگین شما کارکرد افسانه ای (Fabulous Functionality) نام داشته باشد شما باید فایل php خود را fabulous-functionality.php نام گذاری کنید. باز هم میگوییم سعی کنید برای پلاگینتان نام منحصر به فردی انتخاب کنید.

کسانی که پلاگین شما را نصب میکنند این فایل php را در مسیر دایرکتوری پلاگین وردپرس (wp-content/plugins) کپی میکند پس  بنا براین نام پلاگین باید منحصر به فرد باشد تا فایل های پلاگین ها برای هم اختلال ایجاد نکنند.

 

یکی دیگر از تنظیمات، تقسیم بندی پلاگین به چند فایل php است. پلاگین وردپرس شما حداقل باید یک فایل php داشته باشد و            می تواند شامل فایل های جاوا اسکریپت،  فایل های css، فایل های تصویری، فایل های زبان و غیره  باشد. اگر بیش از یک فایل داشته باشد،   باید یک پوشه با نام پلاگینتان ساخته شود و فایل ها در آن قرار گیرد همینطور نیز فایل اصلی هم باید به نام پلاگینتان در آیید و به کاربران پلاگینتان بگویید برای نصب پلاگین تمام پوشه را به مسیر دایرکتوری پلاگین وردپرس (wp-content/plugins) منتقل کنند.

توجه: نصب پلاگین های وردپرس فقط در مسیر دایرکتوری پلاگین وردپرس (wp-content/plugins) انجام میشود و آدرس ها مطلق هستند. بنابراین شما باید از تابع های plugin_dir_path()    و   plugins_url()     برای مسیر های ثابت استفاده کنید.

برای جزئیات بیشتر در مورد توابع مسیرها در وردپرس میتوانید به http://codex.wordpress.org/Determining_Plugin_and_Content_Directories

مراجعه کنید.

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

 

defined('ABSPATH') or die("No script kiddies please!");

در ادامه این مقاله “the Plugin PHP file” در مورد مسیر های فایل اصلی پلاگین چه در مسیر دایرکتوری پلاگین چه در زیر پوشه های داخلی پلاگین بحث میشود.

فایل   README

اگر شما میخواهید پلاگین خود را در  http://wordpress.org/extend/plugins/  قرار دهید، باید یک فایل توضیحات با نام README.txt در قالب استاندارد ایجاد کنید. برای مثاال میتوانید به لینک زیر مراجعه کنید

http://wordpress.org/extend/plugins/about/readme.txt

یا با استفاده از آدرس (plugin ‘readme.txt’ generator) فایل توضیحات خود را به صورت اوتومایک بسازید.

توجه داشته باشید که مخزن پلاگین وردپرس ورژن وردپرس را برای بالاتر بودن ورژن وردپرس از آنچه که در README.txt است چک میکند.

صفحه اصلی(Home Page)

ساخت یک صفحه اصلی برای پلاگین شما بسیار مفید است.

صفحه اصلی باید توضیح دهد پلاگین چگونه نصب شود، پلاگین چه کاری را انجام میدهد، در چه ورژن هایی از وردپرس کار میکند، کدام ورژن از پلاگین است و چگونه باید از آن استفاده کرد.

 فایل های سرصفحه(File Headers)

حالا زمان آن است که برخی اطلاعات و کتابخانه های مورد نیاز پلاگین را به فایل اصلی خود اضافه کنید

استاندارد اطلاعات پلاگین

در بالای فایل اصلی پلاگین شما باید اطلاعات استاندار د پلاگین درج شود.( header)

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

فرمت هدر :


<?php>

/**

* Plugin Name: Name Of The Plugin

* Plugin URI: http://URI_Of_Page_Describing_Plugin_and_Updates

* Description: A brief description of the Plugin.

* Version: The Plugin's Version Number, e.g.: 1.0

* Author: Name Of The Plugin Author

* Author URI: http://URI_Of_The_Plugin_Author

* License: A "Slug" license name e.g. GPL2

*/

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

بهتر است برای معرفی ورژن پلاگین خود یک روش انتخاب کنید تا ورژن پلاگین به صورت خوانا باشد به طور مثال

xx.xx.xx.xx یا x.x.x.x .

مجوز باید یک شناسه مشترک، کوتاه برای پلاگین باشد و این ساده ترین راه برای اعلام صریح و روشن مجوز برای کدهاست.

تذکر: تمامی فایل ها باید به صورت utf8 ذخیره شوند.

مجوز

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

برای استفاده از یک مجوز GPL2 کافیست کدهای زیر را در پلاگین خود کپی کنید.


<?php
/*  Copyright YEAR  PLUGIN_AUTHOR_NAME  (email : PLUGIN AUTHOR EMAIL)

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2, as
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  ۰۲۱۱۰-۱۳۰۱  USA
*/

در ادامه آموزش های سلسه مراتبی طراحی پلاگین وردپرس شرکت آن فایو قصد بررسی (طراحی پلاگین وردپرس بخش سوم) را خواهیم داشت.

با ما حرفه ای شوید.