remove_filter() WordPress Function

The remove_filter() function is used to remove a previously added filter. It can be used to remove both default and custom filters.

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

Removes a callback function from a filter hook.


Description

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.


Top ↑

Parameters

$hook_name

(string)(Required)The filter hook to which the function to be removed is hooked.

$callback

(callable|string|array)(Required)The callback to be removed from running when the filter is applied. This function can be called unconditionally to speculatively remove a callback that may or may not exist.

$priority

(int)(Optional) The exact priority used when adding the original filter callback.

Default value: 10


Top ↑

Return

(bool) Whether the function existed before it was removed.


Top ↑

Source

File: wp-includes/plugin.php

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;
}


Top ↑

Changelog

Changelog
VersionDescription
1.2.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.