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

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


Description Description

Runs a validation check and sanitizes the value, primarily to be used via the sanitize_callback arguments in the endpoint args registration.


Top ↑

Parameters Parameters

$value

(mixed) (Required)

$request

(WP_REST_Request) (Required)

$param

(string) (Required)


Top ↑

Return Return

(mixed)


Top ↑

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


Top ↑

Changelog Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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