rest_prepare_{$this->taxonomy} WordPress Filter Hook
The rest_prepare_{$this->taxonomy} hook is called when a request is made to the WordPress REST API for a collection of terms in a given taxonomy. This hook allows you to modify the response before it is sent back to the client.
apply_filters( "rest_prepare_{$this->taxonomy}", WP_REST_Response $response , WP_Term $item , WP_REST_Request $request ) #
Filters the term data for a REST API response.
Description
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.
Parameters
- $response
(WP_REST_Response)The response object.
- $item
(WP_Term)The original term object.
- $request
(WP_REST_Request)Request used to generate the response.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php
Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |