بلاگ/آموزش ساخت افزونه وردپرس: Hook، Action و Filter به زبان ساده با محیط تست امن روی سرور مجازی
به‌روز شده

آموزش ساخت افزونه وردپرس: Hook، Action و Filter به زبان ساده با محیط تست امن روی سرور مجازی

1405/08/270 بازدید
آموزش ساخت افزونه وردپرس: Hook، Action و Filter به زبان ساده با محیط تست امن روی سرور مجازی

آموزش ساخت افزونه وردپرس: Hook، Action و Filter به زبان ساده با محیط تست امن روی سرور مجازی

اگر چند قالب و افزونهٔ آماده را دیده‌اید و فکر کرده‌اید کاش می‌شد یک کار کوچک را خودتان به سایت وردپرسی اضافه کنید، شروع افزونه‌نویسی از همین‌جاست. این آموزش ساخت افزونه وردپرس را از صفر می‌بریم: یک فایل افزونه با ساختار درست، فرق Hook، Action و Filter با مثال کد واقعی، و در آخر یک کپی تست روی سرور مجازی تا اشتباه‌های اول‌کاری به سایت اصلی نرسد.

افزونه وردپرس از نظر فنی چیست؟

از نگاه وردپرس، افزونه یک یا چند فایل PHP است که در پوشهٔ wp-content/plugins قرار می‌گیرد و وردپرس موقع بالا آمدن سایت آن را بار می‌کند. افزونه مستقیم تمپلیت یا دیتابیس را دستکاری نمی‌کند؛ کارش این است که به نقطه‌های مشخصی از اجرای وردپرس وصل شود و در همان نقطه کاری انجام بدهد یا مقداری را تغییر دهد. همین نقطه‌های وصل‌شدن را Hook می‌گویند و موضوع اصلی این مقاله هستند.

ساختار فایل و هدر افزونه

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

<?php
/**
 * Plugin Name: افزونه تست من
 * Description: یک افزونهٔ ساده برای تمرین Hook روی سایت تست
 * Version: 1.0
 * Author: نام شما
 */

Plugin Name مشخص می‌کند افزونه با چه عنوانی در فهرست افزونه‌های پنل نمایش داده شود. بعد از ذخیرهٔ همین فایل، افزونه در پنل وردپرس قابل فعال‌سازی است، حتی اگر هنوز هیچ کاری انجام نمی‌دهد.

Hook چیست و وردپرس چطور از آن استفاده می‌کند

Hook یک نقطهٔ از پیش تعریف‌شده در کد وردپرس است که می‌گوید «همین‌جا اگر کسی کاری دارد، بگوید». خود وردپرس، قالب‌ها و تقریبا هر افزونهٔ شناخته‌شده‌ای مثل Yoast یا WooCommerce، همگی از همین روش برای اضافه کردن قابلیت استفاده می‌کنند، بدون اینکه فایل‌های هسته را تغییر بدهند. Hook دو نوع دارد: Action و Filter، و فرقشان دقیقا همان چیزی است که تصمیم می‌گیرد کدام را در یک تابع به‌کار ببرید.

Action: وقتی می‌خواهید یک کار اضافه کنید

Action برای لحظه‌ای است که می‌خواهید کاری انجام شود؛ نمایش یک متن، ارسال ایمیل، ذخیرهٔ یک لاگ. تابعی که به یک Action وصل می‌کنید لازم نیست چیزی برگرداند، فقط کارش را انجام می‌دهد.

function my_plugin_add_footer_text() {
    echo '<p>این متن از افزونهٔ من اضافه شده</p>';
}
add_action( 'wp_footer', 'my_plugin_add_footer_text' );

این کد یک پاراگراف کوچک را به انتهای هر صفحهٔ سایت اضافه می‌کند، همان‌جایی که Hook به اسم wp_footer اجرا می‌شود.

Filter: وقتی می‌خواهید داده را تغییر دهید

Filter برعکس عمل می‌کند: یک مقدار را از وردپرس می‌گیرد، تغییرش می‌دهد و باید همان مقدار جدید را return کند؛ در غیر این صورت وردپرس هیچ مقداری دریافت نمی‌کند و همان بخش از سایت خالی می‌ماند.

function my_plugin_change_title( $title ) {
    return $title . ' - نسخهٔ ویژه';
}
add_filter( 'the_title', 'my_plugin_change_title' );

نمودار جریان Hook در وردپرس: تفاوت Action و Filter

برای جمع‌بندی، فرق این دو را کنار هم ببینید:

ویژگیActionFilter
کار اصلیاجرای یک کار در لحظهٔ مشخصتغییر یک مقدار و برگرداندن آن
مقدار برگشتیلازم نیست چیزی برگردانده شودباید همیشه مقدار را return کند
تابع ثبتadd_action()add_filter()
مثال رایجنمایش یک متن در فوترتغییر عنوان قبل از نمایش

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

یک خط کد اشتباه در یک Hook حساس مثل init یا the_content می‌تواند کل سایت را سفید کند، همان چیزی که در وردپرس به white screen of death معروف است. وقتی سایت اصلی فعال و در دسترس بازدیدکننده است، همین چند دقیقه رفع‌اشکال هم هزینه دارد: افت موقت رتبه برای آن بازه، از دست رفتن سفارش اگر فروشگاه باشد، یا فقط تجربهٔ بد برای کسی که درست همان لحظه وارد سایت می‌شود. تست روی یک کپی جدا از سایت اصلی، همین ریسک را از معادله حذف می‌کند.

ساخت یک کپی تست امن روی سرور مجازی

ساده‌ترین راه برای یک محیط تست جدا، یک سرور مجازی تازه است که فقط برای همین کار دارید؛ هر اشتباهی در آن بماند، روی سایت اصلی اثر ندارد. آریانت یک اپلیکیشن وردپرس یک‌کلیکی دارد که همین کار را چند دقیقه‌ای انجام می‌دهد: موقع ساخت سرور ابری، وردپرس را از لیست اپلیکیشن‌ها انتخاب می‌کنید و یک نسخهٔ Ubuntu آماده با وردپرس نصب‌شده تحویل می‌گیرید، با HTTPS فعال روی یک آدرس موقت. آدرس پنل مدیریت و نام کاربری هم همان‌جا در پنل آریانت نمایش داده می‌شود. چند نکتهٔ اولیهٔ بعد از نصب هم در این راهنما آمده.

مراحل کار:

  1. یک سرور ابری با اپلیکیشن وردپرس بسازید؛ پلن ۱ vCPU و ۱ گیگ رم برای یک سایت تست کافی است.
  2. با آدرس موقتی که در پنل نشان داده می‌شود وارد wp-admin شوید.
  3. پوشهٔ افزونه را از File Manager یا FTP داخل wp-content/plugins بگذارید، یا یک فایل zip از آن بسازید و از همان پنل وردپرس آپلود کنید.
  4. افزونه را فعال کنید و دقیقا همان کاری را که روی سایت اصلی قرار است انجام بدهد، همین‌جا امتحان کنید؛ صفحه را رفرش کنید و خطاها را ببینید.
  5. وقتی افزونه بدون خطا کار کرد، همان فایل را روی سایت اصلی هم فعال کنید.

اگر با خط فرمان راحت‌تر هستید، نصب و فعال‌سازی افزونه روی همین سرور تست را می‌توانید با WP-CLI هم انجام بدهید، بدون باز کردن پنل گرافیکی. قبل از انتقال افزونهٔ تایید شده به سایت اصلی، یک نگاه به چک‌لیست امنیت و سخت‌سازی وردپرس هم کمک می‌کند، چون یک افزونهٔ تازه از همان لحظهٔ فعال شدن بخشی از سطح امنیتی سایت شماست.

نکاتی که کمک می‌کند افزونه سرعت سایت را پایین نیاورد

هر Hook که اضافه می‌کنید روی هر بار بار شدن صفحه هم اجرا می‌شود؛ یک query اضافه در یک Hook پراستفاده مثل wp_head می‌تواند بی‌سروصدا سرعت کل سایت را کم کند. چند نکتهٔ عملی:

  • کار سنگین مثل درخواست به یک API خارجی را توی یک Hook که روی هر صفحه اجرا می‌شود نگذارید؛ آن را به یک cron job یا یک درخواست AJAX جدا منتقل کنید.
  • به‌جای وصل شدن به Hookهای عمومی مثل init برای کاری که فقط در یک صفحهٔ خاص لازم است، اول شرط صفحه را چک کنید (is_page یا is_single).
  • اگر افزونه چیزی را توی دیتابیس ذخیره می‌کند، از Transient API وردپرس برای کش کردن نتیجه استفاده کنید تا هر بار دوباره محاسبه نشود.

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

سؤالات متداول

آیا برای ساخت افزونهٔ وردپرس باید PHP را کامل بلد باشم؟ برای شروع، دانش پایهٔ PHP (تابع، متغیر، آرایه) کافی است؛ همان چیزی که برای نوشتن یک تابع و وصل کردنش به یک Hook لازم دارید. بقیه را همزمان با نوشتن افزونه یاد می‌گیرید.

فرق اصلی Action و Filter در یک جمله چیست؟ Action یک کار انجام می‌دهد و چیزی برنمی‌گرداند، Filter یک مقدار می‌گیرد، تغییرش می‌دهد و همان مقدار را برمی‌گرداند.

چرا افزونه‌ام را روی localhost تست نکنم، چه فرقی با سرور مجازی دارد؟ localhost هم گزینهٔ قابل قبولی است، اما شرایط واقعی مثل نسخهٔ PHP سرور، تنظیمات SSL یا آدرس عمومی برای تست webhook را ندارد؛ سرور مجازی همان شرایطی را می‌دهد که سایت اصلی روی آن کار می‌کند.

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

برای شروع افزونه‌نویسی لازم نیست منتظر یک پروژهٔ بزرگ باشید؛ یک سرور تست آماده کنید و همین مثال‌های این مقاله را رویش امتحان کنید. با اپلیکیشن وردپرس یک‌کلیکی آریانت یک سایت تست آماده در چند دقیقه بالا می‌آید، بدون اینکه سایت اصلی‌تان درگیر آزمایش و خطا شود.