remove_filter

Removes a function from a specified filter hook.

Description

remove_filter( (string) $tag, (callable) $function_to_remove, (int) $priority = 10 ); 

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

  1. if ( !function_exists( 'remove_filter' ) ) { 
  2.     require_once ABSPATH . WPINC . '/plugin.php'; 
  3. } 
  4.   
  5. // The filter hook to which the function to be removed is hooked. 
  6. $tag = ''; 
  7.   
  8. // The name of the function which should be removed. 
  9. $function_to_remove = null; 
  10.   
  11. // Optional. The priority of the function. Default 10. 
  12. $priority = 10; 
  13.   
  14. // NOTICE! Understand what this does before running. 
  15. $result = remove_filter($tag, $function_to_remove, $priority); 
  16.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/plugin.php  
  1. function remove_filter( $tag, $function_to_remove, $priority = 10 ) { 
  2.     global $wp_filter; 
  3.  
  4.     $r = false; 
  5.     if ( isset( $wp_filter[ $tag ] ) ) { 
  6.         $r = $wp_filter[ $tag ]->remove_filter( $tag, $function_to_remove, $priority ); 
  7.         if ( ! $wp_filter[ $tag ]->callbacks ) { 
  8.             unset( $wp_filter[ $tag ] ); 
  9.         } 
  10.     } 
  11.  
  12.     return $r; 
  13. }