WP_REST_Server::envelope_response() public WP 4.4.0
Wraps the response in an envelope.
The enveloping technique is used to work around browser/client compatibility issues. Essentially, it converts the full HTTP response to data instead.
{} It's a method of the class: WP_REST_Server{}
Hooks from the method
Return
WP_REST_Response. New response with wrapped data
Usage
$WP_REST_Server = new WP_REST_Server(); $WP_REST_Server->envelope_response( $response, $embed );
- $response(WP_REST_Response) (required)
- Response object.
- $embed(true/false) (required)
- Whether links should be embedded.
Changelog
Since 4.4.0 | Introduced. |
Code of WP_REST_Server::envelope_response() WP REST Server::envelope response WP 5.6
public function envelope_response( $response, $embed ) {
$envelope = array(
'body' => $this->response_to_data( $response, $embed ),
'status' => $response->get_status(),
'headers' => $response->get_headers(),
);
/**
* Filters the enveloped form of a response.
*
* @since 4.4.0
*
* @param array $envelope Envelope data.
* @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 );
}