do_action() │ WP 1.2.0

Цю функцію можна використовувати в плагінах, темах і т.д., коли потрібно впровадитись у процес виконання коду, звідкись з іншого місця. Наприклад, “зачіпку” (хук) (do_action) ми встановили в плагіні, а “чіплятися” за неї будемо з файлу functions.php в той момент, коли спрацьовуватиме наша “зачіпка”.

Допустимо, ми використовували такий код у плагіні:

<?php
// Визначаємо аргументи для хука action
$a = $defined; // $defined якась динамічна логічна змінна
$b = 'А це значення другої змінної';

// Включаємо хук. Тут він виконуватиметься
do_action( 'my_hook', $a, $b);

Тепер ми можемо зробити якусь дію в момент спрацьовування функції do_action і при цьому описати нашу дію можна, наприклад, з файлу functions.php, розмістивши в ньому такий код:

function do_my_hook( $a, $b ){
	// якщо передана змінна $a дорівнює true,
	// то, наприклад, видалимо запис 10
	if( $a===true )
		wp_delete_post(10);
	// а тут просто виведемо змінну на екран
	echo '<br />'.$b; // виведе значення другої змінної
}
// Реєструємо хук через
// add_action($tag, $function_to_add, $priority, $accepted_args);
add_action( 'my_hook', 'do_my_hook', 10, 2);

Десь у (mu-)плагіні, темі чи ядрі. Наприклад, у файлі functions.php:

/**
 * У вас може бути стільки аргументів, скільки ви хочете,
 * але ваша функція зворотного виклику та виклик add_action повинні бути узгоджені за кількістю аргументів.
 * Примітка: `add_action` вище має 2, а 'i_am_hook' приймає 2.
 * Ви знайдете подібні хуки дій у багатьох темах та плагінах та у багатьох місцях @core.
 * @see: https://codex.wordpress.org/Plugin_API/Action_Reference
 */

/**
 * Визначаємо функцію зворотного виклику
 * Всередині цієї функції ви можете робити все, що вам заманеться.
 * Зі змінними, які завантажені у викликі do_action() вище.
 */
function who_is_hook( $a, $b ) {

	print_r($a); // `print_r` дані масиву всередині 1-го аргументу

	echo $b; // Виводимо символ перекладу рядка та значення 2-го аргументу
}

// потім додати його в хук дії, зіставивши певну кількість (2) аргументів у do_action
// див. [https://codex.wordpress.org/Function_Reference/add_action] у Кодексі

// add_action($tag, $function_to_add, $priority, $accepted_args);
add_action( 'i_am_hook', 'who_is_hook', 10, 2);

// Define the arguments for the action hook
$a = array(
	'eye patch' => 'yes',
	'parrot' => true,
	'wooden leg' => 1
);

$b = 'And Hook said: "I ate ice cream with Peter Pan."';

// Executes the action hook named 'i_am_hook'
do_action( 'i_am_hook', $a, $b);

Результат:

Array (
	['eye patch'] => 'yes'
	['parrot'] => true
	['wooden leg'] => 1
)
And hook said: "I ate ice cream with Peter Pan."