bbp_search_id

The bbPress bbp search id hook.

Description

apply_filters( 'bbp_search_id', (string) $bbp_search ); 

Parameters (1)

0. $bbp_search (string) => 'bbp_search'
The bbp search.

Usage

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

Defined (1)

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

/bbpress.php  
  1. $this->search_id = apply_filters( 'bbp_search_id', 'bbp_search' );