rest_term_search_query filter-hookWP 5.6.0

Filters the query arguments for a REST API term search request.

Enables adding extra arguments or setting defaults for a term search request.

Usage

add_filter( 'rest_term_search_query', 'wp_kama_rest_term_search_query_filter', 10, 2 );

/**
 * Function for `rest_term_search_query` filter-hook.
 * 
 * @param array           $query_args Key value array of query var to query value.
 * @param WP_REST_Request $request    The request used.
 *
 * @return array
 */
function wp_kama_rest_term_search_query_filter( $query_args, $request ){

	// filter...
	return $query_args;
}
$query_args(array)
Key value array of query var to query value.
$request(WP_REST_Request)
The request used.

Changelog

Since 5.6.0 Introduced.

Where the hook is called

WP_REST_Term_Search_Handler::search_items()
rest_term_search_query
wp-includes/rest-api/search/class-wp-rest-term-search-handler.php 91
$query_args = apply_filters( 'rest_term_search_query', $query_args, $request );

Where the hook is used in WordPress

Usage not found.