bp_get_search_default_text

Filters the default text for the search box for a given component.

Description

apply_filters( 'bp_get_search_default_text', (string) $default_text, (string) $component ); 

Parameters (2)

0. $default_text (string)
Default text for search box.
1. $component (string)
Current component displayed.

Usage

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

Defined (1)

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

/bp-core/bp-core-template.php  
  1. return apply_filters( 'bp_get_search_default_text', $default_text, $component );