rest_ensure_request() – Function | Developer.WordPress.org

rest_ensure_request( array|string|WP_REST_Request $request ): WP_REST_Request

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

Parameters

$requestarray|string|WP_REST_Requestrequired: Request to check.

Return

WP_REST_Request REST request instance.

Source

function rest_ensure_request( $request ) {
	if ( $request instanceof WP_REST_Request ) {
		return $request;
	}

	if ( is_string( $request ) ) {
		return new WP_REST_Request( 'GET', $request );
	}

	return new WP_REST_Request( 'GET', '', $request );
}

View all references View on Trac View on GitHub

Uses	Description
WP_REST_Request::__construct()`wp-includes/rest-api/class-wp-rest-request.php`	Constructor.

Used by	Description
rest_do_request()`wp-includes/rest-api.php`	Do a REST request.

Changelog

Version	Description
5.3.0	Accept string argument for the request path.
4.4.0	Introduced.

User Contributed Notes

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