apply_filters_deprecated() — описание функции WordPress на русском

Сигнатура

apply_filters_deprecated( string $hook_name, array $args, string $version, string $replacement = '', string $message = '' ): mixed

Описание

Когда хук-фильтр становится устаревшим, вызов apply_filters() заменяется на apply_filters_deprecated() , который выдаёт уведомление об устаревании, а затем запускает исходный хук-фильтр.
Примечание: значение и дополнительные аргументы, передаваемые в исходный вызов apply_filters() , нужно передать здесь в $args в виде массива. Например:

// Старый фильтр.
return apply_filters( 'wpdocs_filter', $value, $extra_arg );

// Устаревший вариант.
return apply_filters_deprecated( 'wpdocs_filter', array( $value, $extra_arg ), '4.9.0', 'wpdocs_new_filter' );См. also_deprecated_hook()

Оригинал (английский)

When a filter hook is deprecated, the apply_filters() call is replaced with apply_filters_deprecated() , which triggers a deprecation notice and then fires the original filter hook.

Note: the value and extra arguments passed to the original apply_filters() call must be passed here to $args as an array. For example:

// Old filter.
return apply_filters( 'wpdocs_filter', $value, $extra_arg );

// Deprecated.
return apply_filters_deprecated( 'wpdocs_filter', array( $value, $extra_arg ), '4.9.0', 'wpdocs_new_filter' );

Параметры

$hook_name string обязательный

Имя хука-фильтра.

$args array обязательный

Массив дополнительных аргументов функции, передаваемых в apply_filters() .

$version string обязательный

Версия WordPress, в которой хук стал устаревшим.

$replacement string необязательный = ''

Хук, который следовало использовать.

$message string необязательный = ''

Сообщение об изменении.

Возвращаемое значение

mixed

Исходный код

wp-includes/plugin.php:722

function apply_filters_deprecated( $hook_name, $args, $version, $replacement = '', $message = '' ) {
	if ( ! has_filter( $hook_name ) ) {
		return $args[0];
	}

	_deprecated_hook( $hook_name, $version, $replacement, $message );

	return apply_filters_ref_array( $hook_name, $args );
}

История изменений

Версия	Описание
4.6.0	Introduced.