WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Meta_Fields::prepare_value()

WP_REST_Meta_Fields::prepare_value( mixed $value, WP_REST_Request $request, array $args ): mixed

In this article

Back to top

Prepares a meta value for output.

Description

Default preparation for meta fields. Override by passing the prepare_callback in your show_in_rest options.

Parameters

$valuemixedrequired
Meta value from the database.
$requestWP_REST_Requestrequired
Request object.
$argsarrayrequired
REST-specific options for the meta key.

Return

mixed Value prepared for output. If a non-JsonSerializable object, null.

Source

public static function prepare_value( $value, $request, $args ) {
	if ( $args['single'] ) {
		$schema = $args['schema'];
	} else {
		$schema = $args['schema']['items'];
	}

	if ( '' === $value && in_array( $schema['type'], array( 'boolean', 'integer', 'number' ), true ) ) {
		$value = static::get_empty_value_for_type( $schema['type'] );
	}

	if ( is_wp_error( rest_validate_value_from_schema( $value, $schema ) ) ) {
		return null;
	}

	return rest_sanitize_value_from_schema( $value, $schema );
}

View all references View on Trac View on GitHub

UsesDescription
rest_sanitize_value_from_schema()wp-includes/rest-api.php

Sanitize a value based on a schema.

rest_validate_value_from_schema()wp-includes/rest-api.php

Validate a value based on a schema.

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

Show 1 moreShow less

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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