WP_REST_Request

Description

Hooks fired · 2

Every hook that fires from inside WP_REST_Request, in the order it appears in the class, grouped by the method that fires it.

Properties · 8

$methodstringprotected

HTTP method.

$paramsarrayprotected

Parameters passed to the request.

$headersarrayprotected

HTTP headers for the request.

$bodystringprotected

Body data.

$routestringprotected

Route matched for the request.

$attributesarrayprotected

Attributes (options) for the route that was matched.

$parsed_jsonboolprotected

Used to determine if the JSON data has been parsed yet.

$parsed_bodyboolprotected

Used to determine if the body data has been parsed yet.

Methods · 45

• __construct()Constructor.
• get_method()Retrieves the HTTP method for the request.
• set_method()Sets HTTP method for the request.
• get_headers()Retrieves all headers from the request.
• is_method()Determines if the request is the given method.
• canonicalize_header_name()Canonicalizes the header name.
• get_header()Retrieves the given header from the request.
• get_header_as_array()Retrieves header values from the request.
• set_header()Sets the header on request.
• add_header()Appends a header value for the given header.
• remove_header()Removes all values for a header.
• set_headers()Sets headers on the request.
• get_content_type()Retrieves the Content-Type of the request.
• is_json_content_type()Checks if the request has specified a JSON Content-Type.
• get_parameter_order()Retrieves the parameter priority order.
• get_param()Retrieves a parameter from the request.
• has_param()Checks if a parameter exists in the request.
• set_param()Sets a parameter on the request.
• get_params()Retrieves merged parameters from the request.
• get_url_params()Retrieves parameters from the route itself.
• set_url_params()Sets parameters from the route.
• get_query_params()Retrieves parameters from the query string.
• set_query_params()Sets parameters from the query string.
• get_body_params()Retrieves parameters from the body.
• set_body_params()Sets parameters from the body.
• get_file_params()Retrieves multipart file parameters from the body.
• set_file_params()Sets multipart file parameters from the body.
• get_default_params()Retrieves the default parameters.
• set_default_params()Sets default parameters.
• get_body()Retrieves the request body content.
• set_body()Sets body content.
• get_json_params()Retrieves the parameters from a JSON-formatted body.
• parse_json_params()Parses the JSON parameters.
• parse_body_params()Parses the request body parameters.
• get_route()Retrieves the route that matched the request.
• set_route()Sets the route that matched the request.
• get_attributes()Retrieves the attributes for the request.
• set_attributes()Sets the attributes for the request.
• sanitize_params()Sanitizes (where possible) the params on the request.
• has_valid_params()Checks whether this request is valid according to its attributes.
• offsetExists()Checks if a parameter is set.
• offsetGet()Retrieves a parameter from the request.
• offsetSet()Sets a parameter on the request.
• offsetUnset()Removes a parameter from the request.
• from_url()Retrieves a WP_REST_Request object from a full URL.

Source

View on Trac ↗View on GitHub ↗

29#[AllowDynamicProperties]30class WP_REST_Request implements ArrayAccess {31 32	/**33	 * HTTP method.34	 *35	 * @since 4.4.036	 * @var string37	 */38	protected $method = '';39 40	/**41	 * Parameters passed to the request.42	 *43	 * These typically come from the `$_GET`, `$_POST` and `$_FILES`44	 * superglobals when being created from the global scope.45	 *46	 * @since 4.4.047	 * @var array Contains GET, POST and FILES keys mapping to arrays of data.48	 */49	protected $params;50 51	/**52	 * HTTP headers for the request.53	 *54	 * @since 4.4.055	 * @var array Map of key to value. Key is always lowercase, as per HTTP specification.56	 */57	protected $headers = array();58 59	/**60	 * Body data.61	 *62	 * @since 4.4.063	 * @var string Binary data from the request.64	 */65	protected $body = null;66 67	/**68	 * Route matched for the request.69	 *70	 * @since 4.4.071	 * @var string72	 */73	protected $route;74 75	/**76	 * Attributes (options) for the route that was matched.77	 *78	 * This is the options array used when the route was registered, typically79	 * containing the callback as well as the valid methods for the route.80	 *81	 * @since 4.4.082	 * @var array Attributes for the request.83	 */84	protected $attributes = array();85 86	/**87	 * Used to determine if the JSON data has been parsed yet.88	 *89	 * Allows lazy-parsing of JSON data where possible.90	 *91	 * @since 4.4.092	 * @var bool93	 */94	protected $parsed_json = false;95 96	/**97	 * Used to determine if the body data has been parsed yet.98	 *99	 * @since 4.4.0100	 * @var bool101	 */102	protected $parsed_body = false;103 104	/**105	 * Constructor.106	 *107	 * @since 4.4.0108	 *

History

Introduced in 4.4.0. One change between 6.7.7 and 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 6.8.8 tag, from src/wp-includes/rest-api/class-wp-rest-request.php, 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.