On this page
WP_REST_Request::get_param( string $key ): mixed|null
Retrieves a parameter from the request.
Parameters
$keystring Required-
Parameter name.
Return
mixed|null Value if set, null otherwise.
Source
File: wp-includes/rest-api/class-wp-rest-request.php. View all references
public function get_param( $key ) {
$order = $this->get_parameter_order();
foreach ( $order as $type ) {
// Determine if we have the parameter for this type.
if ( isset( $this->params[ $type ][ $key ] ) ) {
return $this->params[ $type ][ $key ];
}
}
return null;
}
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::has_valid_params() wp-includes/rest-api/class-wp-rest-request.php | Checks whether this request is valid according to its attributes. |
| WP_REST_Request::offsetGet() 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/get_param