PHPのarray_key_exists()：配列のキーが存在するか確認

array_key_exists('key', $array)は、配列にそのキーがあればtrueを、なければfalseを返します。順番に注意してください。キーが先で、配列が後です。キーの下に格納された値がnullでもtrueを返し、これが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

キーではなく値を確認するには、in_array()を使います。

array_key_existsとissetの違い

どちらもキーを確認します。意見が分かれるのは値がnullのときだけです。isset()はnullの値を「設定されていない」として扱い、array_key_exists()は配列に実際にあるものを報告します。

<?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と''はどちらでも設定済みとみなされ、違いが出るのはnullだけです。どちらを使うかは、データの中でnullが何を意味するかで決まります。

• nullが「値がない」を意味するならisset()を使います。これがよくあるケースで、言語構造なので（少し速く）、ネストしたパスや未定義の変数も警告なしで受け付けます。
• nullが、存在しないキーと区別すべき本当の値ならarray_key_exists()を使います。nullとして送られたJSONのフィールド、NULLであるデータベースのカラム、クリアするために明示的にnullにしたオプションなどです。

複数の変数を一度に確認する方法など、ほかの使い方はissetのページで扱っています。

JSONのペイロードでnullと欠落を区別する

array_key_exists()だけが正しい答えを出す典型的なケースです。JSONからレコードを更新するAPIでは、nullとして送られたフィールドは「クリアする」、省かれたフィールドは「触らない」を意味します。isset()には両方が同じに見えます。

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

isset($patch[$field])だと、nullが欠落したフィールドに見えるので、電話番号は残ってしまいます。

key_exists()は同じ関数

key_exists()は初期のPHPから残っているarray_key_exists()の別名です。引数も結果も同じです。読む人が目にすると予想している、完全な名前のほうを使いましょう。

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

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

キーの型："1"と1は同じキー

配列のキーは整数か文字列で、単純な10進数の整数を表す文字列は整数として保存されます。そのためarray_key_exists('1', $arr)はキー1を見つけ、その逆も同じです。'01'のような文字列は文字列のままで、別のキーです。

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

ネストしたキーと複数のキーを確認する

array_key_exists()が見るのは1つの階層です。nullが問題にならないネストしたパスなら、isset($a['x']['y'])がすべての階層を一度に確認します。問題になるパスなら、短いヘルパー関数で階層をたどります。複数のキーがすべて存在するかを確認するには、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)は名前のリストをキーに変えるので、array_diff_key()で入力のキーと比較できます。残ったものが足りないフィールドのリストで、そのままエラーメッセージに使えます。

オブジェクトにはproperty_existsが必要

古いPHPはarray_key_exists()にオブジェクトを受け付けていました。PHP 8では代わりにTypeErrorが投げられます。オブジェクトには、宣言済みまたは動的なプロパティを（nullに設定されていても）確認するproperty_exists()を使い、isset($obj->prop)は配列に対するisset()と同じように動きます。

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

最後の2行はもう1つの方法を示しています。get_object_vars()はオブジェクトのアクセス可能なプロパティを配列にするので、そのあとは配列の関数が使えます。