json_decode() PHP: Ubah JSON Jadi Array atau Object

json_decode($json, true) mengubah string JSON menjadi nilai PHP, dengan setiap object JSON menjadi array asosiatif. Tanpa true, object JSON menjadi object stdClass, yang dibaca dengan ->. JSON yang tidak valid menghasilkan 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);

Output:

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

    [admin] => 1
)

Array JSON selalu menjadi list PHP, mode mana pun yang kamu pilih. Untuk arah sebaliknya, dari PHP ke JSON, pakai json_encode().

Array asosiatif atau object: true vs false

Kedua mode menyimpan data yang sama; pilih yang lebih enak dibaca di kodemu. Array bisa dipakai dengan setiap fungsi array (array_column, array_map, isset($data['key'])), jadi sebagian besar kode memberikan true. Object butuh sintaks kurung kurawal untuk key yang bukan nama property yang valid, seperti key yang mengandung tanda hubung atau berupa angka:

<?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);

Output:

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

Parameter keempat menerima flag. JSON_OBJECT_AS_ARRAY juga menghasilkan array, tetapi hanya selama argumen kedua bernilai null (nilai default-nya): json_decode($json, flags: JSON_OBJECT_AS_ARRAY) mengembalikan array, sedangkan json_decode($json, false, 512, JSON_OBJECT_AS_ARRAY) tetap mengembalikan object.

Perulangan atas JSON bersarang

Response API biasanya berupa list object di dalam sebuah object. Decode sekali, lalu telusuri dengan foreach, dan pakai ?? untuk field yang mungkin tidak ada:

<?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);

Output:

#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
)

Menangani JSON yang tidak valid

json_decode() mengembalikan null untuk JSON yang tidak valid, tetapi null juga merupakan hasil yang benar untuk teks JSON null, jadi null saja tidak memberi tahu apakah decode-nya gagal. json_last_error_msg() memberikan alasan dari pemanggilan terakhir. Untuk menemukan letak kesalahannya di dokumen yang panjang, tempel ke JSON formatter, yang menunjuk baris yang error. Cara yang lebih rapi adalah JSON_THROW_ON_ERROR, yang melempar 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";
}

Output:

NULL
Syntax error
NULL
No error
Invalid JSON: Syntax error

Argumen ketiga, 512, adalah kedalaman nesting maksimum (nilai default-nya). Dengan named argument kamu bisa melewatinya: json_decode($json, true, flags: JSON_THROW_ON_ERROR).

Cek apakah string adalah JSON yang valid dengan json_validate()

PHP 8.3 menambahkan json_validate(). Fungsi ini menjawab true atau false tanpa membuat array hasil decode, jadi memakai lebih sedikit memori daripada decode saat yang kamu butuhkan hanya jawaban ya atau tidak, misalnya untuk menolak body request sejak awal:

<?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";
}

Output:

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

Jika datanya akan tetap kamu pakai, lewati json_validate() dan langsung decode dengan JSON_THROW_ON_ERROR: memvalidasi dulu berarti string-nya di-parse dua kali.

Membaca file JSON

Baca file-nya dengan file_get_contents() lalu decode string-nya. Blok ini menulis settings.json lebih dulu agar ada file yang bisa dibaca:

<?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";

Output:

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

Kenapa json_decode mengembalikan null: penyebab yang umum

JSON lebih ketat daripada sintaks JavaScript dan array PHP. Setiap string di bawah ini terlihat wajar dan semuanya mengembalikan null. Jalankan untuk melihat alasan masing-masing, lalu perbaiki salah satunya dan jalankan lagi:

<?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']);

Output:

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"

Byte order mark tidak terlihat di sebagian besar editor dan merupakan penyebab klasik file JSON yang "terlihat baik-baik saja" tetapi tidak bisa di-decode. Buang dengan $text = preg_replace('/^\xEF\xBB\xBF/', '', $text); sebelum melakukan decode.