bp_<id>_search_string

Filters the placeholder text for search inputs for component.

Description

apply_filters( 'bp_<id>_search_string', (string) $r_search_string ); 

Parameters (1)

0. $r_search_string (string)
Name to use in search input placeholders.

Usage

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

Defined (1)

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

/bp-core/classes/class-bp-component.php  
  1. $this->search_string = apply_filters( 'bp_' . $this->id . '_search_string', $r['search_string'] );