いっしー@Webエンジニア
トップページポートフォリオプログラミング言語ITニュースIT用語辞典ブログ

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

作成日: 更新日:

array_find_key関数は、配列の中から特定の条件を満たす最初の要素のキーを見つけることを実行する関数です。この関数は、検索対象となる配列と、検索条件を定義するためのコールバック関数を引数として受け取ります。

コールバック関数は、配列の各要素に対して順番に適用され、その要素が検索条件に合致するかどうかを評価します。コールバック関数が真（true）を返した時点で、その要素のキーがarray_find_key関数の結果として返され、それ以降の要素の評価は行われません。これにより、配列全体を走査することなく、目的のキーを効率的に見つけることが可能です。

もし配列内のどの要素もコールバック関数が定義する条件を満たさなかった場合、この関数はnullを返します。これは、条件に合致する要素が存在しなかったことを示します。array_find_key関数は、大規模な配列の中から特定の条件でキーを迅速に検索したい場合や、複雑なロジックに基づいて要素のインデックスを特定したい場合に非常に有用です。例えば、オブジェクトの配列から特定のプロパティ値を持つ最初のオブジェクトのキーを特定する際などに活用できます。

基本的な使い方

構文(syntax)

array_find_key(array $array, callable $callback): string|int|null

引数(parameters)

array $array, callable $callback

  • array $array: 検索対象の配列
  • callable $callback: 配列の各要素に対して実行されるコールバック関数。この関数は配列のキーと値を受け取り、要素が条件に一致した場合はtrueを、それ以外の場合はfalseを返します。

戻り値(return)

mixed

配列内で検索した値が最初に見つかったキーを返します。値が見つからなかった場合は null を返します。

サンプルコード

PHP array_find_key で条件に合うキーを検索する

<?php

/**
 * 指定されたコールバック関数に基づいて、配列内で最初に条件を満たすキーを検索します。
 *
 * @param array    $array    検索対象の配列。
 * @param callable $callback コールバック関数。各要素に対して実行され、true を返すとそのキーが返されます。
 *
 * @return mixed 条件を満たす最初のキー。見つからない場合は null。
 */
function array_find_key(array $array, callable $callback): mixed
{
    foreach ($array as $key => $value) {
        if ($callback($value, $key)) {
            return $key;
        }
    }

    return null;
}

// 使用例
$data = [
    'apple' => 10,
    'banana' => 20,
    'orange' => 30,
];

$key = array_find_key($data, function ($value, $key) {
    return $value > 15; // 値が15より大きい最初の要素のキーを検索
});

if ($key !== null) {
    echo "条件を満たすキー: " . $key . PHP_EOL; // 結果：条件を満たすキー: banana
} else {
    echo "条件を満たすキーは見つかりませんでした。" . PHP_EOL;
}

array_find_key関数は、PHP 8で配列の中から指定された条件を満たす最初のキーを検索するために使用します。この関数は、検索対象の配列 $array と、各要素に対して実行されるコールバック関数 $callback を引数として受け取ります。

コールバック関数 $callback は、配列の各要素の値を引数として受け取り、条件を満たす場合は true、そうでない場合は false を返す必要があります。array_find_key関数は、配列を順番に処理し、コールバック関数が true を返した最初の要素のキーを返します。

もし、配列内にコールバック関数の条件を満たす要素が見つからなかった場合、array_find_key関数は null を返します。戻り値の型は mixed であり、キーが見つかった場合はそのキーの値（文字列、数値など）、見つからなかった場合は null が返されます。

サンプルコードでは、連想配列 $data から値が15より大きい最初の要素のキーを検索しています。コールバック関数内で $value > 15 という条件を指定しており、'banana' の値が20であるため、この条件を満たします。したがって、array_find_key 関数は 'banana' を返し、結果として「条件を満たすキー: banana」と表示されます。もし、条件を満たす要素が配列内に存在しない場合は、「条件を満たすキーは見つかりませんでした。」と表示されます。

array_find_keyは、配列の各要素に対してコールバック関数を実行し、最初にtrueを返す要素のキーを返します。コールバック関数は、要素の値とキーを引数として受け取ります。キーが見つからない場合はnullを返す点に注意が必要です。サンプルコードでは、$key !== nullで存在チェックを行っていますが、PHP8以降ではis_null($key)よりも型安全な$key === nullの使用が推奨されます。また、コールバック関数内で外部変数を使用する場合は、useキーワードで明示的に変数をスコープに取り込む必要があります。コールバック関数が複雑になる場合は、可読性を高めるために、名前付き関数として定義することを検討してください。

PHP: 配列のキーを値から探す

<?php

/**
 * 配列内で、指定されたコールバック関数によって最初に真と評価された要素のキーを返す。
 *
 * @param array $array 検索対象の配列
 * @param callable $callback コールバック関数。引数として配列の各要素が渡される。
 * @return mixed|null 真と評価された要素のキー。見つからない場合は null を返す。
 */
function array_find_key(array $array, callable $callback): mixed
{
    foreach ($array as $key => $value) {
        if ($callback($value)) {
            return $key;
        }
    }

    return null;
}

// 使用例
$data = [
    'apple' => 'red',
    'banana' => 'yellow',
    'grape' => 'purple',
];

$key = array_find_key($data, function ($value) {
    return $value === 'yellow';
});

if ($key !== null) {
    echo "キーが見つかりました: " . $key . PHP_EOL; // 出力: キーが見つかりました: banana
} else {
    echo "キーは見つかりませんでした。" . PHP_EOL;
}

$key = array_find_key($data, function ($value) {
    return $value === 'green';
});

if ($key !== null) {
    echo "キーが見つかりました: " . $key . PHP_EOL;
} else {
    echo "キーは見つかりませんでした。" . PHP_EOL; // 出力: キーは見つかりませんでした。
}

array_find_key関数は、PHP 8で配列の中から特定の条件を満たす要素のキーを検索するために使用します。この関数は、配列$arrayとコールバック関数$callbackを引数に取ります。$callbackは配列の各要素に対して実行され、真偽値を返す必要があります。

array_find_keyは、配列$arrayの各要素を順番に$callbackに渡し、$callbackが最初にtrueを返した要素のキーを返します。もし、配列内に$callbackがtrueを返す要素がない場合は、nullを返します。

サンプルコードでは、まずarray_find_key関数を定義しています。この関数は、foreachループを使って配列を反復処理し、各要素に対して$callbackを実行します。$callbackがtrueを返した場合、その要素のキーを返します。

次に、この関数の使用例を示しています。果物の名前と色のペアを持つ配列$dataを用意し、array_find_keyを使って値が'yellow'である要素のキーを検索しています。同様に、値が'green'である要素のキーを検索する例も示しています。この例では、'yellow'のキーはbananaであるため、"キーが見つかりました: banana"と出力されます。一方、'green'は配列内に存在しないため、"キーは見つかりませんでした。"と出力されます。

この関数を使用することで、配列の値を基にキーを効率的に検索できます。

array_find_key関数は、配列の値を一つずつコールバック関数に渡し、最初にtrueを返したキーを返します。コールバック関数は、探したい値の条件を記述します。注意点として、コールバック関数には配列の値そのものが渡されるため、キーを直接参照することはできません。また、該当する要素が見つからない場合はnullが返されるため、!== nullを使って厳密に比較する必要があります。もしキーではなく値そのものを取得したい場合は、array_find_key関数を参考にarray_find_valueのような関数を別途実装する必要があります。コールバック関数が複雑になる場合は、事前に変数に代入することで可読性を高めることができます。

【PHP8.x】array_find_key関数の使い方 | いっしー@Webエンジニア