On this page
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
$valuemixed Required-
Meta value to prepare.
$requestWP_REST_Request Required-
Current request object.
$argsarray Required-
Options for the field.
Return
mixed Prepared value.
Source
File: wp-includes/rest-api/fields/class-wp-rest-meta-fields.php. View all references
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;
}
Related
Used By
| Used By | Description |
|---|---|
| WP_REST_Meta_Fields::get_value() wp-includes/rest-api/fields/class-wp-rest-meta-fields.php | Retrieves the meta field value. |
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_meta_fields/prepare_value_for_response