add_action()

add_action(string $tag, callable $function_to_add, int $priority= 10, int $accepted_args= 1 )

یک هوک برای فراخوانی یک اکشن خاص

توضیحات add_action()

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

پارامترهای add_action()

• tag: نام اکشنی که به تابع function_to_add قلاب می‌شود.
• function_to_add: نام تابعی که دستورات در آن قرار می‌گیرد و آن را فراخوانی می‌کنید.
• priority: برای مشخص کردن ترتیب اجرا اکشن‌ها می توانید این پارامترها را مقداردهی کنید. عدد پایینتر زودتر اجرا می‌شوند. اگر مقداری را برای این پارامتر مشخص نکنید با بقیه اکشن‌ها به ترتیب فراخوانی آنها در وردپرس فراخوانی می‌شود. مقدار پیش فرض آن 10 می‌باشد.
• accepted_args: تعداد آرگومانهای که تابع می‌پذیرد. مقدار پیش فرض آن 1 است.

خروجی add_action():

مقدار بازگشتی همیشه true است.منبع:

File: wp-includes/plugin.php

function add_action( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {
    return add_filter( $tag, $function_to_add, $priority, $accepted_args );
}

نحوه استفاده :

add_action( $hook, $function_to_add, $priority, $accepted_args );

برای فهمیدن تعداد و نام آرگومانهای یک اکشن,  کافی است نام اکشن را برای do_action سرچ کنید. برای مثال, اگر شما هوک save_post را فراخوانی کنید, شما می‌توانید این مقادیر را در post.php پیدا کنید.

do_action( 'save_post', $post_ID, $post, $update );

و تابعی که شما باید بنویسید

function wpdocs_my_save_post( $post_ID, $post, $update ) {
   // do stuff here
}