<filter_name>

The BuddyPress Global Search filter name hook.

Description

apply_filters( '<filter_name>', (unknown) $option ); 

Parameters (1)

0. $option (unknown)
The option.

Usage

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

Defined (1)

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

/includes/main-class.php  
  1. $option = apply_filters($filter_name, $option);