search_rewrite_rules
Filters rewrite rules used for search archives.
Description
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.
- $search_rewrite = apply_filters( 'search_rewrite_rules', $search_rewrite );
- if ( !empty( $search_rewrite ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the search_rewrite_rules callback
- function filter_search_rewrite_rules( $search_rewrite ) {
- // make filter magic happen here...
- return $search_rewrite;
- };
- // add the filter
- add_filter( 'search_rewrite_rules', 'filter_search_rewrite_rules', 10, 1 );
- To remove a hook callback, use the example below.
- // remove the filter
- 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
- $search_rewrite = apply_filters( 'search_rewrite_rules', $search_rewrite );