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

In this article

Prepares a value for output based off a schema array.

Parameters

$valuemixedrequired
Value to prepare.
$schemaarrayrequired
Schema to match.

Return

mixed The prepared value.

Source

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

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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