rest_prepare_{$this->post_type}
云策文档标注
概述
rest_prepare_{$this->post_type} 是一个动态过滤器钩子，用于在 WordPress REST API 响应中修改文章数据。它允许开发者在返回数据前自定义处理。
关键要点
- 钩子名称是动态的，基于 post_type 属性，例如 rest_prepare_post、rest_prepare_page。
- 参数包括 WP_REST_Response $response、WP_Post $post 和 WP_REST_Request $request。
- 在 WP_REST_Posts_Controller::prepare_item_for_response() 方法中使用，用于准备单个文章的输出。
- 自 WordPress 4.7.0 版本引入。
原文内容
Filters the post data for a REST API response.
Description
The dynamic portion of the hook name, $this->post_type, refers to the post type slug.
Possible hook names include:
rest_prepare_postrest_prepare_pagerest_prepare_attachment
Parameters
$responseWP_REST_Response-
The response object.
$postWP_Post-
Post object.
$requestWP_REST_Request-
Request object.
Source
return apply_filters( "rest_prepare_{$this->post_type}", $response, $post, $request );
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |