WP_REST_Server::envelope_response( WP_REST_Response $response, bool $embed )

Wraps the response in an envelope.


Description

The enveloping technique is used to work around browser/client compatibility issues. Essentially, it converts the full HTTP response to data instead.


Parameters

$response

(Required) Response object.

$embed

(Required) Whether links should be embedded.


Return

(WP_REST_Response) New response with wrapped data


Source

File: wp-includes/rest-api/class-wp-rest-server.php

	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 WP-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 );
	}


Changelog

Changelog
Version Description
WP-4.4.0 Introduced.