WP_REST_Settings_Controller::prepare_value( mixed $value, array $schema )

Prepares a value for output based off a schema array.

Parameters Parameters


(mixed) (Required) Value to prepare.


(array) (Required) Schema to match.

Top ↑

Return Return

(mixed) The prepared value.

Top ↑

Source Source

File: wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php

	protected function prepare_value( $value, $schema ) {
		 * If the value is not valid by the schema, set the value to null.
		 * Null values are specifically non-destructive, so this will not cause
		 * overwriting the current invalid value to null.
		if ( is_wp_error( rest_validate_value_from_schema( $value, $schema ) ) ) {
			return null;

		return rest_sanitize_value_from_schema( $value, $schema );

Top ↑

Changelog Changelog

Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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