【PHP8.x】array_filter()関数の使い方

Copy
1<?php
2
3/**
4 * array_filter 関数を使用して、配列のキーに基づいて要素をフィルタリングするサンプルコードです。
5 * `ARRAY_FILTER_USE_KEY` モードを使用することで、コールバック関数にキーが渡されます。
6 */
7
8// フィルタリング対象となる連想配列を定義します。
9$data = [
10    'user_id' => 1,
11    'user_name' => 'Alice',
12    'email' => 'alice@example.com',
13    'address' => 'Tokyo',
14    'role_id' => 10,
15    'created_at' => '2023-01-01',
16];
17
18echo "元の配列:\n";
19print_r($data);
20
21// array_filter を使用して、キーが 'user_' で始まる要素のみを抽出します。
22// 第三引数に `ARRAY_FILTER_USE_KEY` を指定すると、コールバック関数には配列のキーが渡されます。
23$filteredData = array_filter(
24    $data,
25    function (string $key): bool {
26        // キーが 'user_' で始まるかどうかをチェックします。
27        return str_starts_with($key, 'user_');
28    },
29    ARRAY_FILTER_USE_KEY // この定数を指定することで、コールバック関数にキーが渡されます。
30);
31
32echo "\nキーが 'user_' で始まる要素でフィルタリングした配列:\n";
33print_r($filteredData);
34
35?>

PHPのarray_filter関数は、配列の要素を特定の条件に基づいてフィルタリングし、新しい配列を生成するために使用される便利な関数です。第一引数にはフィルタリングしたい元の配列を、第二引数にはフィルタリングの条件を定義するコールバック関数を指定します。このコールバック関数がtrueを返した要素のみが結果の配列に含まれ、戻り値として新しい配列が返されます。

特に注目すべきは第三引数の$modeです。通常、コールバック関数には配列の「値」が渡されますが、ここにARRAY_FILTER_USE_KEY定数を指定すると、コールバック関数には「キー」が渡されるようになります。これにより、キーに基づいたフィルタリングが可能になります。また、ARRAY_FILTER_USE_BOTHを指定すると、キーと値の両方がコールバック関数に渡されます。

サンプルコードでは、このARRAY_FILTER_USE_KEYモードを活用しています。$dataという連想配列から、キーが'user_'で始まる要素のみを抽出する例です。コールバック関数は、渡されたキーが'user_'で始まるかどうかをstr_starts_with関数で判定し、条件に合致する場合にtrueを返します。その結果、元の配列からキーに基づいて選択された要素のみが$filteredDataとして新しい配列に格納され、元の配列は変更されません。この機能は、特定の命名規則を持つデータの一部を抽出したい場合などに非常に役立ちます。

Copy
1<?php
2
3/**
4 * array_filter 関数を使ったサンプルコード
5 *
6 * 配列から指定した条件に合致する要素のみを抽出します。
7 * 'use' キーワードを使って、クロージャ内で外部変数を参照する方法も示します。
8 */
9
10// フィルタリング対象の配列
11$data = [
12    'a' => 1,
13    'b' => 2,
14    'c' => 3,
15    'd' => 4,
16    'e' => 5,
17];
18
19// 閾値
20$threshold = 3;
21
22// コールバック関数（クロージャ）: 閾値を超える要素のみを抽出
23$filtered_data = array_filter(
24    $data,
25    function ($value) use ($threshold) {
26        // $value が $threshold より大きい場合に true を返す
27        return $value > $threshold;
28    }
29);
30
31// 結果の表示
32print_r($filtered_data);
33
34// array_filter の第3引数を使って、キーをコールバック関数に渡す例
35$keys = ['a', 'b'];
36
37$filtered_data_with_keys = array_filter(
38    $data,
39    function ($value, $key) use ($keys) {
40        // キーが $keys に含まれているかチェック
41        return in_array($key, $keys);
42    },
43    ARRAY_FILTER_USE_KEY
44);
45
46print_r($filtered_data_with_keys);
47
48// array_filter の第3引数を使って、キーと値をコールバック関数に渡す例
49$filtered_data_with_both = array_filter(
50    $data,
51    function ($value, $key) {
52        // 値が偶数かつキーがアルファベット順で若いものだけ抽出
53        return ($value % 2 == 0) && ($key < 'd');
54    },
55    ARRAY_FILTER_USE_BOTH
56);
57
58print_r($filtered_data_with_both);

array_filter関数は、配列の要素をコールバック関数でフィルタリングし、条件に合致する要素のみを含む新しい配列を返します。第一引数にはフィルタリング対象の配列 $array を指定します。第二引数には、各要素に対して実行されるコールバック関数 $callback を指定します。コールバック関数は、要素を保持する場合は true、破棄する場合は false を返す必要があります。$callback が null の場合、$array のうち false と評価される要素がすべて削除されます。

この例では、まず $data 配列から、$threshold の値（ここでは3）より大きい要素のみを抽出しています。use ($threshold) は、クロージャ（無名関数）内で外部変数の $threshold を参照するために使用します。

次に、array_filter の第3引数に ARRAY_FILTER_USE_KEY を指定することで、コールバック関数にキーを渡すことができます。この例では、キーが $keys 配列に含まれている要素のみを抽出しています。in_array() 関数は、配列に特定の値が含まれているかどうかを確認するために使用されます。

さらに、array_filter の第3引数に ARRAY_FILTER_USE_BOTH を指定することで、コールバック関数にキーと値の両方を渡すことができます。この例では、値が偶数で、かつキーが d よりアルファベット順で前の要素のみを抽出しています。

戻り値は、フィルタリングされた新しい配列です。元の配列 $array は変更されません。array_filter は、配列から特定の条件を満たす要素を効率的に抽出する際に役立ちます。

Copy
1<?php
2
3/**
4 * 複数条件で配列をフィルタリングするサンプルコード
5 *
6 * array_filter関数を使用して、配列の要素が複数の条件を満たすかどうかを判定し、
7 * 条件に合致する要素のみを抽出します。
8 */
9
10// フィルタリング対象となるユーザーデータの配列
11$users = [
12    ['name' => 'Alice', 'age' => 25, 'city' => 'New York'],
13    ['name' => 'Bob', 'age' => 30, 'city' => 'Tokyo'],
14    ['name' => 'Charlie', 'age' => 20, 'city' => 'New York'],
15    ['name' => 'David', 'age' => 35, 'city' => 'London'],
16    ['name' => 'Eve', 'age' => 28, 'city' => 'Tokyo'],
17];
18
19/**
20 * 複数の条件に基づいてユーザー配列をフィルタリングします。
21 *
22 * @param array $usersArray フィルタリング対象のユーザー配列。
23 * @return array 複数条件に合致したユーザーのみを含む新しい配列。
24 */
25function filterUsersByMultipleConditions(array $usersArray): array
26{
27    // array_filter関数を使用し、コールバック関数で複数の条件を指定
28    // コールバック関数は各ユーザー配列を受け取り、条件に合致すればtrueを返します。
29    $filteredUsers = array_filter($usersArray, function (array $user): bool {
30        // 条件1: 年齢が25歳以上であること
31        $condition1 = ($user['age'] >= 25);
32
33        // 条件2: 居住地が「Tokyo」であること
34        $condition2 = ($user['city'] === 'Tokyo');
35
36        // 両方の条件 (AND条件) を満たす場合にのみtrueを返します
37        return $condition1 && $condition2;
38    });
39
40    return $filteredUsers;
41}
42
43// 関数を呼び出してフィルタリングを実行
44$filteredUsersResult = filterUsersByMultipleConditions($users);
45
46// フィルタリング結果の出力
47echo "元のユーザーデータ:\n";
48print_r($users);
49
50echo "\nフィルタリングされたユーザーデータ (年齢 >= 25 かつ 居住地 == 'Tokyo'):\n";
51print_r($filteredUsersResult);
52
53?>

PHPのarray_filter関数は、配列の中から特定の条件を満たす要素だけを抽出する際に利用する機能です。この関数は、引数としてフィルタリング対象の配列、そして各要素を評価するためのコールバック関数を受け取ります。コールバック関数は配列の各要素に対して実行され、条件に合致した場合はtrueを、合致しない場合はfalseを返します。その結果、trueを返した要素のみが新しい配列として戻り値で返されます。

サンプルコードでは、ユーザーデータの配列を対象に「年齢が25歳以上」かつ「居住地が'Tokyo'」という複数の条件でフィルタリングしています。array_filterに渡される匿名関数（コールバック関数）の中で、$user['age'] >= 25と$user['city'] === 'Tokyo'という二つの条件を論理AND演算子&&で結合しています。これにより、両方の条件を満たすユーザーのみが抽出され、$filteredUsersResultに格納されます。このように、array_filterとコールバック関数を組み合わせることで、複雑な絞り込み条件も簡潔に記述できるため、データ処理の効率を高めることができます。

Copy
1<?php
2
3/**
4 * 連想配列から特定の条件に合致する要素を抽出するサンプル
5 */
6function filterAssociativeArray(array $data, callable $callback): array
7{
8    // array_filter関数を使って、指定されたコールバック関数に基づいて配列をフィルタリング
9    $filteredArray = array_filter($data, $callback, ARRAY_FILTER_USE_BOTH);
10
11    return $filteredArray;
12}
13
14// サンプルの連想配列
15$data = [
16    'apple' => 5,
17    'banana' => 10,
18    'orange' => 3,
19    'grape' => 8,
20];
21
22// 値が5より大きい要素のみを抽出するコールバック関数
23$callback = function ($value, $key) {
24    return $value > 5;
25};
26
27// フィルタリングを実行
28$filteredData = filterAssociativeArray($data, $callback);
29
30// 結果を出力
31print_r($filteredData);
32
33?>

このサンプルコードは、PHPのarray_filter関数を使って、連想配列から特定の条件を満たす要素を抽出する方法を示しています。array_filter関数は、第一引数にフィルタリング対象の配列、第二引数にコールバック関数を受け取ります。コールバック関数は、配列の各要素に対して実行され、trueを返した要素のみが結果の配列に含まれます。第三引数 $mode は、コールバック関数に渡す引数を制御します。サンプルでは ARRAY_FILTER_USE_BOTH を指定しており、コールバック関数にキーと値の両方が渡されます。

filterAssociativeArray関数は、連想配列 $data とコールバック関数 $callback を引数に取り、array_filter関数を使ってフィルタリングされた配列を返します。サンプルでは、値が5より大きい要素のみを抽出するコールバック関数を定義し、filterAssociativeArray関数に渡しています。

array_filter関数は、元の配列のキーを保持したまま新しい配列を生成します。コールバック関数が null の場合、配列の要素が (bool) $value == false と評価される要素が削除されます。このサンプルコードを通じて、array_filter関数とコールバック関数を組み合わせることで、連想配列から必要な要素を効率的に抽出できることを理解できます。初心者のシステムエンジニアにとって、データの加工処理を理解する上で役立つでしょう。