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

Copy
1<?php
2
3/**
4 * array_filter 関数で ARRAY_FILTER_USE_BOTH モードを使用して、
5 * 配列の要素とキーの両方に基づいた条件でフィルタリングする例です。
6 *
7 * @param array<int|string, string> $data フィルタリングする入力配列。
8 * @return array<int|string, string> フィルタリングされた新しい配列。
9 */
10function filterArrayWithBoth(array $data): array
11{
12    // array_filter を使用して配列をフィルタリングします。
13    // 第3引数に ARRAY_FILTER_USE_BOTH を指定することで、
14    // コールバック関数 ($value, $key) に値とキーの両方が渡されます。
15    $filteredArray = array_filter(
16        $data,
17        function (string $value, int|string $key): bool {
18            // ここで値 ($value) とキー ($key) の両方を使ってフィルタリング条件を記述します。
19            // 例: 値の長さが4文字以上で、かつキーが偶数の場合のみ抽出します。
20            return (strlen($value) >= 4) && (is_int($key) ? ($key % 2 === 0) : true);
21        },
22        ARRAY_FILTER_USE_BOTH // コールバック関数に要素の値とキーの両方を渡すモード
23    );
24
25    return $filteredArray;
26}
27
28// サンプルデータの準備
29$myArray = [
30    0 => 'apple',
31    1 => 'ban',
32    2 => 'grape',
33    3 => 'kiwi',
34    4 => 'orange',
35    5 => 'melon',
36    'fruit_a' => 'strawberry',
37    'fruit_b' => 'fig',
38];
39
40// 関数を呼び出して結果を表示します
41echo "元の配列:\n";
42print_r($myArray);
43
44$result = filterArrayWithBoth($myArray);
45
46echo "\nフィルタリングされた配列 (値の長さが4文字以上 かつ キーが偶数):\n";
47print_r($result);
48
49/*
50上記の例では、以下の要素が抽出されます:
51- 'apple' (キー0): 長さ5 >= 4, キー0 % 2 === 0
52- 'grape' (キー2): 長さ5 >= 4, キー2 % 2 === 0
53- 'orange' (キー4): 長さ6 >= 4, キー4 % 2 === 0
54- 'strawberry' (キー'fruit_a'): 長さ10 >= 4, キーが整数ではないためtrue
55*/

PHPのARRAY_FILTER_USE_BOTHは、配列をフィルタリングするarray_filter関数と組み合わせて使用する定数です。この定数をarray_filter関数の第三引数に指定することで、フィルタリングの条件を定義するコールバック関数に、配列の「要素の値」と「その要素のキー」の両方を渡すことが可能になります。これにより、配列のフィルタリング時に、値だけでなくキーの情報も利用した、より詳細な条件を記述することが可能になります。

提供されたサンプルコードでは、filterArrayWithBothという関数が定義されています。この関数は、引数として受け取った入力配列（$data）をarray_filter関数で処理し、条件に合致する要素のみを含む新しい配列を戻り値として返します。array_filter関数の第三引数にARRAY_FILTER_USE_BOTHが指定されているため、第二引数のコールバック関数には、各要素の値が$valueとして、そのキーが$keyとして渡されます。このコールバック関数内では、「要素の値の長さが4文字以上である」という条件と、「キーが偶数である（整数キーの場合）」という二つの条件を組み合わせてフィルタリングを行っています。このように、ARRAY_FILTER_USE_BOTHを利用することで、配列の要素とキーの両方に基づいた柔軟な条件設定が可能となり、複雑なデータ処理を効率的に行えます。

Copy
1<?php
2
3/**
4 * array_filter()関数とARRAY_FILTER_USE_BOTH定数を使用して、
5 * 配列の要素を値とキーの両方に基づいてフィルタリングする例です。
6 *
7 * ARRAY_FILTER_USE_BOTH定数は、array_filter()のコールバック関数が
8 * 要素の値とキーの両方を引数として受け取るように指定します。
9 */
10function filterArrayByValueAndKey(): void
11{
12    // サンプルとして、キーと値を持つ配列を準備します。
13    $data = [
14        'item_a' => 10,
15        'item_b' => 25,
16        'test_c' => 30,
17        'item_d' => 45,
18        'test_e' => 50,
19    ];
20
21    echo "元の配列:\n";
22    print_r($data);
23
24    // array_filter() を使用して、要素を値とキーの両方でフィルタリングします。
25    // 条件: 値が20より大きく、かつキーが 'item_' で始まる要素を抽出します。
26    $filteredData = array_filter(
27        $data,
28        function (int $value, string $key): bool {
29            // 値が20より大きい、かつキーが 'item_' で始まる場合にtrueを返します。
30            return $value > 20 && str_starts_with($key, 'item_');
31        },
32        ARRAY_FILTER_USE_BOTH // この定数により、コールバック関数は ($value, $key) の順で引数を受け取ります。
33    );
34
35    echo "\nフィルタリング後の配列 (値が20より大きく、かつキーが 'item_' で始まる):\n";
36    print_r($filteredData);
37
38    // 出力例:
39    // 元の配列:
40    // Array
41    // (
42    //     [item_a] => 10
43    //     [item_b] => 25
44    //     [test_c] => 30
45    //     [item_d] => 45
46    //     [test_e] => 50
47    // )
48    //
49    // フィルタリング後の配列 (値が20より大きく、かつキーが 'item_' で始まる):
50    // Array
51    // (
52    //     [item_b] => 25
53    //     [item_d] => 45
54    // )
55}
56
57// 関数を実行して、動作を確認します。
58filterArrayByValueAndKey();

PHPのARRAY_FILTER_USE_BOTHは、配列の要素をフィルタリングするarray_filter()関数と組み合わせて使用される組み込み定数です。この定数を利用することで、array_filter()に渡すコールバック関数が、配列の要素の「値」と「キー」の両方を引数として受け取れるようになります。これにより、値とキーの両方の条件に基づいて、より柔軟なフィルタリングが可能となります。

array_filter()関数は、指定された配列の各要素に対してコールバック関数を実行し、そのコールバック関数がtrueを返した要素のみを集めて新しい配列として返します。通常、コールバック関数は要素の値のみを引数として受け取りますが、array_filter()の第三引数にARRAY_FILTER_USE_BOTHを指定すると、コールバック関数は「要素の値」と「そのキー」の順で引数を受け取ります。コールバック関数の戻り値は常に真偽値（bool）で、trueを返せばその要素が残され、falseであれば除外されます。

サンプルコードでは、filterArrayByValueAndKey()関数内で、$dataという連想配列を定義し、array_filter()を用いてフィルタリングを行っています。第三引数にARRAY_FILTER_USE_BOTHを指定することで、コールバック関数は$value（要素の値）と$key（要素のキー）の両方を受け取っています。ここでは、「値が20より大きく、かつキーが'item_'で始まる」という条件が設定されており、この条件を満たす'item_b' => 25と'item_d' => 45のみが抽出された新しい配列$filteredDataが生成されます。このように、この定数を使うことで、値とキーを組み合わせた複雑な条件での配列操作が簡単に行えるようになります。