rest_prepare_widget_type
云策文档标注
概述
rest_prepare_widget_type 是一个 WordPress 过滤器钩子,用于在 REST API 中过滤小部件类型(widget type)的响应数据。它允许开发者在序列化小部件类型对象前修改响应内容。
关键要点
- 这是一个过滤器钩子,用于处理 REST API 中小部件类型的响应。
- 接收三个参数:$response(WP_REST_Response 对象)、$widget_type(小部件数据数组)和 $request(WP_REST_Request 对象)。
- 在 WP_REST_Widget_Types_Controller::prepare_item_for_response() 方法中被调用,用于序列化小部件类型对象。
- 从 WordPress 5.8.0 版本开始引入。
原文内容
Filters the REST API response for a widget type.
Parameters
$responseWP_REST_Response-
The response object.
$widget_typearray-
The array of widget data.
$requestWP_REST_Request-
The request object.
Source
return apply_filters( 'rest_prepare_widget_type', $response, $widget_type, $request );
Changelog
| Version | Description |
|---|---|
| 5.8.0 | Introduced. |