Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】ARRAY_FILTER_USE_KEY定数の使い方

ARRAY_FILTER_USE_KEY定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

ARRAY_FILTER_USE_KEY定数は、PHPの配列をフィルタリングする際に利用される定数です。これは、array_filter()関数に適用され、フィルタリングの基準として配列の「キー」を使用することを指定します。

通常、array_filter()関数は、配列の各要素の「値」をコールバック関数に渡し、そのコールバック関数の戻り値(真偽値)に基づいて要素を残すかどうかを判断します。しかし、このARRAY_FILTER_USE_KEY定数をarray_filter()関数の第三引数であるmodeパラメータに指定すると、コールバック関数には配列の「値」ではなく「キー」が引数として渡されるようになります。これにより、配列のキーに基づいて条件を評価し、フィルタリングを行うことが可能になります。

例えば、特定の文字列を含むキーを持つ要素のみを抽出したい場合や、キーが特定の数値範囲内にある要素を対象としたい場合などに非常に有効です。ARRAY_FILTER_USE_KEYを用いることで、配列の構造を意識したより柔軟なデータ操作を実現できます。キーと値の両方を参照してフィルタリングを行いたい場合には、ARRAY_FILTER_USE_BOTH定数を使用します。このように、array_filter()関数は、これらの定数を用いることで様々なフィルタリングのニーズに応えることができます。

構文(syntax)

1<?php
2$data = [
3    'id_1' => 'Apple',
4    'id_2' => 'Banana',
5    'name_3' => 'Cherry',
6    'id_4' => 'Date'
7];
8
9$filteredData = array_filter(
10    $data,
11    fn($key) => str_starts_with($key, 'id'),
12    ARRAY_FILTER_USE_KEY
13);
14
15print_r($filteredData);

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

php array_filter keyで配列をフィルタリングする

1<?php
2
3/**
4 * このスクリプトは、PHPの array_filter() 関数と ARRAY_FILTER_USE_KEY 定数を使用して、
5 * 配列のキーに基づいて要素をフィルタリングする方法を示します。
6 */
7
8/**
9 * 配列のキーが特定の条件を満たす要素をフィルタリングする関数。
10 *
11 * @param array $inputArray フィルタリング対象の配列。
12 * @return array フィルタリングされた配列。
13 */
14function filterArrayByKeys(array $inputArray): array
15{
16    echo "元の配列:\n";
17    print_r($inputArray);
18
19    // array_filter() を使用して、キーが「a」で始まる要素のみをフィルタリング
20    // ARRAY_FILTER_USE_KEY を指定することで、コールバック関数にキーが渡されます。
21    $filteredArray = array_filter(
22        $inputArray,
23        function (string $key): bool {
24            return str_starts_with($key, 'a');
25        },
26        ARRAY_FILTER_USE_KEY
27    );
28
29    echo "\nキーが 'a' で始まる要素でフィルタリングされた配列:\n";
30    print_r($filteredArray);
31
32    return $filteredArray;
33}
34
35// サンプル配列
36$data = [
37    'apple' => 10,
38    'banana' => 20,
39    'apricot' => 15,
40    'grape' => 5,
41    'orange' => 25,
42];
43
44// 関数を実行
45filterArrayByKeys($data);
46
47?>

PHPのarray_filter()関数は、配列の要素を特定の条件に基づいてフィルタリングし、条件を満たす要素のみを含む新しい配列を生成する際に利用されます。通常、この関数は配列の「値」に着目してフィルタリングを行いますが、ARRAY_FILTER_USE_KEY定数をarray_filter()関数の第3引数として指定することで、フィルタリングの基準を配列の「キー」に変更することができます。

サンプルコードでは、filterArrayByKeys関数内でarray_filter()を使用し、配列のキーが「a」で始まる要素のみを抽出しています。array_filter()の第2引数に渡されている匿名関数(コールバック関数)には、各要素の「キー」が文字列として渡され、そのキーが「a」で始まるかどうかをstr_starts_with()関数で判定しています。このコールバック関数がキーを受け取るように動作するのは、第3引数にARRAY_FILTER_USE_KEYが指定されているためです。

array_filter()関数は、第1引数にフィルタリング対象の配列、第2引数にフィルタリング条件を定義するコールバック関数、そして第3引数にフィルタリングモード(今回はキーを使用するモード)を受け取ります。そして、条件を満たした要素のみを含む新しい配列を戻り値として返します。ARRAY_FILTER_USE_KEY自体は引数や戻り値を持たない定数ですが、array_filter()関数の動作を制御する重要な役割を担っています。

このサンプルコードでは、array_filter()関数にARRAY_FILTER_USE_KEY定数を指定することで、コールバック関数に配列の「キー」が渡されるようになります。この定数を指定しない場合、コールバックには「値」が渡されるため、意図したフィルタリングが行われません。そのため、キーを基準にフィルタリングする際は、必ずこの定数を第3引数に渡す必要があります。また、コールバック関数の引数は、キーの型に合わせてstring型ヒントなどを適切に指定すると、コードの可読性と堅牢性が向上します。戻り値は、そのキーの要素を残すかどうかの真偽値(trueまたはfalse)を返してください。配列の値も使ってフィルタリングしたい場合は、ARRAY_FILTER_USE_BOTH定数を利用できます。

PHP: array_filterでキーから要素を抽出する

1<?php
2
3/**
4 * 連想配列から、特定の条件を満たすキーを持つ要素のみをフィルタリングします。
5 *
6 * この関数は、array_filter() 関数と ARRAY_FILTER_USE_KEY フラグを組み合わせて、
7 * 配列の「値」ではなく「キー」に基づいて要素を抽出する方法を示します。
8 *
9 * @param array<string, mixed> $data フィルタリングする元の連想配列。
10 * @return array<string, mixed> キーが 'item_' で始まる要素のみを含む新しい配列。
11 */
12function filterItemsByKeyPrefix(array $data): array
13{
14    // array_filter() 関数は、コールバック関数が true を返した要素のみを保持します。
15    // ここでは、第三引数に ARRAY_FILTER_USE_KEY を指定することで、
16    // コールバック関数には配列の「値」ではなく「キー」が渡されるようになります。
17    $filteredData = array_filter(
18        $data,
19        function (string $key): bool {
20            // キーが 'item_' で始まるかどうかをチェックします。
21            // PHP 8 の str_starts_with() 関数を使用しています。
22            return str_starts_with($key, 'item_');
23        },
24        ARRAY_FILTER_USE_KEY // この定数により、コールバック関数に「キー」が渡されます。
25    );
26
27    return $filteredData;
28}
29
30// サンプルデータを作成します。
31$productInfo = [
32    'product_id' => 101,
33    'product_name' => 'Laptop',
34    'item_code' => 'LT101',
35    'item_price' => 1200,
36    'product_category' => 'Electronics',
37    'item_quantity' => 5,
38];
39
40echo "元の配列:\n";
41print_r($productInfo);
42
43// 関数を実行し、キーが 'item_' で始まる要素のみを抽出します。
44$filteredItems = filterItemsByKeyPrefix($productInfo);
45
46echo "\nキーが 'item_' で始まる要素のみを抽出した結果:\n";
47print_r($filteredItems);
48
49?>

このサンプルコードは、PHPのarray_filter()関数とARRAY_FILTER_USE_KEY定数を利用して、連想配列の「キー」に基づいて特定の条件を満たす要素のみを抽出する方法を示しています。

filterItemsByKeyPrefix関数は、フィルタリングしたい元の連想配列を$data引数として受け取ります。関数内ではarray_filter()が使用されており、この関数は配列の各要素を一つずつチェックし、指定されたコールバック関数がtrueを返した要素だけを新しい配列として保持します。通常、array_filter()のコールバック関数には配列の「値」が渡されますが、第三引数にARRAY_FILTER_USE_KEY定数を指定することで、コールバック関数には「キー」が渡されるようになります。

このサンプルにおけるコールバック関数は、渡されたキーが'item_'で始まるかどうかをstr_starts_with()関数(PHP 8から利用できる便利な関数です)を使って判定しています。キーが'item_'で始まる場合にtrueを返し、その結果、該当するキーを持つ要素のみが新しい配列に残されます。

最終的に、filterItemsByKeyPrefix関数は、元の$data配列から、キーが'item_'で始まる要素だけを抽出した新しい連想配列を戻り値として返します。サンプルデータ$productInfoをこの関数で処理することで、'item_code', 'item_price', 'item_quantity'といったキーを持つ情報だけが抽出され、出力結果として表示されることを確認できます。これにより、配列の中から特定の命名規則を持つデータ群を効率的に選別できます。

array_filter関数でキーに基づいてフィルタリングを行う際、第三引数にARRAY_FILTER_USE_KEY定数を指定しなかった場合、コールバック関数には配列の値が渡されてしまい、意図した動作にならない点に注意してください。サンプルコードのstr_starts_with関数はPHP 8で導入されたため、それ以前のPHPバージョンでは利用できません。その場合は、substr関数など他の文字列操作関数で代替する必要があります。ARRAY_FILTER_USE_KEYは、配列のキーのみを条件判定の対象とする場合に使う定数です。コールバック関数の引数は、渡されるキーの型(通常は文字列や整数)に合わせて型ヒントを指定すると、コードの可読性と安全性が向上します。array_filterは元の配列を変更せず、フィルタリングされた新しい配列を返しますので、その点を理解して利用してください。

関連コンテンツ

関連プログラミング言語