rest_prepare_taxonomy │ filter-hook │ WP 4.7.0

Filters a taxonomy returned from the REST API.

Allows modification of the taxonomy 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_Taxonomy      $item     The original taxonomy 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_Taxonomy)

The original taxonomy object.

$request(WP_REST_Request)

Request used to generate the response.

Changelog

Where the hook is called

return apply_filters( 'rest_prepare_taxonomy', $response, $taxonomy, $request );

return apply_filters( 'rest_prepare_taxonomy', new WP_REST_Response( array() ), $taxonomy, $request );

Where the hook is used in WordPress