add_action

Регистрирует хук-событие. При регистрации указывается PHP функция, которая сработает в момент события, которое вызывается с помощью do_action().

Хук на который цепляется функция добавляется с помощью функции do_action().

Действия (actions), в отличии от фильтров (add_filter()), нужны, чтобы выполнить какое-либо действие в нужный момент, тогда как фильтры передают и получают обратно данные, которые затем используются.

Список всех важных событий в порядке их выполнения указан на странице хуки.

Неофициально: фильтры – это те же самые события, работают они точно также и их можно использовать как события (вместо add_filter() можно использовать функцию add_action() и наоборот). Например, можно не изменяя возвращать полученные данные, но помимо этого выполнять какую-нибудь операцию (например запись в БД). Правда это бывает нужно очень редко. Все места где нужно вмешаться в код движка, разработчики, пытаются предусмотреть и вставить в это место событие.

О фильтрах и событиях читайте в этой заметке: как работают хуки в WordPress
✈ 1 раз = 0.000018с = очень быстро | 50000 раз = 0.07с = скорость света PHP 7.0.8, WP 4.7

Хуков нет.

Возвращает

false или true, в зависимости от того удалось ли зарегистрировать хук.

Использование

add_action( $tag, $function_to_add, $priority, $accepted_args );
$tag(строка) (обязательный)
Название действия, к которому будем цеплять функцию.
По умолчанию: нет
$function_to_add(строка/колбэк) (обязательный)
Название функции, которая должна быть вызвана во время срабатывания действия, т.е. функция которую цепляем к хуку. Формат передачи функции – обычно строка (подробнее тут).
По умолчанию: нет
$priority(число)
Приоритет выполнения функции. Если на этот же хук “прицеплены” еще функции, то приоритет будет решать последовательность их выполнения. Меньше число – раньше выполняется, т.е. 10 будет выполняться раньше чем 20.
По умолчанию: 10
$accepted_args(число)
Число аргументов, которые принимает функция. Разумеется действие должно передавать это число аргументов.
По умолчанию: 1

Примеры

#1 Обычный хук

Будем отправлять письмо друзьям, при публикации нового поста:

function email_friends( $post_ID ){
   $friends = 'bob@example.org, susie@example.org';
   wp_mail( $friends, "sally's blog updated", 'I just put something on my blog: http://blog.example.com' );

   return $post_ID;
}
add_action('publish_post', 'email_friends');

Точно так же можно зарегистрировать этот хук через add_filter():

add_filter('publish_post', 'email_friends');

#2 Получение аргумента

do_action() передает аргумент в функцию и его можно использовать. В предыдущем примере это был ID поста, но мы его не использовали, потому он нам не был нужен. Теперь, пример того, как использовать передаваемый аргумент:

function echo_comment_id( $comment_ID ){
   echo "I just received ". $comment_ID;
}
add_action('comment_id_not_found', 'echo_comment_id', 10, 1 );

#3 Анонимная функция

В качестве колбэк функции можно передавать анонимную функцию, например:

<?php add_action('wp_head', function() { echo 'something';}) ?>

Такие анонимные функции не работают совместно с PHP ускорителями.

Также, важно знать, что такую анонимную функцию в дальнейшем невозможно будет удалить функцией remove_action().

#4 Добавление события из PHP класса

Если для события нужно использовать как-либо метод PHP класса, то во втором аргументе, вместо названия функции, нужно указать массив, где первым аргументом будет название класса, а вторым название метода этого класса.

Для случаев когда событие вызывается внутри класса (чаще всего так и происходит), вместо название класса (первый аргумент массива), указывается $this:

// Подключение метода класса за пределами класса
add_action( 'wp_head', array( 'MyClass', 'mymethod' ) );

class MyClass {
	public function __construct() {
	// Подключение метода класса внутри класса
		add_action( 'save_post', array( $this, 'mymethod' ) );
	}

	public function mymethod() {
		// код функции
	}
}

Заметки

Чтобы узнать сколько аргументов передает действие, найдите его в коде и посмотрите. Например, тут передается 2 аргумента:

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

и для такого хука, код зацепки будет выглядеть так:

add_action( 'save_post', 'my_save_post', 10, 2 );

а функция будет иметь 2 аргумента:

function my_save_post( $post_ID, $post ){
   // здесь код функции
}

Код из


wp-includes/plugin.php

WP 4.7.2

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

Комментарии:


Оставить комментарий

Your email address will not be published. Required fields are marked *