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

Prepares a value for output based off a schema array.


$value mixed Required
Value to prepare.
$schema array Required
Schema to match.

Top ↑


mixed The prepared value.

Top ↑


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

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 ↑


Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes

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