钩子文档

rest_prepare_{$this->taxonomy}

💡 云策文档标注

概述

rest_prepare_{$this->taxonomy} 是一个 WordPress REST API 过滤器钩子,用于在返回分类法术语数据前修改响应对象。它允许开发者自定义术语数据,适用于特定分类法如 category 或 post_tag。

关键要点

  • 这是一个动态钩子,名称中的 $this->taxonomy 指代分类法 slug,例如 rest_prepare_category 或 rest_prepare_post_tag。
  • 钩子允许修改 WP_REST_Response 对象,基于原始 WP_Term 对象和 WP_REST_Request 请求。
  • 主要用于 WP_REST_Terms_Controller 和 WP_REST_Menus_Controller 中的 prepare_item_for_response 方法。
  • 自 WordPress 4.7.0 版本引入。

代码示例

return apply_filters( "rest_prepare_{$this->taxonomy}", $response, $item, $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

$responseWP_REST_Response
The response object.
$itemWP_Term
The original term object.
$requestWP_REST_Request
Request used to generate the response.

Source

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

Changelog

Version Description
4.7.0 Introduced.