rest_parse_request_arg() WordPress Function
The rest_parse_request_arg() function is used to parse a JSON request body into an array. This function is used by the WordPress REST API to parse JSON request bodies.
rest_parse_request_arg( mixed $value, WP_REST_Request $request, string $param ) #
Parse a request argument based on details registered to the route.
Description
Runs a validation check and sanitizes the value, primarily to be used via the sanitize_callback arguments in the endpoint args registration.
Parameters
- $value
(mixed)(Required)
- $request
(WP_REST_Request)(Required)
- $param
(string)(Required)
Return
(mixed)
Source
File: wp-includes/rest-api.php
function rest_parse_request_arg( $value, $request, $param ) {
$is_valid = rest_validate_request_arg( $value, $request, $param );
if ( is_wp_error( $is_valid ) ) {
return $is_valid;
}
$value = rest_sanitize_request_arg( $value, $request, $param );
return $value;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |