remove_filter
Removes a function from a specified filter hook.
Description
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.
Parameters (3)
- 0. $tag (string)
- The filter hook to which the function to be removed is hooked.
- 1. $function_to_remove (callable)
- The name of the function which should be removed.
- 2. $priority — Optional. (int) =>
10
- The priority of the function. Default
10
.
Usage
if ( !function_exists( 'remove_filter' ) ) { require_once ABSPATH . WPINC . '/plugin.php'; } // The filter hook to which the function to be removed is hooked. $tag = ''; // The name of the function which should be removed. $function_to_remove = null; // Optional. The priority of the function. Default 10. $priority = 10; // NOTICE! Understand what this does before running. $result = remove_filter($tag, $function_to_remove, $priority);
Defined (1)
The function is defined in the following location(s).
- /wp-includes/plugin.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;
- }