wordpress / latest / functions / rest_validate_request_arg.html

rest_validate_request_arg( mixed $value, WP_REST_Request $request, string $param ): true|WP_Error

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

Parameters

$value mixed Required
$request WP_REST_Request Required
$param string Required

Return

true|WP_Error

Source

File: wp-includes/rest-api.php. View all references

function rest_validate_request_arg( $value, $request, $param ) {
	$attributes = $request->get_attributes();
	if ( ! isset( $attributes['args'][ $param ] ) || ! is_array( $attributes['args'][ $param ] ) ) {
		return true;
	}
	$args = $attributes['args'][ $param ];

	return rest_validate_value_from_schema( $value, $args, $param );
}

Used By

Used By Description

Changelog

Version Description
4.7.0 Introduced.

© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/rest_validate_request_arg