On this page
WP_REST_Request::set_param( string $key, mixed $value )
Sets a parameter on the request.
Description
If the given parameter key exists in any parameter type an update will take place, otherwise a new param will be created in the first parameter type (respecting get_parameter_order()).
Parameters
$keystring Required-
Parameter name.
$valuemixed Required-
Parameter value.
Source
File: wp-includes/rest-api/class-wp-rest-request.php. View all references
public function set_param( $key, $value ) {
$order = $this->get_parameter_order();
$found_key = false;
foreach ( $order as $type ) {
if ( 'defaults' !== $type && is_array( $this->params[ $type ] ) && array_key_exists( $key, $this->params[ $type ] ) ) {
$this->params[ $type ][ $key ] = $value;
$found_key = true;
}
}
if ( ! $found_key ) {
$this->params[ $order[0] ][ $key ] = $value;
}
}
Related
Uses
| Uses | Description |
|---|---|
| WP_REST_Request::get_parameter_order() wp-includes/rest-api/class-wp-rest-request.php | Retrieves the parameter priority order. |
Used By
| Used By | Description |
|---|---|
| WP_REST_Request::offsetSet() wp-includes/rest-api/class-wp-rest-request.php |
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_request/set_param