【PHP8.x】array_key_exists関数の使い方

Copy
1<?php
2
3/**
4 * array_key_exists() と isset() の挙動の違いを比較します。
5 *
6 * array_key_exists() は、配列内に指定したキーが存在するかどうかを純粋にチェックします。
7 * 一方、isset() は、キーが存在し、かつその値が null でない場合にのみ true を返します。
8 * この違いは、キーは存在するが値が null の場合に顕著になります。
9 */
10function compareKeyCheckFunctions(): void
11{
12    // テスト用の配列データ
13    // 'name' キーは存在するが、値は null
14    $data = [
15        'id' => 123,
16        'name' => null,
17    ];
18
19    echo 'チェック対象の配列:' . PHP_EOL;
20    print_r($data);
21    echo PHP_EOL;
22
23    // --- ケース1: キーが存在し、値が null の場合 ('name') ---
24    $key_with_null = 'name';
25
26    // array_key_exists() はキーの存在のみを見るため true を返す
27    if (array_key_exists($key_with_null, $data)) {
28        echo "[array_key_exists] キー '{$key_with_null}' は存在します。" . PHP_EOL;
29    } else {
30        echo "[array_key_exists] キー '{$key_with_null}' は存在しません。" . PHP_EOL;
31    }
32
33    // isset() は値が null のため false を返す
34    if (isset($data[$key_with_null])) {
35        echo "[isset] キー '{$key_with_null}' はセットされています。" . PHP_EOL;
36    } else {
37        echo "[isset] キー '{$key_with_null}' はセットされていません (値がnullのため)。" . PHP_EOL;
38    }
39
40    echo '---' . PHP_EOL;
41
42    // --- ケース2: キーが存在しない場合 ('age') ---
43    $non_existent_key = 'age';
44
45    // どちらの関数もキーが存在しないため false を返す
46    if (array_key_exists($non_existent_key, $data)) {
47        echo "[array_key_exists] キー '{$non_existent_key}' は存在します。" . PHP_EOL;
48    } else {
49        echo "[array_key_exists] キー '{$non_existent_key}' は存在しません。" . PHP_EOL;
50    }
51
52    if (isset($data[$non_existent_key])) {
53        echo "[isset] キー '{$non_existent_key}' はセットされています。" . PHP_EOL;
54    } else {
55        echo "[isset] キー '{$non_existent_key}' はセットされていません。" . PHP_EOL;
56    }
57}
58
59// 関数を実行して結果を表示
60compareKeyCheckFunctions();

PHPのarray_key_exists()関数は、配列の中に指定したキーが存在するかどうかを調べるための関数です。第1引数に調べたいキー（文字列または整数）、第2引数に対象となる配列を渡します。戻り値は真偽値（bool）であり、キーが存在すればtrue、存在しなければfalseを返します。

この関数としばしば比較されるものにisset()がありますが、両者の挙動には重要な違いがあります。それは、キーに対応する値がnullの場合の扱いです。array_key_exists()はキーの存在そのものをチェックするため、値がnullであってもキーが存在すればtrueを返します。対してisset()は、キーが存在し、かつその値がnullではない場合にのみtrueを返します。

サンプルコードでは、値がnullの'name'キーをチェックしています。この場合、array_key_exists()はtrueを返しますが、isset()は値がnullのためfalseを返します。一方で、存在しない'age'キーに対しては、どちらもfalseを返します。このように、値がnullのキーの存在を明確に確認したい場面でarray_key_exists()は有効です。

Copy
1<?php
2
3/**
4 * array_key_exists の使い方を示すサンプルコードです。
5 *
6 * array_key_exists 関数は、配列内に特定のキーが存在するかどうかをチェックします。
7 * キーに対応する値が null であっても、キーが存在すれば true を返します。
8 *
9 * 【キーワード「非推奨」について】
10 * array_key_exists 関数自体はPHP 8において非推奨ではありません。
11 * ただし、キーが存在し、かつその値が null でないことを確認したい場合は、
12 * isset() 関数を使用する方が一般的です。isset() は、キーが存在しないか、
13 * または値が null の場合に false を返します。
14 * どちらを使用するかは、あなたのコードが「キーの存在のみ」を確認したいのか、
15 * それとも「キーが存在し、かつ値が null でないこと」を確認したいのかによって選択します。
16 */
17function demonstrateArrayKeyExistsUsage(): void
18{
19    // サンプル配列を定義
20    $data = [
21        'user_id' => 101,
22        'username' => 'php_user',
23        'email' => null, // キーは存在するが値は null
24        0 => 'first_element'
25    ];
26
27    echo "--- array_key_exists の基本的な使用例 ---\n";
28
29    // 存在するキー 'username' の確認
30    if (array_key_exists('username', $data)) {
31        echo "✅ 'username' キーは存在します。\n";
32    } else {
33        echo "❌ 'username' キーは存在しません。\n";
34    }
35
36    // 値が null のキー 'email' の確認
37    if (array_key_exists('email', $data)) {
38        echo "✅ 'email' キーは存在します (値は null)。\n";
39    } else {
40        echo "❌ 'email' キーは存在しません。\n";
41    }
42
43    // 存在しないキー 'password' の確認
44    if (array_key_exists('password', $data)) {
45        echo "✅ 'password' キーは存在します。\n";
46    } else {
47        echo "❌ 'password' キーは存在しません。\n";
48    }
49
50    // 数値キー 0 の確認
51    if (array_key_exists(0, $data)) {
52        echo "✅ 数値キー '0' は存在します。\n";
53    } else {
54        echo "❌ 数値キー '0' は存在しません。\n";
55    }
56
57    echo "\n--- array_key_exists と isset() の違い ---\n";
58
59    // キー 'email' (値が null) での違い
60    echo "キー 'email' (値は null):\n";
61    echo "  array_key_exists('email', \$data) の結果: " . (array_key_exists('email', $data) ? 'true' : 'false') . "\n";
62    echo "  isset(\$data['email']) の結果: " . (isset($data['email']) ? 'true' : 'false') . "\n";
63
64    // キー 'user_id' (値が存在) での違い
65    echo "\nキー 'user_id' (値は 101):\n";
66    echo "  array_key_exists('user_id', \$data) の結果: " . (array_key_exists('user_id', $data) ? 'true' : 'false') . "\n";
67    echo "  isset(\$data['user_id']) の結果: " . (isset($data['user_id']) ? 'true' : 'false') . "\n";
68
69    // 存在しないキー 'phone' での違い
70    echo "\n存在しないキー 'phone':\n";
71    echo "  array_key_exists('phone', \$data) の結果: " . (array_key_exists('phone', $data) ? 'true' : 'false') . "\n";
72    echo "  isset(\$data['phone']) の結果: " . (isset($data['phone']) ? 'true' : 'false') . "\n";
73}
74
75// 関数を実行
76demonstrateArrayKeyExistsUsage();

array_key_exists関数は、指定した配列の中に、特定のキーが存在するかどうかを確認するためのPHP関数です。第一引数に確認したいキー（文字列または整数）、第二引数に対象となる配列を指定します。指定したキーが配列内に存在すればtrueを、存在しなければfalseを返します。

この関数の重要な特徴は、キーに対応する値がnullであっても、キー自体が存在すればtrueを返す点です。サンプルコードでは、値がnullである'email'キーを確認した際にtrueが返されることで、この挙動を示しています。これは、キーが存在しない場合や値がnullの場合にfalseを返すisset()との大きな違いです。

array_key_exists関数自体は非推奨ではありませんが、isset()と適切に使い分けることが重要です。「キーの存在そのもの」を厳密にチェックしたい場合にこの関数を使用し、「キーが存在し、かつ値がnullでないこと」を確認したい場合はisset()を使用するのが一般的です。