rest_prepare_(taxonomy) │ filter-hook │ WP 4.7.0

Filters the term data for a REST API response.

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

Possible hook names include:

• rest_prepare_category
• rest_prepare_post_tag

Allows modification of the term data right before it is returned.

Usage

add_filter( 'rest_prepare_(taxonomy)', 'wp_kama_rest_prepare_taxonomy_filter', 10, 3 );

/**
 * Function for `rest_prepare_(taxonomy)` filter-hook.
 * 
 * @param WP_REST_Response $response The response object.
 * @param WP_Term          $item     The original term object.
 * @param WP_REST_Request  $request  Request used to generate the response.
 *
 * @return WP_REST_Response
 */
function wp_kama_rest_prepare_taxonomy_filter( $response, $item, $request ){

	// filter...
	return $response;
}

$response(WP_REST_Response)

The response object.

$item(WP_Term)

The original term object.

$request(WP_REST_Request)

Request used to generate the response.

Changelog

Where the hook is called

return apply_filters( "rest_prepare_{$this->taxonomy}", $response, $item, $request );

return apply_filters( "rest_prepare_{$this->taxonomy}", $response, $term, $request );

Where the hook is used in WordPress

add_filter( 'rest_prepare_wp_navigation', 'block_core_navigation_insert_hooked_blocks_into_rest_response', 10, 3 );