rest_sanitize_value_from_schema( mixed $value, array $args, string $param = '' ): mixed|WP_Error

Parameters

$valuemixed

The value to sanitize.

$argsarray

Schema array to use for sanitization.

$paramstringoptional

The parameter name, used in error messages.Default: ''

Return

mixed|WP_Error

The sanitized value or a WP_Error instance if the value cannot be safely sanitized.

Uses · 18

• rest_find_any_matching_schema()Finds the matching schema among the "anyOf" schemas.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• rest_sanitize_value_from_schema()Sanitize a value based on a schema.
• rest_find_one_matching_schema()Finds the matching schema among the "oneOf" schemas.
• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• rest_handle_multi_type_schema()Handles getting the best type for a multi-type schema.
• wp_sprintf()WordPress' implementation of PHP sprintf() with filters.
• rest_sanitize_array()Converts an array-like value to an array.
• rest_validate_array_contains_unique_items()Checks if an array is made up of unique items.
• rest_sanitize_object()Converts an object-like value to an array.
• rest_find_matching_pattern_property_schema()Finds the schema for a property using the patternProperties keyword.

Used by · 11

• WP_REST_Block_Renderer_Controller::register_routes()Registers the necessary REST API routes, one for each dynamic block.
• WP_REST_Block_Types_Controller::prepare_item_for_response()Prepares a block type object for serialization.
• WP_REST_Meta_Fields::prepare_value()Prepares a meta value for output.
• WP_REST_Meta_Fields::update_value()Updates meta values.
• WP_REST_Settings_Controller::prepare_value()Prepares a value for output based off a schema array.
• WP_REST_Themes_Controller::prepare_theme_support()Prepares the theme support value for inclusion in the REST API response.
• WP_REST_Widget_Types_Controller::prepare_item_for_response()Prepares a widget type object for serialization.
• WP_Widget_Media::update()Sanitizes the widget form values as they are saved.
• rest_sanitize_request_arg()Sanitize a request argument based on details registered to the route.
• rest_sanitize_value_from_schema()Sanitize a value based on a schema.
• rest_validate_enum()Validates that the given value is a member of the JSON Schema "enum".

Source

View on Trac ↗View on GitHub ↗

2756function rest_sanitize_value_from_schema( $value, $args, $param = '' ) {2757	if ( isset( $args['anyOf'] ) ) {2758		$matching_schema = rest_find_any_matching_schema( $value, $args, $param );2759		if ( is_wp_error( $matching_schema ) ) {2760			return $matching_schema;2761		}2762 2763		if ( ! isset( $args['type'] ) ) {2764			$args['type'] = $matching_schema['type'];2765		}2766 2767		$value = rest_sanitize_value_from_schema( $value, $matching_schema, $param );2768	}2769 2770	if ( isset( $args['oneOf'] ) ) {2771		$matching_schema = rest_find_one_matching_schema( $value, $args, $param );2772		if ( is_wp_error( $matching_schema ) ) {2773			return $matching_schema;2774		}2775 2776		if ( ! isset( $args['type'] ) ) {2777			$args['type'] = $matching_schema['type'];2778		}2779 2780		$value = rest_sanitize_value_from_schema( $value, $matching_schema, $param );2781	}2782 2783	$allowed_types = array( 'array', 'object', 'string', 'number', 'integer', 'boolean', 'null' );2784 2785	if ( ! isset( $args['type'] ) ) {2786		/* translators: %s: Parameter. */2787		_doing_it_wrong( __FUNCTION__, sprintf( __( 'The "type" schema keyword for %s is required.' ), $param ), '5.5.0' );2788	}2789 2790	if ( is_array( $args['type'] ) ) {2791		$best_type = rest_handle_multi_type_schema( $value, $args, $param );2792 2793		if ( ! $best_type ) {2794			return null;2795		}2796 2797		$args['type'] = $best_type;2798	}2799 2800	if ( ! in_array( $args['type'], $allowed_types, true ) ) {2801		_doing_it_wrong(2802			__FUNCTION__,2803			/* translators: 1: Parameter, 2: The list of allowed types. */2804			wp_sprintf( __( 'The "type" schema keyword for %1$s can only be one of the built-in types: %2$l.' ), $param, $allowed_types ),2805			'5.5.0'2806		);2807	}2808 2809	if ( 'array' === $args['type'] ) {2810		$value = rest_sanitize_array( $value );2811 2812		if ( ! empty( $args['items'] ) ) {2813			foreach ( $value as $index => $v ) {2814				$value[ $index ] = rest_sanitize_value_from_schema( $v, $args['items'], $param . '[' . $index . ']' );2815			}2816		}2817 2818		if ( ! empty( $args['uniqueItems'] ) && ! rest_validate_array_contains_unique_items( $value ) ) {2819			/* translators: %s: Parameter. */2820			return new WP_Error( 'rest_duplicate_items', sprintf( __( '%s has duplicate items.' ), $param ) );2821		}2822 2823		return $value;2824	}2825 2826	if ( 'object' === $args['type'] ) {2827		$value = rest_sanitize_object( $value );2828 2829		foreach ( $value as $property => $v ) {2830			if ( isset( $args['properties'][ $property ] ) ) {2831				$value[ $property ] = rest_sanitize_value_from_schema( $v, $args['properties'][ $property ], $param . '[' . $property . ']' );2832				continue;2833			}2834 2835			$pattern_property_schema = rest_find_matching_pattern_property_schema( $property, $args );

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.