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

Description

Parameters

$valuemixed

$requestWP_REST_Request

$paramstring

Return

mixed

Uses · 3

• rest_validate_request_arg()Validate a request argument based on details registered to the route.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• rest_sanitize_request_arg()Sanitize a request argument based on details registered to the route.

Used by · 2

• WP_REST_Search_Controller::sanitize_subtypes()Sanitizes the list of subtypes, to ensure only subtypes of the passed type are included.
• WP_REST_Settings_Controller::sanitize_callback()Custom sanitize callback used for all options to allow the use of 'null'.

Source

View on Trac ↗View on GitHub ↗

1495function rest_parse_request_arg( $value, $request, $param ) {1496	$is_valid = rest_validate_request_arg( $value, $request, $param );1497 1498	if ( is_wp_error( $is_valid ) ) {1499		return $is_valid;1500	}1501 1502	$value = rest_sanitize_request_arg( $value, $request, $param );1503 1504	return $value;1505}

History

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.