apply_filters( 'rest_envelope_response', array $envelope, WP_REST_Response $response )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

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.
}

• $bodyarray

  Response data.

• $statusint

  The 3-digit HTTP status code.

• $headersarray

  Map of header name to header value.

$responseWP_REST_Response

Original response data.

Where this hook fires · 1

• wp-includes/rest-api/class-wp-rest-server.php:882WP_REST_Server::envelope_response()

Source code

View on Trac ↗View on GitHub ↗

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	}887 888	/**

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.1.0 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.