wppaste
WordPress

apply_filters( 'rest_post_dispatch', WP_HTTP_Response $result, WP_REST_Server $server, WP_REST_Request $request )

Since
4.4.0, 4.5.0
Filters the REST API response.

Description

Allows modification of the response before returning.

Parameters

$resultWP_HTTP_Response
Result to send to the client. Usually a WP_REST_Response.
$serverWP_REST_Server
Server instance.
$requestWP_REST_Request
Request used to generate the response.

Fired at · 4

  • wp-includes/rest-api.php:2998rest_preload_api_request()
  • wp-includes/rest-api/class-wp-rest-server.php:464WP_REST_Server::serve_request()
  • wp-includes/rest-api/class-wp-rest-server.php:824WP_REST_Server::embed_links()
  • wp-includes/rest-api/class-wp-rest-server.php:1868WP_REST_Server::serve_batch_request_v1()

Source

		 * @since 4.5.0 Applied to embedded responses.		 *		 * @param WP_HTTP_Response $result  Result to send to the client. Usually a `WP_REST_Response`.		 * @param WP_REST_Server   $server  Server instance.		 * @param WP_REST_Request  $request Request used to generate the response.		 */		$result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $result ), $this, $request ); 		// Wrap the response in an envelope if asked for.		if ( isset( $_GET['_envelope'] ) ) {			$embed  = isset( $_GET['_embed'] ) ? rest_parse_embed_param( $_GET['_embed'] ) : false;			$result = $this->envelope_response( $result, $embed );		}

History

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.

4.5.0
Applied to embedded responses.from the docblock
4.4.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 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.