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

Сигнатура

remove_filter( string $hook_name, callable|string|array $callback, int $priority = 10 ): bool

Описание

Это можно использовать, чтобы удалить стандартные функции, привязанные к конкретному хуку-фильтру, и при необходимости заменить их другими.
Чтобы удалить хук, аргументы $callback и $priority должны совпадать с теми, что были указаны при добавлении хука. Это касается как фильтров, так и действий. При неудачном удалении предупреждение не выдаётся.

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

This can be used to remove default functions attached to a specific filter hook and possibly replace them with a substitute.

To remove a hook, the $callback and $priority arguments must match when the hook was added. This goes for both filters and actions. No warning will be given on removal failure.

Параметры

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

Хук-фильтр, к которому привязана удаляемая функция.

$callback callable|string|array обязательный

Функция обратного вызова, которую нужно удалить, чтобы она не запускалась при применении фильтра. Эту функцию можно вызывать безусловно, чтобы предположительно удалить функцию обратного вызова, которая может существовать, а может и нет.

$priority int необязательный = 10

Точный приоритет, использованный при добавлении исходной функции обратного вызова фильтра.

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

bool

Исходный код

wp-includes/plugin.php:318

function remove_filter( $hook_name, $callback, $priority = 10 ) {
	global $wp_filter;

	$r = false;

	if ( isset( $wp_filter[ $hook_name ] ) ) {
		$r = $wp_filter[ $hook_name ]->remove_filter( $hook_name, $callback, $priority );

		if ( ! $wp_filter[ $hook_name ]->callbacks ) {
			unset( $wp_filter[ $hook_name ] );
		}
	}

	return $r;
}

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

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