WP_REST_Request::get_param() WordPress Method
The WP_REST_Request::get_param() method is used to retrieve a value for a given parameter from a WordPress REST request. This is useful for retrieving data that is passed in through the request URL or JSON payload.
WP_REST_Request::get_param( string $key ) #
Retrieves a parameter from the request.
Parameters
- $key
(string)(Required)Parameter name.
Return
(mixed|null) Value if set, null otherwise.
Source
File: wp-includes/rest-api/class-wp-rest-request.php
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;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |