云策 WordPress 开发者社区

钩子文档

rest_envelope_response

查看官方原文 ↗
💡 云策文档标注

概述

rest_envelope_response 是一个 WordPress REST API 过滤器，用于修改 REST API 响应的信封形式。它允许开发者在响应被封装时自定义信封数据。

关键要点

  • 过滤器名称：rest_envelope_response
  • 参数：$envelope（信封数据数组）、$response（原始 WP_REST_Response 对象）
  • 用途：在 WP_REST_Server::envelope_response() 方法中调用，用于包装响应
  • 引入版本：WordPress 4.4.0
📄 原文内容

Filters the enveloped form of a REST API response.

Parameters

$envelopearray
Envelope data.

  • body array
    Response data.
  • status int
    The 3-digit HTTP status code.
  • headers array
    Map of header name to header value.

$responseWP_REST_Response
Original response data.

Source

$envelope = apply_filters( 'rest_envelope_response', $envelope, $response );

View all references View on Trac View on GitHub

Used by Description
WP_REST_Server::envelope_response()wp-includes/rest-api/class-wp-rest-server.php

Wraps the response in an envelope.

Changelog

Version Description
4.4.0 Introduced.