rest_sanitize_request_arg() – Function

rest_sanitize_request_arg( mixed $value, WP_REST_Request $request, string $param ): mixed

Sanitize a request argument based on details registered to the route.

Parameters

$valuemixedrequired
$requestWP_REST_Requestrequired
$paramstringrequired

Return

mixed

Source

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 );
}

View all references View on Trac View on GitHub

Uses	Description
rest_sanitize_value_from_schema()`wp-includes/rest-api.php`	Sanitize a value based on a schema.

Used by	Description
WP_REST_Menus_Controller::get_item_schema()`wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php`	Retrieves the term’s schema, conforming to JSON Schema.
rest_parse_request_arg()`wp-includes/rest-api.php`	Parse a request argument based on details registered to the route.

Changelog

Version	Description
4.7.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.