PHP array_key_exists(): проверка наличия ключа в массиве

array_key_exists('key', $array) возвращает true, если в массиве есть этот ключ, и false, если нет. Обратите внимание на порядок: сначала ключ, потом массив. Функция возвращает true, даже когда под ключом хранится null, а именно этого 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 в ваших данных:

• Используйте isset(), когда null означает "значения нет". Это обычный случай, это языковая конструкция (немного быстрее), и она принимает вложенные пути и неопределённые переменные без предупреждения.
• Используйте array_key_exists(), когда null это настоящее значение, которое нужно отличать от отсутствующего ключа: поле JSON, отправленное как null, столбец базы данных со значением NULL, опция, явно заданная null, чтобы её сбросить.

Другие применения isset(), включая проверку нескольких переменных сразу, описаны на странице про isset.

Отличить null от отсутствия в JSON-данных

Типичный случай, где правильный ответ даёт только array_key_exists(): API, которое обновляет запись по JSON. Поле, отправленное как 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() это псевдоним array_key_exists(), оставшийся с ранних версий PHP. Те же аргументы, тот же результат. Предпочитайте полное имя, его читатели и ожидают увидеть.

<?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 это один ключ

Ключи массива бывают целыми числами или строками, а строка, которая является простым десятичным целым, хранится как целое. Поэтому 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() смотрит на один уровень. Для вложенного пути, где 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. Для объектов property_exists() проверяет объявленное или динамическое свойство (даже равное null), а 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));

Две последние строки показывают другой путь: get_object_vars() превращает доступные свойства объекта в массив, и к нему уже применимы функции для массивов.