rest_(taxonomy)_query │ filter-hook │ WP 4.7.0

Filters get_terms() arguments when querying terms via the REST API.

The dynamic portion of the hook name, $this->taxonomy, refers to the taxonomy slug.

Possible hook names include:

• rest_category_query
• rest_post_tag_query

Enables adding extra arguments or setting defaults for a terms collection request.

Usage

add_filter( 'rest_(taxonomy)_query', 'wp_kama_rest_taxonomy_query_filter', 10, 2 );

/**
 * Function for `rest_(taxonomy)_query` filter-hook.
 * 
 * @param array           $prepared_args Array of arguments for get_terms().
 * @param WP_REST_Request $request       The REST API request.
 *
 * @return array
 */
function wp_kama_rest_taxonomy_query_filter( $prepared_args, $request ){

	// filter...
	return $prepared_args;
}

$prepared_args(array)

Array of arguments for get_terms().

$request(WP_REST_Request)

The REST API request.

Changelog

Where the hook is called

$prepared_args = apply_filters( "rest_{$this->taxonomy}_query", $prepared_args, $request );

Where the hook is used in WordPress