WP_REST_Meta_Fields::prepare_value_for_response() WordPress Method
The WP_REST_Meta_Fields::prepare_value_for_response() method is used to prepare a value for output in a JSON response. This is typically used to format a value for display, or to convert a value from one type to another.
WP_REST_Meta_Fields::prepare_value_for_response( mixed $value, WP_REST_Request $request, array $args ) #
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
- $value
(mixed)(Required)Meta value to prepare.
- $request
(WP_REST_Request)(Required)Current request object.
- $args
(array)(Required)Options for the field.
Return
(mixed) Prepared value.
Source
File: wp-includes/rest-api/fields/class-wp-rest-meta-fields.php
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;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |