json_decode

(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL json >= 1.2.0)

json_decode — Decodifica una cadena JSON

Descripción

json_decode(
    string $json,
    ?bool $associative = null,
    int $depth = 512,
    int $flags = 0
): mixed

Recupera una cadena codificada en JSON y la convierte en un valor de PHP.

Parámetros

json

La string json a decodificar.

Esta función solo funciona con cadenas codificadas en UTF-8.

Nota:
PHP implements a superset of JSON as specified in the original » RFC 7159.

associative

Cuando este parámetro vale true, los objetos JSON serán devueltos como arrays asociativos; cuando este parámetro vale false, los objetos JSON serán devueltos como objetos. Cuando este parámetro vale null, los objetos JSON serán devueltos como arrays asociativos o como objetos, según si la constante JSON_OBJECT_AS_ARRAY ha sido definida en el parámetro flags.

depth

Profundidad máxima de anidamiento de la estructura en proceso de decodificación. El valor debe ser superior a 0, e inferior o igual a 2147483647.

flags

Máscara de bits compuesta por JSON_BIGINT_AS_STRING, JSON_INVALID_UTF8_IGNORE, JSON_INVALID_UTF8_SUBSTITUTE, JSON_OBJECT_AS_ARRAY, JSON_THROW_ON_ERROR. El comportamiento de estas constantes se describe en la página de las constantes JSON.

Valores devueltos

Devuelve el valor codificado en el parámetro json en el tipo PHP apropiado. Los valores sin comillas true, false y null son devueltos respectivamente como true, false y null. null es devuelto si el parámetro json no ha podido ser decodificado o si los datos codificados son más profundos que el límite de anidamiento proporcionado.

Errores/Excepciones

Si depth está fuera del rango permitido, una ValueError es lanzada a partir de PHP 8.0.0, mientras que anteriormente se generaba un error de nivel E_WARNING.

Historial de cambios

Versión	Descripción
7.3.0	El `flags` `JSON_THROW_ON_ERROR` ha sido añadido.
7.2.0	El parámetro `associative` ahora es nullable.
7.2.0	Los `flags` `JSON_INVALID_UTF8_IGNORE`, y `JSON_INVALID_UTF8_SUBSTITUTE` han sido añadidos.
7.1.0	Una clave JSON vacía ("") puede ser codificada en la propiedad de objeto vacía en lugar de usar una clave con el valor `_empty_`.

Ejemplos

Ejemplo #1 Ejemplo con json_decode()

<?php
$json = '{"a":1,"b":2,"c":3,"d":4,"e":5}';

var_dump(json_decode($json));
var_dump(json_decode($json, true));

?>

El ejemplo anterior mostrará :

object(stdClass)#1 (5) {
    ["a"] => int(1)
    ["b"] => int(2)
    ["c"] => int(3)
    ["d"] => int(4)
    ["e"] => int(5)
}

array(5) {
    ["a"] => int(1)
    ["b"] => int(2)
    ["c"] => int(3)
    ["d"] => int(4)
    ["e"] => int(5)
}

Ejemplo #2 Acceso a propiedades de objeto inválidas

Acceder a elementos de un objeto que contienen caracteres no permitidos por la convención de nombres de PHP (es decir, el guión) puede realizarse encapsulando el nombre del elemento con corchetes y comillas.

<?php

$json = '{"foo-bar": 12345}';

$obj = json_decode($json);
print $obj->{'foo-bar'}; // 12345

?>

Ejemplo #3 Errores comunes al usar la función json_decode()

<?php

// Las siguientes cadenas son válidas en JavaScript pero no en JSON

// El nombre y el valor deben estar rodeados de comillas dobles.
// Las comillas simples no son válidas.
$bad_json = "{ 'bar': 'baz' }";
json_decode($bad_json); // null

// El nombre debe estar rodeado de comillas dobles.
$bad_json = '{ bar: "baz" }';
json_decode($bad_json); // null

// La coma final no está permitida.
$bad_json = '{ bar: "baz", }';
json_decode($bad_json); // null

?>

Ejemplo #4 Errores con el parámetro depth

<?php
// Codificación de datos con un nivel máximo de anidamiento de 4 (array -> array -> array -> string)
$json = json_encode(
    array(
        1 => array(
            'English' => array(
                'One',
                'January'
            ),
            'French' => array(
                'Une',
                'Janvier'
            )
        )
    )
);

// Definición de errores
$constants = get_defined_constants(true);
$json_errors = array();
foreach ($constants["json"] as $name => $value) {
 if (!strncmp($name, "JSON_ERROR_", 11)) {
  $json_errors[$value] = $name;
 }
}

$json = json_encode(
    array(
        1 => array(
            'English' => array(
                'One',
                'January'
            ),
            'French' => array(
                'Une',
                'Janvier'
            )
        )
    )
);

// Mostrar errores para diferentes niveles de anidamiento.
var_dump(json_decode($json, true, 4));
echo 'Last error: ', json_last_error_msg(), PHP_EOL, PHP_EOL;

var_dump(json_decode($json, true, 3));
echo 'Last error: ', json_last_error_msg(), PHP_EOL, PHP_EOL;
?>

El ejemplo anterior mostrará :

array(1) {
  [1]=>
  array(2) {
    ["English"]=>
    array(2) {
      [0]=>
      string(3) "One"
      [1]=>
      string(7) "January"
    }
    ["French"]=>
    array(2) {
      [0]=>
      string(3) "Une"
      [1]=>
      string(7) "Janvier"
    }
  }
}
Last error: No error

NULL
Last error: Maximum stack depth exceeded

Ejemplo #5 Ejemplo con json_decode() y grandes enteros

<?php
$json = '{"number": 12345678901234567890}';

var_dump(json_decode($json));
var_dump(json_decode($json, false, 512, JSON_BIGINT_AS_STRING));

?>

El ejemplo anterior mostrará :

object(stdClass)#1 (1) {
  ["number"]=>
  float(1.2345678901235E+19)
}
object(stdClass)#1 (1) {
  ["number"]=>
  string(20) "12345678901234567890"
}

Notas

Nota:
La especificación JSON no forma parte de Javascript sino de un subproyecto de Javascript.

Nota:
Si ocurre un error durante la decodificación, la función json_last_error() (o json_last_error_msg() con PHP5.5+) podrá ser utilizada para determinar la naturaleza exacta del error.

Ver también

json_encode() - Retorna la representación JSON de un valor
json_last_error() - Devuelve el último error JSON
json_last_error_msg() - Devuelve el mensaje del último error ocurrido durante la llamada a la función json_validate(), json_encode() o json_decode()

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 6 notes

down

Lennart Hengstmengel ¶

3 years ago

JSON can be decoded to PHP arrays by using the $associative = true option. Be wary that associative arrays in PHP can be a "list" or "object" when converted to/from JSON, depending on the keys (of absence of them). 

You would expect that recoding and re-encoding will always yield the same JSON string, but take this example:

    $json = '{"0": "No", "1": "Yes"}';
    $array = json_decode($json, true);  // decode as associative hash
    print json_encode($array) . PHP_EOL;

This will output a different JSON string than the original:

    ["No","Yes"]

The object has turned into an array!

Similarly, a array that doesn't have consecutive zero based numerical indexes, will be encoded to a JSON object instead of a list.

    $array = [
        'first',
        'second',
        'third',
    ];
    print json_encode($array) . PHP_EOL;
    // remove the second element
    unset($array[1]);
    print json_encode($array) . PHP_EOL;

The output will be:

    ["first","second","third"]
    {"0":"first","2":"third"}

The array has turned into an object! 

In other words, decoding/encoding to/from PHP arrays is not always symmetrical, or might not always return what you expect!

On the other hand, decoding/encoding from/to stdClass objects (the default) is always symmetrical. 

Arrays may be somewhat easier to work with/transform than objects. But especially if you need to decode, and re-encode json, it might be prudent to decode to objects and not arrays. 

If you want to enforce an array to encode to a JSON list (all array keys will be discarded), use:

    json_encode(array_values($array));

If you want to enforce an array to encode to a JSON object, use:

    json_encode((object)$array);

See also: https://www.php.net/manual/en/function.array-is-list.php

down

cubefox at web dot NOSPAMPLEASE dot de ¶

4 years ago

Warning: As the section "return values" mentions, the return value NULL is ambiguos. To repeat, it can mean three things:

* The input string had the value "null"
* There was an error while parsing the input data
* The encoded data was deeper than the recursion limit

To distinguish these cases, json_last_error() can be used.

down

Anonymous ¶

5 months ago

When JSON_OBJECT_AS_ARRAY is true, "json_decode($json)" is the same as "json_decode($json, false)" and return object actually. 

<?php
$php_constants = (get_defined_constants(true));
printf($php_constants['json']['JSON_OBJECT_AS_ARRAY'] . PHP_EOL);
$json = '{"a":1,"b":2,"c":3,"d":4,"e":5}';

$data = json_decode($json);
printf(is_array($data) . PHP_EOL);//false
var_dump($data);

$data = json_decode($json, false);
printf(is_array($data) . PHP_EOL);//false
var_dump($data);

$data = json_decode($json, true);
printf(is_array($data) . PHP_EOL);//true
var_dump($data);
?>

down

greaties at ghvernuft dot nl ¶

2 years ago

To load an object with data in json format:
(bugfixed my previous comment)

<?php
function loadJSON($Obj, $json)
{
    $dcod = json_decode($json);
    $prop = get_object_vars ( $dcod );
    foreach($prop as $key => $lock)
    {
        if(property_exists ( $Obj ,  $key ))
        {
            if(is_object($dcod->$key))
            {
                loadJSON($Obj->$key, json_encode($dcod->$key));
            }
            else
            {
                $Obj->$key = $dcod->$key;
            }
        }
    }
    return $Obj;
}
?>

Tested with: 

<?php
class Name
{
  public $first;
  public $last;
  public function fullname()
  {
    return $this->first . " " . $this->last;
  }
}
$json = '{"first":"John","last":"Smith"}';

$infull = loadJSON((new Name), $json);
echo $infull->fullname();

down

-1

Alien426 ¶

4 years ago

Browsers don't choke on integers _starting_ with BigInt (64 bits), but before that (53 bits). The introduction of BigInt to modern browsers doesn't help much, when JSON handling functions do not support it. So I am trying to remedy that. My approach is to handle the decoded array before re-encoding it to a string:
<?php
function fix_large_int(&$value)
 {
  if (is_int($value) && $value > 9007199254740991)
    $value = strval($value);
 }
$json_str = '{"id":[1234567890123456789,12345678901234567890]}';
$json_arr = json_decode($json_str, flags: JSON_BIGINT_AS_STRING | JSON_OBJECT_AS_ARRAY);
echo(json_encode($json_arr)); // {"id":[1234567890123456789,"12345678901234567890"]} (BigInt is already converted to a string here)
array_walk_recursive($json_arr, 'fix_large_int');
echo(json_encode($json_arr)); // {"id":["1234567890123456789","12345678901234567890"]}
?>

down

-4

pablo dot pazos at cabolabs dot com ¶

8 months ago

The return value says "Returns the value encoded in json as an appropriate PHP type.", that seems to be the description for the json_encode.

＋add a note