W3cubDocs

/WordPress

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

Prepares a meta value for a response.

Description

This is required because some native types cannot be stored correctly in the database, such as booleans. We need to cast back to the relevant type before passing back to JSON.

Parameters

$valuemixedrequired
Meta value to prepare.
$requestWP_REST_Requestrequired
Current request object.
$argsarrayrequired
Options for the field.

Return

mixed Prepared value.

Source

protected function prepare_value_for_response( $value, $request, $args ) {
	if ( ! empty( $args['prepare_callback'] ) ) {
		$value = call_user_func( $args['prepare_callback'], $value, $request, $args );
	}

	return $value;
}

Changelog

Version Description
4.7.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_meta_fields/prepare_value_for_response