PHP array_key_exists(): Cek Apakah Key Ada di Array

array_key_exists('key', $array) mengembalikan true kalau array punya key itu dan false kalau tidak. Perhatikan urutannya: key lebih dulu, array kedua. Fungsi ini mengembalikan true bahkan saat nilai yang tersimpan di key itu null, dan hanya itulah yang tidak dilakukan isset().

<?php
$user = ['name' => 'Ada', 'email' => 'ada@example.com', 'phone' => null];

var_dump(array_key_exists('email', $user));
var_dump(array_key_exists('address', $user));
var_dump(array_key_exists('phone', $user));   // key is there, value is null

$list = ['a', 'b', 'c'];
var_dump(array_key_exists(2, $list));         // integer keys too

Untuk memeriksa nilai, bukan key, pakai in_array().

array_key_exists vs isset

Keduanya memeriksa key. Hasilnya hanya berbeda saat nilainya null: isset() menganggap nilai null sebagai "tidak di-set", sedangkan array_key_exists() melaporkan apa yang sebenarnya ada di array.

<?php
$form = ['name' => 'Ada', 'nickname' => null, 'age' => 0, 'bio' => ''];

foreach (['name', 'nickname', 'age', 'bio', 'missing'] as $key) {
    printf(
        "%-9s isset: %-5s  array_key_exists: %s\n",
        $key,
        var_export(isset($form[$key]), true),
        var_export(array_key_exists($key, $form), true)
    );
}

0 dan '' dianggap di-set oleh keduanya; hanya null yang membuat hasilnya berbeda. Mana yang kamu pakai tergantung arti null di datamu:

• Pakai isset() saat null berarti "tidak ada nilai". Ini kasus yang paling umum, ia adalah konstruksi bahasa (sedikit lebih cepat), dan ia menerima jalur bersarang serta variabel yang belum didefinisikan tanpa warning.
• Pakai array_key_exists() saat null adalah nilai sungguhan yang harus kamu bedakan dari key yang tidak ada: field JSON yang dikirim sebagai null, kolom database yang bernilai NULL, atau opsi yang sengaja diisi null untuk mengosongkannya.

Halaman isset membahas kegunaan lainnya, termasuk memeriksa beberapa variabel sekaligus.

Membedakan null dan key yang tidak ada di payload JSON

Contoh umum ketika hanya array_key_exists() yang memberi jawaban benar: API yang memperbarui sebuah record dari JSON. Field yang dikirim sebagai null berarti "kosongkan", sedangkan field yang tidak dikirim berarti "jangan diubah". isset() melihat keduanya sama saja.

<?php
$record = ['name' => 'Ada', 'phone' => '555-0100', 'city' => 'London'];
$patch  = json_decode('{"phone": null, "city": "Paris"}', true);

foreach (['name', 'phone', 'city'] as $field) {
    if (array_key_exists($field, $patch)) {
        $record[$field] = $patch[$field];   // includes setting null
    }
}

var_dump($record);

Dengan isset($patch[$field]), nomor telepon akan tetap ada, karena null akan terlihat seperti field yang tidak dikirim.

key_exists() adalah fungsi yang sama

key_exists() adalah alias dari array_key_exists(), warisan dari PHP versi awal. Argumennya sama, hasilnya sama. Pilih nama lengkapnya, karena itulah yang diharapkan pembaca kodemu.

<?php
$config = ['debug' => false];

var_dump(key_exists('debug', $config));
var_dump(array_key_exists('debug', $config));
var_dump(key_exists('cache', $config));

Tipe key: "1" dan 1 adalah key yang sama

Key array berupa integer atau string, dan string yang berisi bilangan bulat desimal biasa disimpan sebagai integer. Jadi array_key_exists('1', $arr) menemukan key 1, begitu pula sebaliknya. String seperti '01' tetap string dan merupakan key yang berbeda.

<?php
$byId = [1 => 'Ada', 2 => 'Linus', '07' => 'Grace'];

var_dump(array_key_exists('1', $byId));    // "1" is the int key 1
var_dump(array_key_exists(7, $byId));      // 7 is not "07"
var_dump(array_key_exists('07', $byId));

Memeriksa key bersarang dan beberapa key

array_key_exists() hanya melihat satu level. Untuk jalur bersarang yang tidak peduli null, isset($a['x']['y']) memeriksa setiap level sekaligus. Untuk jalur yang memedulikannya, sebuah fungsi bantu pendek bisa menelusuri level-levelnya. Untuk memeriksa bahwa beberapa key ada semua, bandingkan dengan array_diff_key().

<?php
function hasPath(array $data, array $path): bool
{
    foreach ($path as $key) {
        if (!is_array($data) || !array_key_exists($key, $data)) {
            return false;
        }
        $data = $data[$key];
    }
    return true;
}

$order = ['customer' => ['address' => ['city' => 'Lyon', 'zip' => null]]];

var_dump(isset($order['customer']['address']['zip']));          // null: false
var_dump(hasPath($order, ['customer', 'address', 'zip']));       // present: true
var_dump(hasPath($order, ['customer', 'phone']));

$required = ['name', 'email', 'password'];
$input = ['name' => 'Ada', 'email' => 'ada@example.com'];
$missing = array_keys(array_diff_key(array_flip($required), $input));
print_r($missing);

array_flip($required) mengubah daftar nama menjadi key supaya array_diff_key() bisa membandingkannya dengan key milik input; yang tersisa adalah daftar field yang tidak ada, siap dipakai untuk pesan error.

Objek butuh property_exists

PHP versi lama menerima objek di array_key_exists(). PHP 8 justru melempar TypeError. Untuk objek, property_exists() memeriksa property yang dideklarasikan atau dinamis (bahkan yang diisi null), dan isset($obj->prop) bekerja seperti isset() pada array.

<?php
class User
{
    public ?string $phone = null;
    public string $name = 'Ada';
}

$u = new User();

var_dump(property_exists($u, 'phone'));   // declared, value null
var_dump(isset($u->phone));
var_dump(property_exists($u, 'email'));

$asArray = get_object_vars($u);
var_dump(array_key_exists('name', $asArray));

Dua baris terakhir menunjukkan cara lain: get_object_vars() mengubah property objek yang bisa diakses menjadi array, lalu fungsi-fungsi array bisa dipakai.