the_search_query

Filters the contents of the search query variable for display.

Description

apply_filters( 'the_search_query', (bool) $get_search_query ); 

Parameters (1)

0. $get_search_query (bool) => get_search_query( false )
Contents of the search query variable.

Usage

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

Defined (1)

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

/wp-includes/general-template.php  
  1. echo esc_attr( apply_filters( 'the_search_query', get_search_query( false ) ) );