WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Request::__construct()

WP_REST_Request::__construct( string $method = ”, string $route = ”, array $attributes = array() )

In this article

Back to top

Constructor.

Parameters

$methodstringoptional
Request method.

Default:''

$routestringoptional
Request route.

Default:''

$attributesarrayoptional
Request attributes.

Default:array()

Source

public function __construct( $method = '', $route = '', $attributes = array() ) {
	$this->params = array(
		'URL'      => array(),
		'GET'      => array(),
		'POST'     => array(),
		'FILES'    => array(),

		// See parse_json_params.
		'JSON'     => null,

		'defaults' => array(),
	);

	$this->set_method( $method );
	$this->set_route( $route );
	$this->set_attributes( $attributes );
}

View all references View on Trac View on GitHub

UsesDescription
WP_REST_Request::set_attributes()wp-includes/rest-api/class-wp-rest-request.php

Sets the attributes for the request.

WP_REST_Request::set_route()wp-includes/rest-api/class-wp-rest-request.php

Sets the route that matched the request.

WP_REST_Request::set_method()wp-includes/rest-api/class-wp-rest-request.php

Sets HTTP method for the request.

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.

WP_REST_Server::serve_batch_request_v1()wp-includes/rest-api/class-wp-rest-server.php

Serves the batch/v1 request.

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.

WP_REST_Request::from_url()wp-includes/rest-api/class-wp-rest-request.php

Retrieves a WP_REST_Request object from a full URL.

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

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

WP_REST_Server::serve_request()wp-includes/rest-api/class-wp-rest-server.php

Handles serving a REST API request.

Show 3 moreShow less

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: -1You must log in to vote on the helpfulness of this note

    Request objects can also be constructed from a URL by using WP_REST_Request::from_url:

    // If your site is at http://example.com/:
$request = WP_REST_Request::from_url( 'http://example.com/wp-json/wp/v2/posts' );
// GET by default; to change the method, you can then run:
$request->set_method( 'POST' );

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