apply_filters( 'rest_envelope_response', array $envelope, WP_REST_Response $response )
- Since
- 4.4.0
Filters the enveloped form of a REST API response.
Parameters
$envelopearray- { Envelope data. @type array $body Response data. @type int $status The 3-digit HTTP status code. @type array $headers Map of header name to header value.}
$bodyarrayResponse data.$statusintThe 3-digit HTTP status code.$headersarrayMap of header name to header value.
$responseWP_REST_Response- Original response data.
Fired at · 1
wp-includes/rest-api/class-wp-rest-server.php:881WP_REST_Server::envelope_response()
Source
* @type array $body Response data. * @type int $status The 3-digit HTTP status code. * @type array $headers Map of header name to header value. * } * @param WP_REST_Response $response Original response data. */ $envelope = apply_filters( 'rest_envelope_response', $envelope, $response ); // Ensure it's still a response and return. return rest_ensure_response( $envelope ); } /**History
Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
- Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.