do_action_ref_array() WP 2.1.0

Создает событие (хук), на который затем можно прикрепить PHP функции. Аргументы передаются в виде массива.

Эта функция идентична do_action(). Разница в том, что аргументы передаваемые через этот хук определяются, используя массив. Это дает возможность передать переменную по ссылке.

Хуков нет.

Возвращает

null. Ничего

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

do_action_ref_array( $tag, $arg );

$tag(строка) (обязательный)

Название хука, на который будет вешаться функции через функцию add_action().
По умолчанию: нет

$arg(массив) (обязательный)

Аргументы передаваемые функции, которая будет цепляться на хук.
По умолчанию: нет

Примеры

#1 Пример создания хука с использованием do_action_ref_array()

// цепляем хук
add_action( 'myhook', 'myhook_func' );
function myhook_func( & $num ){
	$num = 2; // изменяем переменную по ссылке      
}

$num = 1;

// обрабатываем хук
do_action_ref_array('myhook', array( & $num ) );

echo $num; //> 2

Заметки

• Смотрите: do_action() This function is identical, but the arguments passed to the
  functions hooked to (hook_name) supplied using an array.
• Global. WP_Hook[]. $wp_filter Stores all of the filters and actions.
• Global. int[]. $wp_actions Stores the number of times each action was triggered.
• Global. Строка[]. $wp_current_filter Stores the list of current filters with the current one last.

Список изменений

Код do_action_ref_array() do action ref array ^{WP 5.8}

<?php
function do_action_ref_array( $hook_name, $args ) {
	global $wp_filter, $wp_actions, $wp_current_filter;

	if ( ! isset( $wp_actions[ $hook_name ] ) ) {
		$wp_actions[ $hook_name ] = 1;
	} else {
		++$wp_actions[ $hook_name ];
	}

	// Do 'all' actions first.
	if ( isset( $wp_filter['all'] ) ) {
		$wp_current_filter[] = $hook_name;
		$all_args            = func_get_args(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection
		_wp_call_all_hook( $all_args );
	}

	if ( ! isset( $wp_filter[ $hook_name ] ) ) {
		if ( isset( $wp_filter['all'] ) ) {
			array_pop( $wp_current_filter );
		}

		return;
	}

	if ( ! isset( $wp_filter['all'] ) ) {
		$wp_current_filter[] = $hook_name;
	}

	$wp_filter[ $hook_name ]->do_action( $args );

	array_pop( $wp_current_filter );
}

Cвязанные функции

Из метки: События (хуки)

Еще из раздела: Хуки: события, фильтры