آموزش برنامه‌نویسی یک پلاگین ساده برای وردپرس

برخی کاربران وردپرس همیشه کدها را به فایل توابع یا functions.php اضافه می‌کنند و برخی دیگر هر تابع و عمل خاص را به صورت یک پلاگین ساده ذخیره می‌کنند تا به راحتی با فعال و غیرفعال کردن افزونه از لیست افزونه‌های نصب‌شده، سایت خویش را مدیریت کنند.

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

در ادامه به روش ایجاد پلاگین‌های ساده در WordPress می‌پردازیم. با ما باشید.

ایجاد پلاگین جدید برای WordPress

برای ایجاد پلاگین وردپرس، یک فولدر ایجاد کنید و نام آن را همان نام پلاگین بگذارید. در این فولدر نیز یک فایل متنی ساده با پسوند php و عنوان پلاگین ایجاد کنید. به عنوان مثال:

• نام فولدر را plugin_name انتخاب کنید.
• نام فایل را plugin_name.php انتخاب کنید.

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

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

<?php
/*
Plugin Name: نام پلاگین
Plugin URI: http:// آدرس صفحه‌ی اینترنتی پلاگین
Description: در صورت نیاز توضیحی برای پلاگین
Version: 0.0.1
Author: نام سازنده‌ی پلاگین
Author URI: لینک صفحه‌ی پروفایل سازنده‌ی پلاگین
*/
// بستن اسکریپت در صورت دسترسی مستقیم
defined( 'ABSPATH' ) or die( 'Nope!' );

به عنوان مثال می‌توانید نام خودتان و وبلاگ شخصی را جایگزین کنید

<?php
/*
Plugin Name: YourPluginName
Plugin URI: https://it-planet.ir
Description: پلاگين آزمايشي
Version: 0.1
Author: عليرضا شيري
Author URI: https://it-planet.ir
*/
// بستن اسکريپت در صورت دسترسي مستقيم
defined( 'ABSPATH' ) or die( 'Nope!' );

ایجاد نوع جدید محتوا توسط پلاگین در وردپرس

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

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

// ايجاد نوع جديد محتوا
function yourpluginname_setup_post_type() {
 $labels = array(
  'name' => _x('نام نوع پست جديد', 'post type general name'),
  'singular_name' => _x('نام يک پست', 'post type singular name'),
  'add_new' => _x('Add New', ''),
  'add_new_item' => __('اضافه کردن پستي از نوع جديد'),
  'edit_item' => __('ويرايش پستي از نوع جديد'),
  'new_item' => __('ايجاد پستي از نوع جديد'),
  'view_item' => __('مشاهده کردن پستي از نوع جديد'),
  'search_items' => __('جستجو براي پست‌هايي از نوع جديد'),
  'not_found' => __('هيچ پستي از نوع جديد يافت نشد'),
  'not_found_in_trash' => __('هيچ پستي از نوع جديد در سطل زباله موجود نيست'),
  'parent_item_colon' => '',
  'all_items' => 'پست‌هايي از نوع جديد'
  );
  
 $args = array(
  'labels' => $labels,
  'public' => true,
  'publicly_queryable' => true,
  'show_ui' => true,
  'query_var' => true,
  'rewrite' => true,
  'capability_type' => 'post',
  'hierarchical' => false,
  'menu_position' => 8,
  'supports' => array('title', 'editor')
  );
  
// نام پلاگین مطابق با خط سوم در مشخصات پلاگین وارد شود 
 register_post_type('YourPluginName', $args);
//سه خط زیر غیرفعال است. برای فعال کردن، // را از ابتدای خطوط حذف کنید
 // بارگذاري فايل‌هاي استايل يا سي‌اس‌اس
 // wp_register_script('نام استايل پلاگين جديد شما', plugins_url('style.css', __FILE__));
 //wp_enqueue_script('نام استايل پلاگين جديد شما');
}
add_action('init', 'yourpluginname_setup_post_type');

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

دستور add-action نیز یک تابع دلخواه را به یک اکشن یا عمل در وردپرس اضافه می‌کند. از این دستور برای اضافه کردن تابع تعریف پست به Init استفاده شده که در حقیقت پس از بارگذاری وردپرس و قبل از ارسال هر نوع هدری، عمل می‌کند.

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

در نهایت فایل PHP و تمام محتویات فولدر پلاگین را به صورت ZIP درآورید و دقت کنید که نام فایل زیپ مثل نام فولدر پلاگین و فایل PHP باشد. اگر از لینوکس و شل Bash استفاده می‌کنید، دستور زیر را در ترمینال اجرا کنید:

zip -r superplugin.zip superplugin/*

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

 

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

همان‌طور که در تصویر فوق مشاهده می‌کنید، کاراکترهای فارسی به درستی شناخته نشده است. برای حل کردن این مشکل، ابتدا تمام متن موجود در فایل PHP را انتخاب کرده و کپی کنید و سپس از منوی Encoding نرم‌افزار Notepad++ گزینه‌ی Encode in UTF-8-BOM را انتخاب کنید تا نوع ایندینگ برای شناسایی حروف فارسی مناسب شود. حال تمام متن را مجدداً انتخاب کرده و متن قبلی را پیست کنید.

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

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

ایجاد صفحه‌ی تنظیمات افزونه‌ی WordPress

برای پلاگین‌های بسیار ساده شاید نیازی به صفحه‌ی تنظیمات نداشته باشید اما با پیچیده‌تر شدن عملکردهای پلاگین، قطعاً صفحه‌ی تنظیمات کمک زیادی به سادگی کار خواهد کرد. برای ایجاد یک گزینه‌ی جدید در صفحه‌ی تنظیمات، دستورات زیر را به فایل PHP پلاگین اضافه کنید:

// ایجاد صفحه‌ی تنظیمات افزونه
function yourpluginname_register_settings() {
 // افزودن یک آپشن تستی ساده
 add_option(‘yourpluginname_test_option’);
$args = array(
 ‘type’ => ‘string’,
 ‘sanitize_callback’ => ‘sanitize_text_field’,
 ‘default’ => NULL,
 );
register_setting(‘yourpluginname_all_options’, ‘yourpluginname_test_option’, $args);
}
add_action('admin_init', 'yourpluginname_register_settings');

در دستورات فوق، از add_action برای فراخوانی تابعی که آپشن تستی جدیدی را اضافه می‌کند، استفاده شده است.

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

// ایجاد صفحه‌ی تنظیمات
function yourpluginname_register_settings_page() {
 add_submenu_page(
 'edit.php?post_type=yourpluginname',
 'YourPluginName Settings',
 'تنظیمات',
 'manage_options',
 'yourpluginname-settings-page',
 'yourpluginname_display_settings_page'
 );
}
add_action('admin_menu', 'yourpluginname_register_settings_page', 99);
// فعال کردن نمایش صفحه‌ی تنظیمات و فراخوانی فایل صفحه
function yourpluginname_display_settings_page() {
 include plugin_dir_path( __FILE__ ) . 'settings.php';
}

در کدهای از اکشن جدید admin_menu برای افزونه گزینه‌ی جدید در منو استفاده شده و تابع مشخصات گزینه‌ی جدید و عملکرد آن تعریف شده است. در خطوط آخر یک فایل php دیگر به اسم settings.php در فولدر پلاگین فراخوانی شده، بنابراین به پنل مدیریت سرور یا هاست مراجعه کنید و ابزار مدیریت فایل را اجرا کنید. سپس در فولدر پلاگین سفارشی خویش، یک فایل php جدید با عنوان settings.php‌ بسازید.

و در فایل settings.php نیز دستورات زیر را قرار بدهید:

<?php
 // قالب صفحه‌ی تنظیمات افزونه
?>
<h1>عنوان صفحه‌ی تنظیمات</h1>
<form method="POST" action="options.php">
 <?php
  settings_fields('yourpluginname_all_options');
 ?>
<label for="yourpluginname_test_option">آپشن تستی</label><input type="text" name="yourpluginname_test_option" id="yourpluginname_test_option" value="<?php echo get_option('yourpluginname_test_option'); ?>"/>
<?php
  submit_button();yourpluginname_test_option
 ?>
</form>

تابع add_submenu_page برای اضافه کردن زیرمنو، تابع plugin_dir_path برای یافتن فولدر پلاگین فعلی، تابع settings_fields برای تعریف کردن فیلدهای تنظیمات و تابع get_options برای دریافت آپشن‌ها، در کدهای فوق به کار رفته است.

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

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

تمام دستورات فایل plugin_name.php به این صورت است:

<?php
/*
Plugin Name: YourPluginName
Plugin URI: https://it-planet.ir
Description: پلاگين آزمايشي
Version: 0.0.1
Author: عليرضا شيري
Author URI: https://it-planet.ir
*/
// بستن اسکريپت در صورت دسترسي مستقيم
defined( 'ABSPATH' ) or die( 'Nope!' );





// ايجاد نوع جديد محتوا
function yourpluginname_setup_post_type() {
 $labels = array(
  'name' => _x('نام نوع پست جديد', 'post type general name'),
  'singular_name' => _x('نام يک پست', 'post type singular name'),
  'add_new' => _x('Add New', ''),
  'add_new_item' => __('اضافه کردن پستي از نوع جديد'),
  'edit_item' => __('ويرايش پستي از نوع جديد'),
  'new_item' => __('ايجاد پستي از نوع جديد'),
  'view_item' => __('مشاهده کردن پستي از نوع جديد'),
  'search_items' => __('جستجو براي پست‌هايي از نوع جديد'),
  'not_found' => __('هيچ پستي از نوع جديد يافت نشد'),
  'not_found_in_trash' => __('هيچ پستي از نوع جديد در سطل زباله موجود نيست'),
  'parent_item_colon' => '',
  'all_items' => 'پست‌هايي از نوع جديد'
  );
  
 $args = array(
  'labels' => $labels,
  'public' => true,
  'publicly_queryable' => true,
  'show_ui' => true,
  'query_var' => true,
  'rewrite' => true,
  'capability_type' => 'post',
  'hierarchical' => false,
  'menu_position' => 8,
  'supports' => array('title', 'editor')
  );
  
// نام پلاگین مطابق با خط سوم در مشخصات پلاگین وارد شود 
 register_post_type('YourPluginName', $args);
//سه خط زیر غیرفعال است. برای فعال کردن، // را از ابتدای خطوط حذف کنید
 // بارگذاري فايل‌هاي استايل يا سي‌اس‌اس
 // wp_register_script('نام استايل پلاگين جديد شما', plugins_url('style.css', __FILE__));
 //wp_enqueue_script('نام استايل پلاگين جديد شما');
}
add_action('init', 'yourpluginname_setup_post_type');



// ایجاد گزینه‌ی جدید در صفحه‌ی تنظیمات افزونه
function yourpluginname_register_settings() {
 // افزودن یک آپشن تستی ساده
 add_option(‘yourpluginname_test_option’);
$args = array(
 ‘type’ => ‘string’,
 ‘sanitize_callback’ => ‘sanitize_text_field’,
 ‘default’ => NULL,
 );
register_setting(‘yourpluginname_all_options’, ‘yourpluginname_test_option’, $args);
}
add_action('admin_init', 'yourpluginname_register_settings');

// ایجاد صفحه‌ی تنظیمات
function yourpluginname_register_settings_page() {
 add_submenu_page(
 'edit.php?post_type=yourpluginname',
 'YourPluginName Settings',
 'تنظیمات',
 'manage_options',
 'yourpluginname-settings-page',
 'yourpluginname_display_settings_page'
 );
}
add_action('admin_menu', 'yourpluginname_register_settings_page', 99);
// فعال کردن نمایش صفحه‌ی تنظیمات و فراخوانی فایل صفحه
function yourpluginname_display_settings_page() {
 include plugin_dir_path( __FILE__ ) . 'settings.php';
}

codeburstسیاره‌ی ‌آی‌تی