remove_filter() WP 1.0

Removes a function from a specified filter hook.

This function removes a function attached to a specified filter hook. This method 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 $function_to_remove 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.

No Hooks.

Return

true/false. Whether the function existed before it was removed.

Usage

remove_filter( $tag, $function_to_remove, $priority );

$tag(string) (required)

The filter hook to which the function to be removed is hooked.

$function_to_remove(callable) (required)

The name of the function which should be removed.

$priority(int)

The priority of the function.
Default: 10

Code of remove_filter: wp-includes/plugin.php ^{VER 4.9.8}

<?php
function remove_filter( $tag, $function_to_remove, $priority = 10 ) {
	global $wp_filter;

	$r = false;
	if ( isset( $wp_filter[ $tag ] ) ) {
		$r = $wp_filter[ $tag ]->remove_filter( $tag, $function_to_remove, $priority );
		if ( ! $wp_filter[ $tag ]->callbacks ) {
			unset( $wp_filter[ $tag ] );
		}
	}

	return $r;
}

Related Functions

From tag: Filters (hooks)

More from category: Hooks (actions, filters)