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

<?php

/**
 * 配列に指定したキーが存在するかどうかを確認するサンプルです。
 *
 * key_exists() 関数は、第2引数の配列に、第1引数で指定したキーが存在するかどうかを
 * bool値 (true または false) で返します。
 *
 * @param string|int $key   検索するキー
 * @param array      $array 検索対象の配列
 */
function checkArrayKey(string|int $key, array $array): void
{
    if (key_exists($key, $array)) {
        // キーが存在する場合の処理
        echo "キー '{$key}' は配列内に存在します。" . PHP_EOL;
    } else {
        // キーが存在しない場合の処理
        echo "キー '{$key}' は配列内に存在しません。" . PHP_EOL;
    }
}

// サンプル用の連想配列
$user = [
    'name' => 'Taro Yamada',
    'age' => 30,
    'job' => null, // キーは存在するが、値は null
];

// --- テストケース ---

// 1. 存在するキー 'name' をチェック
checkArrayKey('name', $user); // 出力: キー 'name' は配列内に存在します。

// 2. 存在しないキー 'address' をチェック
checkArrayKey('address', $user); // 出力: キー 'address' は配列内に存在しません。

// 3. 値が null のキー 'job' をチェック
// key_exists() はキーの存在自体を確認するため、値が null でも true を返します。
// これは、値が null の場合に false を返す isset() との重要な違いです。
checkArrayKey('job', $user); // 出力: キー 'job' は配列内に存在します。

PHPのkey_exists()関数は、指定したキーが配列の中に存在するかどうかを調べるために使用します。この関数は2つの引数を取ります。第1引数には検索したいキー（文字列または整数）を、第2引数には検索対象の配列を指定します。

関数の処理結果として、指定したキーが配列内に存在すればtrue、存在しなければfalseという真偽値が返されます。

サンプルコードでは、$userという連想配列に対してキーの存在を確認しています。存在するキー'name'を調べるとtrueが返り、「存在します」と表示されます。一方、存在しないキー'address'を調べるとfalseが返るため、「存在しません」と表示されます。

特に重要なのは、値がnullであるキー'job'を調べた場合です。key_exists()はキーの存在自体を判定するため、値がnullであってもtrueを返します。これは、キーが存在し、かつ値がnullでない場合にのみtrueを返すisset()との大きな違いであり、キーの存在そのものを厳密に確認したい場合に便利です。

<?php

declare(strict_types=1);

// key_exists() は、配列のキーだけでなく、オブジェクトの public なプロパティの
// 存在をチェックするためにも使用できます。

// チェック対象となる stdClass オブジェクトを作成します。
// stdClass は、プロパティを動的に追加できる PHP の標準的な空のクラスです。
$userObject = new stdClass();
$userObject->id = 1;
$userObject->name = 'Taro Yamada';

// --- key_exists() を使用したプロパティの存在チェック ---

// 1. 存在するプロパティ ('name') をチェックします。
$keyToCheck1 = 'name';
if (key_exists($keyToCheck1, $userObject)) {
    echo "プロパティ '{$keyToCheck1}' はオブジェクトに存在します。" . PHP_EOL;
} else {
    echo "プロパティ '{$keyToCheck1}' はオブジェクトに存在しません。" . PHP_EOL;
}

// 2. 存在しないプロパティ ('age') をチェックします。
$keyToCheck2 = 'age';
if (key_exists($keyToCheck2, $userObject)) {
    echo "プロパティ '{$keyToCheck2}' はオブジェクトに存在します。" . PHP_EOL;
} else {
    echo "プロパティ '{$keyToCheck2}' はオブジェクトに存在しません。" . PHP_EOL;
}

// NOTE: オブジェクトのプロパティ存在チェックには、より目的に合った
// `property_exists()` 関数の使用が一般的に推奨されます。
// `key_exists()` は、PHP 8.0.0 以降、オブジェクトに対して使用すると
// 非推奨になる場合があるため注意が必要です。

?>

このPHPコードは、key_exists関数を使い、オブジェクトに特定のプロパティが存在するかどうかを確認する例です。

key_exists関数は、第1引数で指定したキーが、第2引数で指定した配列内に存在するかを判定します。キーが存在する場合はtrue（真）を、存在しない場合はfalse（偽）を戻り値として返します。この関数は、配列だけでなくオブジェクトのpublicなプロパティの存在チェックにも使用できます。

サンプルコードでは、まずidとnameのプロパティを持つ$userObjectというオブジェクトを作成しています。最初のif文では、key_exists関数で存在するプロパティ'name'をチェックしているためtrueが返り、「存在します」というメッセージが表示されます。次のif文では、存在しないプロパティ'age'をチェックしているためfalseが返り、「存在しません」というメッセージが表示されます。

注意点として、オブジェクトのプロパティを調べる場合は、より目的に合ったproperty_exists関数を使用することが一般的に推奨されています。