bbp_get_search_terms

The bbPress bbp get search terms hook.

Description

apply_filters( 'bbp_get_search_terms', (unknown) $search_terms, (unknown) $passed_terms ); 

Parameters (2)

0. $search_terms (unknown)
The search terms.
1. $passed_terms (unknown)
The passed terms.

Usage

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

Defined (1)

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

/includes/search/template.php  
  1. return apply_filters( 'bbp_get_search_terms', $search_terms, $passed_terms );