rest_prepare_widget
云策文档标注
概述
rest_prepare_widget 是一个 WordPress 过滤器，用于在 REST API 中处理小部件响应数据。它允许开发者在返回小部件数据前修改响应对象。
关键要点
- 这是一个过滤器钩子，用于过滤 REST API 中单个小部件的响应数据。
- 参数包括 $response（WP_REST_Response 或 WP_Error 对象）、$widget（注册的小部件数据数组）和 $request（WP_REST_Request 对象）。
- 在 WP_REST_Widgets_Controller::prepare_item_for_response() 方法中被调用，用于准备小部件的 REST 响应。
- 从 WordPress 5.8.0 版本开始引入。
原文内容
Filters the REST API response for a widget.
Parameters
$responseWP_REST_Response|WP_Error-
The response object, or WP_Error object on failure.
$widgetarray-
The registered widget data.
$requestWP_REST_Request-
Request used to generate the response.
Source
return apply_filters( 'rest_prepare_widget', $response, $widget, $request );
Changelog
| Version | Description |
|---|---|
| 5.8.0 | Introduced. |