WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

rest_parse_request_arg()

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

In this article

Back to top

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

Description

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

Parameters

$valuemixedrequired
$requestWP_REST_Requestrequired
$paramstringrequired

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

	return $value;
}

View all references View on Trac View on GitHub

UsesDescription
rest_validate_request_arg()wp-includes/rest-api.php

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

rest_sanitize_request_arg()wp-includes/rest-api.php

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

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

Show 1 moreShow less
Used byDescription
WP_REST_Search_Controller::sanitize_subtypes()wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php

Sanitizes the list of subtypes, to ensure only subtypes of the passed type are included.

WP_REST_Settings_Controller::sanitize_callback()wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php

Custom sanitize callback used for all options to allow the use of ‘null’.

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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