wpseek.com
A WordPress-centric search engine for devs and theme authors



rest_parse_request_arg › WordPress Function

Since4.7.0
Deprecatedn/a
› rest_parse_request_arg ( $value, $request, $param )
Parameters: (3)
  • (mixed) $value
    Required: Yes
  • (WP_REST_Request) $request
    Required: Yes
  • (string) $param
    Required: Yes
Returns:
  • (mixed)
Defined at:
Codex:

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

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


Related Functions: rest_validate_request_arg, rest_sanitize_request_arg, rest_parse_embed_param, rest_ensure_request, rest_do_request

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