WP_REST_Server::envelope_response( WP_REST_Response $response, bool|string[] $embed ): WP_REST_Response

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$responseWP_REST_Response

Response object.

$embedbool|string[]

Whether to embed all links, a filtered list of link relations, or no links.

Return value

WP_REST_Response

New response with wrapped data

Performance profile

How much work a call to WP_REST_Server::envelope_response() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

24

Executed per call on PHP 8.5. The body compiles to 24.

Plugin surface

1 hook

Third-party callbacks on 'rest_envelope_response' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Server::envelope_response() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while WP_REST_Server::envelope_response() runs, in this order:

1. 1
   apply_filters( rest_envelope_response )filterline 882 (+21 into the body)

   Filters the enveloped form of a REST API response.

Uses · 3

• apply_filters()Calls the callback functions that have been added to a filter hook.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_REST_Server::response_to_data()Converts a response to data to send.

Used by · 2

• WP_REST_Server::serve_batch_request_v1()Serves the batch/v1 request.
• WP_REST_Server::serve_request()Handles serving a REST API request.

Source code

View on Trac ↗View on GitHub ↗

861	public function envelope_response( $response, $embed ) {862		$envelope = array(863			'body'    => $this->response_to_data( $response, $embed ),864			'status'  => $response->get_status(),865			'headers' => $response->get_headers(),866		);867 868		/**869		 * Filters the enveloped form of a REST API response.870		 *871		 * @since 4.4.0872		 *873		 * @param array            $envelope {874		 *     Envelope data.875		 *876		 *     @type array $body    Response data.877		 *     @type int   $status  The 3-digit HTTP status code.878		 *     @type array $headers Map of header name to header value.879		 * }880		 * @param WP_REST_Response $response Original response data.881		 */882		$envelope = apply_filters( 'rest_envelope_response', $envelope, $response );883 884		// Ensure it's still a response and return.885		return rest_ensure_response( $envelope );886	}

Changelog

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/rest-api/class-wp-rest-server.php, 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.