_wp_json_prepare_data

Prepares response data to be serialized to JSON.

Description

(bool|int|float|null|string|array) _wp_json_prepare_data( (mixed) $data ); 

This supports the JsonSerializable interface for PHP 5.2-5.3 as well.

Returns (bool|int|float|null|string|array)

Data ready for `json_encode()`.

Parameters (1)

0. $data (mixed)
Native representation.

Usage

  1. if ( !function_exists( '_wp_json_prepare_data' ) ) { 
  2.     require_once ABSPATH . WPINC . '/functions.php'; 
  3. } 
  4.   
  5. // Native representation. 
  6. $data = null; 
  7.   
  8. // NOTICE! Understand what this does before running. 
  9. $result = _wp_json_prepare_data($data); 
  10.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/functions.php  
  1. function _wp_json_prepare_data( $data ) { 
  2.     if ( ! defined( 'WP_JSON_SERIALIZE_COMPATIBLE' ) || WP_JSON_SERIALIZE_COMPATIBLE === false ) { 
  3.         return $data; 
  4.     } 
  5.  
  6.     switch ( gettype( $data ) ) { 
  7.         case 'boolean': 
  8.         case 'integer': 
  9.         case 'double': 
  10.         case 'string': 
  11.         case 'NULL': 
  12.             // These values can be passed through. 
  13.             return $data; 
  14.  
  15.         case 'array': 
  16.             // Arrays must be mapped in case they also return objects. 
  17.             return array_map( '_wp_json_prepare_data', $data ); 
  18.  
  19.         case 'object': 
  20.             // If this is an incomplete object (__PHP_Incomplete_Class), bail. 
  21.             if ( ! is_object( $data ) ) { 
  22.                 return null; 
  23.             } 
  24.  
  25.             if ( $data instanceof JsonSerializable ) { 
  26.                 $data = $data->jsonSerialize(); 
  27.             } else { 
  28.                 $data = get_object_vars( $data ); 
  29.             } 
  30.  
  31.             // Now, pass the array (or whatever was returned from jsonSerialize through). 
  32.             return _wp_json_prepare_data( $data ); 
  33.  
  34.         default: 
  35.             return null; 
  36.     } 
  37. }