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.


Top ↑

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.


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
4.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.