rest_sanitize_request_arg() WordPress Function
The rest_sanitize_request_arg() function is used to sanitize the value of a request argument before it is used to make a REST request. This function ensures that the value is a string and that it does not contain any invalid characters.
rest_sanitize_request_arg( mixed $value, WP_REST_Request $request, string $param ) #
Sanitize a request argument based on details registered to the route.
Parameters
- $value
(mixed)(Required)
- $request
(WP_REST_Request)(Required)
- $param
(string)(Required)
Return
(mixed)
Source
File: wp-includes/rest-api.php
function rest_sanitize_request_arg( $value, $request, $param ) { $attributes = $request->get_attributes(); if ( ! isset( $attributes['args'][ $param ] ) || ! is_array( $attributes['args'][ $param ] ) ) { return $value; } $args = $attributes['args'][ $param ]; return rest_sanitize_value_from_schema( $value, $args, $param ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |