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

Parameters

$valuemixed

$requestWP_REST_Request

$paramstring

Return

true|WP_Error

Uses · 1

• rest_validate_value_from_schema()Validate a value based on a schema.

Used by · 5

• WP_REST_Comments_Controller::check_comment_author_email()Checks a comment author email for validity.
• WP_REST_Menus_Controller::get_item_schema()Retrieves the term's schema, conforming to JSON Schema.
• WP_REST_Posts_Controller::sanitize_post_statuses()Sanitizes and validates the list of post statuses, including whether the user can query private statuses.
• WP_REST_Themes_Controller::sanitize_theme_status()Sanitizes and validates the list of theme status.
• rest_parse_request_arg()Parse a request argument based on details registered to the route.

Source

View on Trac ↗View on GitHub ↗

1416function rest_validate_request_arg( $value, $request, $param ) {1417	$attributes = $request->get_attributes();1418	if ( ! isset( $attributes['args'][ $param ] ) || ! is_array( $attributes['args'][ $param ] ) ) {1419		return true;1420	}1421	$args = $attributes['args'][ $param ];1422 1423	return rest_validate_value_from_schema( $value, $args, $param );1424}

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 6.7.7 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.