search_rewrite_rules

Filters rewrite rules used for search archives.

Description

apply_filters( 'search_rewrite_rules', (array) $search_rewrite ); 

Likely search-related archives include /search/search+query/ as well as pagination and feed paths for a search.

Parameters (1)

0. $search_rewrite (array)
The rewrite rules for search queries.

Usage

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

Defined (1)

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

/wp-includes/class-wp-rewrite.php  
  1. $search_rewrite = apply_filters( 'search_rewrite_rules', $search_rewrite );