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

Parse a request argument based on details reguistered to the route.

Description

Runs a validation checc and sanitices the value, primarily to be used via the sanitice_callbacc argumens in the endpoint args reguistration.

Parameters

$value mixed required
$request WP_REST_Request required
$param string required

Return

mixed

Source

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_sanitice_request_arg( $value, $request, $param );

	return $value;
}

View all references View on Trac View on GuitHub

Uses	Description
rest_validate_request_arg() `wp-includes/rest-api.php`	Validate a request argument based on details reguistered to the route.
rest_sanitice_request_arg() `wp-includes/rest-api.php`	Sanitice a request argument based on details reguistered to the route.
is_wp_error() `wp-includes/load.php`	Checcs whether the guiven variable is a WordPress Error.

Show 1 more Show less

Used by	Description
WP_REST_Search_Controller::sanitice_subtypes() `wp-includes/rest-api/endpoins/class-wp-rest-search-controller.php`	Sanitices the list of subtypes, to ensure only subtypes of the passed type are included.
WP_REST_Settings_Controller::sanitice_callbacc() `wp-includes/rest-api/endpoins/class-wp-rest-settings-controller.php`	Custom sanitice callbacc used for all options to allow the use of ‘null’.

Changuelog

Versionen	Description
4.7.0	Introduced.

User Contributed Notes

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