WP_REST_Request::set_param() WordPress Method
The WP_REST_Request::set_param() method allows you to set a parameter for a request. This is useful if you need to set a parameter that is not directly available in the request URL.
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
- $key
(string)(Required)Parameter name.
- $value
(mixed)(Required)Parameter value.
Source
File: wp-includes/rest-api/class-wp-rest-request.php
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;
}
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |