钩子文档

rest_prepare_status

💡 云策文档标注

概述

rest_prepare_status 是一个 WordPress REST API 过滤器,用于在返回文章状态数据前进行修改。它允许开发者自定义状态响应,适用于处理状态对象的序列化过程。

关键要点

  • 过滤器名称:rest_prepare_status
  • 作用:过滤从 REST API 返回的文章状态数据
  • 参数:$response(WP_REST_Response 对象)、$status(原始文章状态对象)、$request(WP_REST_Request 对象)
  • 引入版本:WordPress 4.7.0
  • 相关函数:WP_REST_Post_Statuses_Controller::prepare_item_for_response()

📄 原文内容

Filters a post status returned from the REST API.

Description

Allows modification of the status data right before it is returned.

Parameters

$responseWP_REST_Response
The response object.
$statusobject
The original post status object.
$requestWP_REST_Request
Request used to generate the response.

Source

return apply_filters( 'rest_prepare_status', $response, $status, $request );

Changelog

Version Description
4.7.0 Introduced.