WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

rest_envelope_response

apply_filters( ‘rest_envelope_response’, array $envelope, WP_REST_Response $response )

In this article

Back to top

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 byDescription
WP_REST_Server::envelope_response()wp-includes/rest-api/class-wp-rest-server.php

Wraps the response in an envelope.

Changelog

VersionDescription
4.4.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.