钩子文档

rest_prepare_post_type

💡 云策文档标注

概述

rest_prepare_post_type 是一个 WordPress REST API 过滤器,用于在返回 post type 数据前进行修改。它允许开发者自定义序列化后的 post type 响应。

关键要点

  • 过滤器名称:rest_prepare_post_type
  • 用途:修改从 REST API 返回的 post type 数据
  • 参数:$response(WP_REST_Response 对象)、$post_type(WP_Post_Type 对象)、$request(WP_REST_Request 对象)
  • 引入版本:4.7.0
  • 相关函数:WP_REST_Post_Types_Controller::prepare_item_for_response()

📄 原文内容

Filters a post type returned from the REST API.

Description

Allows modification of the post type data right before it is returned.

Parameters

$responseWP_REST_Response
The response object.
$post_typeWP_Post_Type
The original post type object.
$requestWP_REST_Request
Request used to generate the response.

Source

return apply_filters( 'rest_prepare_post_type', $response, $post_type, $request );

Changelog

Version Description
4.7.0 Introduced.