钩子文档

rest_pre_echo_response

💡 云策文档标注

概述

rest_pre_echo_response 是一个 WordPress REST API 过滤器,用于在响应数据发送给客户端之前进行修改。它允许开发者在嵌入数据插入后、响应数据输出前调整响应内容。

关键要点

  • 过滤器名称:rest_pre_echo_response
  • 主要用途:修改 REST API 响应数据,适用于自定义响应格式或添加额外信息
  • 参数:$result(响应数据数组)、$server(WP_REST_Server 实例)、$request(WP_REST_Request 实例)
  • 调用位置:在 WP_REST_Server::serve_request() 方法中应用
  • 引入版本:WordPress 4.8.1

代码示例

$result = apply_filters( 'rest_pre_echo_response', $result, $this, $request );

📄 原文内容

Filters the REST API response.

Description

Allows modification of the response data after inserting embedded data (if any) and before echoing the response data.

Parameters

$resultarray
Response data to send to the client.
$serverWP_REST_Server
Server instance.
$requestWP_REST_Request
Request used to generate the response.

Source

$result = apply_filters( 'rest_pre_echo_response', $result, $this, $request );

Changelog

Version Description
4.8.1 Introduced.