apply_filters() WP 0.71

Применяет прикрепленную к указанному фильтру PHP функцию. Прикрепляется функция с помощью add_filter().

Используется там, где нужно изменить значение переменной (например текст).

Используется в плагинах и темах, для создания хуков-фильтров (зацепок пользовательских функций).

Новые фильтры должны иметь уникальные названия и не должны совпадать с уже имеющимися в WP названиями фильтров.

Хуков нет.

Возвращает

Отфильтрованное значение $value, которое передается функции-обработчику хука.

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

apply_filters( $tag, $value, $var... );

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

Название фильтра.
По умолчанию: нет

$value(строка/массив/число/объект/логический) (обязательный)

Значение, которое будет передаваться функции в её первом аргументе, другими словами - значение, которое нужно отфильтровать.
По умолчанию: нет

$var(строка/массив/число/объект/логический)

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

Примеры

#1. Вывод на экран после фильтрации:

echo apply_filters( $tag, $value );

#2. Получение отфильтрованного значения:

$myvar = apply_filters( $tag, $value );

#3. Дополнительные аргументы:

$myvar = apply_filters( $tag, $value, $var1, $var2, ... );

#4. Пример вывода отформатированного контента записи через фильтр.

Альтернатива функции the_content():

global $post;
echo apply_filters( 'the_content', $post->post_content );

Заметки

• Global. Массив. $wp_filter Stores all of the filters.
• Global. Массив. $wp_current_filter Stores the list of current filters with the current one last.

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

Код apply filters: wp-includes/plugin.php ^{WP 5.2.2}

<?php
function apply_filters( $tag, $value ) {
	global $wp_filter, $wp_current_filter;

	$args = array();

	// Do 'all' actions first.
	if ( isset( $wp_filter['all'] ) ) {
		$wp_current_filter[] = $tag;
		$args                = func_get_args();
		_wp_call_all_hook( $args );
	}

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

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

	if ( empty( $args ) ) {
		$args = func_get_args();
	}

	// don't pass the tag name to WP_Hook
	array_shift( $args );

	$filtered = $wp_filter[ $tag ]->apply_filters( $value, $args );

	array_pop( $wp_current_filter );

	return $filtered;
}

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

Из метки: Фильтры (хуки)

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