<tag>

Hooks a function on to a specific action.

Description

(boolean) remove_filter( '<tag>', (unknown) $function_to_remove, (unknown) $priority, (unknown) $accepted_args ); 

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

Returns (boolean)

Whether the function is removed.

Parameters (3)

0. $function_to_remove (unknown)
The function to remove.
1. $priority (unknown)
The priority.
2. $accepted_args (unknown)
The accepted args.

Usage

To run the hook, copy the example below.
  1. $function_to_remove = apply_filters( '{$tag}', $function_to_remove, $priority, $accepted_args ); 
  2.  
  3. if ( !empty( $function_to_remove ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the <tag> callback 
  2. function filter_tag( $function_to_remove, $priority, $accepted_args ) { 
  3. // make filter magic happen here... 
  4. return $function_to_remove
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( "{$tag}", 'filter_tag', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( "{$tag}", 'filter_tag', 10, 3 ); 

Defined (1)

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

/bp-forums/bbpress/bb-includes/backpress/functions.plugin-api.php  
  1. return remove_filter($tag, $function_to_remove, $priority, $accepted_args);