钩子文档

rest_prepare_attachment

💡 云策文档标注

概述

rest_prepare_attachment 是一个 WordPress REST API 过滤器,用于在附件数据返回前进行修改。它允许开发者在附件响应对象被发送前自定义其内容。

关键要点

  • 过滤器名称:rest_prepare_attachment
  • 用途:修改从 REST API 返回的附件数据
  • 参数:$response(WP_REST_Response 对象)、$post(WP_Post 对象)、$request(WP_REST_Request 对象)
  • 引入版本:WordPress 4.7.0
  • 相关函数:WP_REST_Attachments_Controller::prepare_item_for_response()

📄 原文内容

Filters an attachment returned from the REST API.

Description

Allows modification of the attachment right before it is returned.

Parameters

$responseWP_REST_Response
The response object.
$postWP_Post
The original attachment post.
$requestWP_REST_Request
Request used to generate the response.

Source

return apply_filters( 'rest_prepare_attachment', $response, $post, $request );

Changelog

Version Description
4.7.0 Introduced.