PHP json_decode(): разбор JSON в массивы или объекты

json_decode($json, true) превращает строку JSON в значения PHP, где каждый JSON-объект становится ассоциативным массивом. Без true JSON-объекты становятся объектами stdClass, которые читают через ->. Неверный JSON даёт null.

<?php
$json = '{"name": "Ada", "age": 36, "langs": ["php", "js"], "admin": true}';

$data = json_decode($json, true);   // associative array
echo $data['name'], "\n";
echo $data['langs'][1], "\n";

$obj = json_decode($json);          // stdClass object
echo $obj->name, "\n";
echo $obj->langs[0], "\n";

print_r($data);

Вывод:

Ada
js
Ada
php
Array
(
    [name] => Ada
    [age] => 36
    [langs] => Array
        (
            [0] => php
            [1] => js
        )

    [admin] => 1
)

JSON-массивы всегда становятся списками PHP, какой бы режим вы ни выбрали. Обратное направление, из PHP в JSON, это json_encode().

Ассоциативный массив или объект: true и false

Оба режима хранят одни и те же данные; выбирайте тот, с которым ваш код читается лучше. Массивы работают со всеми функциями для массивов (array_column, array_map, isset($data['key'])), поэтому в большинстве кода передают true. Объектам нужен синтаксис с фигурными скобками для ключей, которые не являются допустимыми именами свойств, например ключей с дефисом или чисел:

<?php
$json = '{"first-name": "Ada", "0": "zero", "address": {"city": "London"}}';

$arr = json_decode($json, true);
echo $arr['first-name'], ' ', $arr[0], ' ', $arr['address']['city'], "\n";

$obj = json_decode($json);
echo $obj->{'first-name'}, ' ', $obj->{'0'}, ' ', $obj->address->city, "\n";

var_dump($obj->address);

Вывод:

Ada zero London
Ada zero London
object(stdClass)#2 (1) {
  ["city"]=>
  string(6) "London"
}

Четвёртый параметр принимает флаги. JSON_OBJECT_AS_ARRAY тоже даёт массивы, но только пока второй аргумент равен null (его значение по умолчанию): json_decode($json, flags: JSON_OBJECT_AS_ARRAY) возвращает массивы, а json_decode($json, false, 512, JSON_OBJECT_AS_ARRAY) по-прежнему возвращает объекты.

Обход вложенного JSON

Ответы API обычно это список объектов внутри объекта. Декодируйте один раз, затем обходите через foreach и используйте ?? для полей, которых может не быть:

<?php
$json = <<<'JSON'
{
    "page": 1,
    "users": [
        {"id": 1, "name": "Ada", "email": "ada@example.com", "roles": ["admin", "editor"]},
        {"id": 2, "name": "Linus", "roles": []},
        {"id": 3, "name": "Grace", "email": "grace@example.com", "roles": ["editor"]}
    ]
}
JSON;

$data = json_decode($json, true);

foreach ($data['users'] as $user) {
    $email = $user['email'] ?? 'no email';
    $roles = $user['roles'] ? implode(', ', $user['roles']) : 'none';
    echo "#{$user['id']} {$user['name']} <$email> roles: $roles\n";
}

$names = array_column($data['users'], 'name', 'id');
print_r($names);

Вывод:

#1 Ada <ada@example.com> roles: admin, editor
#2 Linus <no email> roles: none
#3 Grace <grace@example.com> roles: editor
Array
(
    [1] => Ada
    [2] => Linus
    [3] => Grace
)

Обработка неверного JSON

json_decode() возвращает null для неверного JSON, но null это ещё и правильный результат для JSON-текста null, поэтому один null не говорит, был ли сбой. json_last_error_msg() сообщает причину последнего вызова. Более чистый способ это JSON_THROW_ON_ERROR, который выбрасывает JsonException:

<?php
var_dump(json_decode('{"a": 1,}'));   // trailing comma
echo json_last_error_msg(), "\n";

var_dump(json_decode('null'));        // valid JSON, also null
echo json_last_error_msg(), "\n";

try {
    $data = json_decode("{'a': 1}", true, 512, JSON_THROW_ON_ERROR);
} catch (JsonException $e) {
    echo 'Invalid JSON: ', $e->getMessage(), "\n";
}

Вывод:

NULL
Syntax error
NULL
No error
Invalid JSON: Syntax error

Третий аргумент, 512, это максимальная глубина вложенности (по умолчанию). С именованными аргументами его можно пропустить: json_decode($json, true, flags: JSON_THROW_ON_ERROR).

Проверка корректности JSON через json_validate()

В PHP 8.3 появилась json_validate(). Она отвечает true или false, не строя декодированные массивы, поэтому тратит меньше памяти, чем декодирование, когда нужен лишь ответ "да" или "нет", например чтобы сразу отклонить тело запроса:

<?php
$inputs = ['{"a": 1}', '[1, 2, 3]', '"text"', '{a: 1}', "{'a': 1}", ''];

foreach ($inputs as $input) {
    $ok = json_validate($input) ? 'valid' : 'invalid: ' . json_last_error_msg();
    echo str_pad(var_export($input, true), 14), $ok, "\n";
}

Вывод:

'{"a": 1}'    valid
'[1, 2, 3]'   valid
'"text"'      valid
'{a: 1}'      invalid: Syntax error
'{\'a\': 1}'  invalid: Syntax error
''            invalid: Syntax error

Если данные вам всё равно понадобятся, пропустите json_validate() и декодируйте с JSON_THROW_ON_ERROR: проверка заранее разбирает строку дважды.

Чтение JSON-файла

Прочитайте файл через file_get_contents() и декодируйте строку. Этот блок сначала записывает settings.json, чтобы было что читать:

<?php
file_put_contents('settings.json', '{"theme": "dark", "fontSize": 14, "plugins": ["git", "lint"]}');

$text = file_get_contents('settings.json');
if ($text === false) {
    exit("Cannot read settings.json\n");
}

$settings = json_decode($text, true, flags: JSON_THROW_ON_ERROR);
echo "Theme: {$settings['theme']}\n";
echo "Plugins: ", count($settings['plugins']), "\n";

// Change a value and write the file back
$settings['fontSize'] = 16;
file_put_contents('settings.json', json_encode($settings, JSON_PRETTY_PRINT));
echo file_get_contents('settings.json'), "\n";

Вывод:

Theme: dark
Plugins: 2
{
    "theme": "dark",
    "fontSize": 16,
    "plugins": [
        "git",
        "lint"
    ]
}

Почему json_decode возвращает null: частые причины

JSON строже, чем синтаксис JavaScript и массивов PHP. Каждая строка ниже выглядит разумно, и каждая возвращает null. Запустите, чтобы увидеть причину для каждой, затем исправьте одну и запустите снова:

<?php
$cases = [
    'single quotes'   => "{'name': 'Ada'}",
    'unquoted key'    => '{name: "Ada"}',
    'trailing comma'  => '{"name": "Ada",}',
    'comment'         => '{"name": "Ada" /* admin */}',
    'byte order mark' => "\xEF\xBB\xBF" . '{"name": "Ada"}',
    'too deep'        => '[[["Ada"]]]',
];

foreach ($cases as $label => $json) {
    $depth = $label === 'too deep' ? 2 : 512;
    $result = json_decode($json, true, $depth);
    echo str_pad($label, 17), $result === null ? json_last_error_msg() : 'ok', "\n";
}

// Big integers lose precision unless you ask for strings
var_dump(json_decode('{"id": 12345678901234567890}', true)['id']);
var_dump(json_decode('{"id": 12345678901234567890}', true, 512, JSON_BIGINT_AS_STRING)['id']);

Вывод:

single quotes    Syntax error
unquoted key     Syntax error
trailing comma   Syntax error
comment          Syntax error
byte order mark  Syntax error
too deep         Maximum stack depth exceeded
float(1.2345678901234567E+19)
string(20) "12345678901234567890"

Метка порядка байтов (BOM) невидима в большинстве редакторов, и это классическая причина того, что JSON-файл "выглядит нормально", но не декодируется. Уберите её через $text = preg_replace('/^\xEF\xBB\xBF/', '', $text); перед декодированием.