array_key_exists() trong PHP: kiểm tra khóa có trong mảng

array_key_exists('key', $array) trả về true nếu mảng có khóa đó và false nếu không. Lưu ý thứ tự: khóa đứng trước, mảng đứng sau. Hàm trả về true ngay cả khi giá trị lưu ở khóa đó là null, và đây chính là điều duy nhất isset() không làm.

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

Để kiểm tra một giá trị thay vì một khóa, hãy dùng in_array().

array_key_exists vs isset

Cả hai đều kiểm tra một khóa. Chúng chỉ cho kết quả khác nhau khi giá trị là null: isset() coi giá trị null là "chưa được đặt", còn array_key_exists() báo đúng những gì thật sự có trong mảng.

<?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 và '' đều được cả hai coi là đã đặt; chỉ có null làm chúng khác nhau. Bạn cần hàm nào phụ thuộc vào ý nghĩa của null trong dữ liệu:

• Dùng isset() khi null nghĩa là "không có giá trị". Đây là trường hợp phổ biến, isset() là một cấu trúc ngôn ngữ (nhanh hơn một chút), và nó nhận cả đường dẫn lồng nhau lẫn biến chưa định nghĩa mà không cảnh báo.
• Dùng array_key_exists() khi null là một giá trị thật mà bạn phải phân biệt với khóa không tồn tại: một trường JSON được gửi là null, một cột cơ sở dữ liệu có giá trị NULL, một tùy chọn được cố ý đặt là null để xóa nó.

Trang isset trình bày các cách dùng khác của nó, bao gồm kiểm tra nhiều biến cùng lúc.

Phân biệt null với khóa không tồn tại trong payload JSON

Một trường hợp điển hình mà chỉ array_key_exists() cho câu trả lời đúng: một API cập nhật bản ghi từ JSON. Trường được gửi là null nghĩa là "xóa nó", còn trường không được gửi nghĩa là "đừng động vào". isset() coi hai trường hợp này là một.

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

Nếu dùng isset($patch[$field]), số điện thoại sẽ vẫn còn, vì null trông giống như một trường không được gửi.

key_exists() là cùng một hàm

key_exists() là bí danh của array_key_exists(), còn giữ lại từ các phiên bản PHP đầu tiên. Cùng đối số, cùng kết quả. Hãy ưu tiên tên đầy đủ, vì đó là tên người đọc code mong đợi.

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

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

Kiểu của khóa: "1" và 1 là cùng một khóa

Khóa của mảng là số nguyên hoặc chuỗi, và một chuỗi chỉ chứa số nguyên thập phân thông thường sẽ được lưu dưới dạng số nguyên. Vì vậy array_key_exists('1', $arr) tìm thấy khóa 1, và ngược lại. Một chuỗi như '01' vẫn là chuỗi và là một khóa khác.

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

Kiểm tra khóa lồng nhau và nhiều khóa

array_key_exists() chỉ xét một cấp. Với một đường dẫn lồng nhau mà null không quan trọng, isset($a['x']['y']) kiểm tra mọi cấp cùng lúc. Với đường dẫn mà null có ý nghĩa, một hàm hỗ trợ ngắn sẽ đi qua từng cấp. Để kiểm tra nhiều khóa có đủ hay không, hãy so sánh bằng 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) biến danh sách tên thành các khóa để array_diff_key() so sánh chúng với các khóa của đầu vào; phần còn lại là danh sách các trường bị thiếu, sẵn sàng cho thông báo lỗi.

Đối tượng cần property_exists

PHP phiên bản cũ chấp nhận đối tượng trong array_key_exists(). PHP 8 thì ném ra TypeError. Với đối tượng, property_exists() kiểm tra một thuộc tính đã khai báo hoặc thuộc tính động (kể cả khi được đặt là null), còn isset($obj->prop) hoạt động giống isset() trên mảng.

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

Hai dòng cuối cho thấy một cách khác: get_object_vars() biến các thuộc tính truy cập được của đối tượng thành một mảng, sau đó bạn dùng được các hàm xử lý mảng.