WP_REST_Request::get_parameter_order() WordPress Method
The WP_REST_Request::get_parameter_order() method is used to get the order of parameters for a request. This is useful for requests that have a lot of parameters, and you want to know the order in which they will be processed.
WP_REST_Request::get_parameter_order() #
Retrieves the parameter priority order.
Description
Used when checking parameters in WP_REST_Request::get_param().
Return
(string[]) Array of types to check, in order of priority.
Source
File: wp-includes/rest-api/class-wp-rest-request.php
protected function get_parameter_order() { $order = array(); if ( $this->is_json_content_type() ) { $order[] = 'JSON'; } $this->parse_json_params(); // Ensure we parse the body data. $body = $this->get_body(); if ( 'POST' !== $this->method && ! empty( $body ) ) { $this->parse_body_params(); } $accepts_body_data = array( 'POST', 'PUT', 'PATCH', 'DELETE' ); if ( in_array( $this->method, $accepts_body_data, true ) ) { $order[] = 'POST'; } $order[] = 'GET'; $order[] = 'URL'; $order[] = 'defaults'; /** * Filters the parameter priority order for a REST API request. * * The order affects which parameters are checked when using WP_REST_Request::get_param() * and family. This acts similarly to PHP's `request_order` setting. * * @since 4.4.0 * * @param string[] $order Array of types to check, in order of priority. * @param WP_REST_Request $request The request object. */ return apply_filters( 'rest_request_parameter_order', $order, $this ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
4.4.0 | Introduced. |