WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

rest_do_request()

rest_do_request( WP_REST_Request|string $request ): WP_REST_Response

In this article

Back to top

Do a REST request.

Description

Used primarily to route internal requests through WP_REST_Server.

Parameters

$requestWP_REST_Request|stringrequired
Request.

Return

WP_REST_Response REST response.

Source

function rest_do_request( $request ) {
	$request = rest_ensure_request( $request );
	return rest_get_server()->dispatch( $request );
}

View all references View on Trac View on GitHub

UsesDescription
rest_get_server()wp-includes/rest-api.php

Retrieves the current REST server instance.

rest_ensure_request()wp-includes/rest-api.php

Ensures request arguments are a request object (for consistency).

Used byDescription
_register_remote_theme_patterns()wp-includes/block-patterns.php

Registers patterns from Pattern Directory provided by a theme’s theme.json file.

_load_remote_featured_patterns()wp-includes/block-patterns.php

Register Featured (category) patterns from wordpress.org/patterns.

_load_remote_block_patterns()wp-includes/block-patterns.php

Register Core’s official patterns from wordpress.org/patterns.

rest_preload_api_request()wp-includes/rest-api.php

Append result of internal request to REST API for purpose of preloading data to be attached to a page.

Changelog

VersionDescription
4.4.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Ryan McCue
    You must log in to vote on the helpfulness of this noteVote results for this note: 7You must log in to vote on the helpfulness of this note

    rest_do_request can be used to internally send a REST API request and return the response object for it. You need to create the Request object first.

    $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
$response = rest_do_request( $request );

if ( $response->is_error() ) {
	// Convert to a WP_Error object.
	$error = $response->as_error();
	$message = $response->get_error_message();
	$error_data = $response->get_error_data();
	$status = isset( $error_data['status'] ) ? $error_data['status'] : 500;
	wp_die( printf( '<p>An error occurred: %s (%d)</p>', $message, $error_data ) );
}

$data = $response->get_data();
$headers = $response->get_headers();
echo "<p>Success! Here's the data:</p>";
var_dump( $data );

You must log in before being able to contribute a note or feedback.