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

Copy
1<?php
2
3/**
4 * 指定された配列を一定の長さのチャンクに分割し、
5 * 各チャンクをforeachループで処理して出力する例です。
6 *
7 * array_chunk関数は、配列を複数の小さな配列（チャンク）に分割します。
8 * この例では、元の配列を3つの要素からなるチャンクに分割し、
9 * それらのチャンクをforeachループで一つずつ取り出して表示します。
10 */
11function demonstrateArrayChunkWithForeach(): void
12{
13    // 処理対象となる元の配列を準備します。
14    $originalArray = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
15    echo "元の配列:\n";
16    print_r($originalArray);
17
18    // array_chunk関数を使って配列を3つの要素からなるチャンクに分割します。
19    // 第2引数: チャンクの長さ
20    // 第3引数: preserve_keys (オプション、デフォルトはfalse)。
21    //          falseの場合、各チャンクのキーは0から再割り当てされます。
22    $chunkedArrays = array_chunk($originalArray, 3);
23
24    echo "\narray_chunkで分割された配列 (各チャンク3要素、キーは0から再割り当て):\n";
25    print_r($chunkedArrays);
26
27    // 分割されたチャンクをforeachループで一つずつ取り出して処理します。
28    echo "\n--- 各チャンクの内容 ---\n";
29    foreach ($chunkedArrays as $index => $chunk) {
30        echo "チャンク " . ($index + 1) . ": ";
31        print_r($chunk);
32        // 必要であれば、各チャンク内の要素をさらにループで処理することも可能です。
33        // foreach ($chunk as $item) {
34        //     echo "  要素: " . $item . "\n";
35        // }
36    }
37}
38
39// 関数を実行して、array_chunkとforeachの動作を確認します。
40demonstrateArrayChunkWithForeach();
41
42?>

PHPのarray_chunk関数は、指定された配列を一定の長さに区切って複数の小さな配列（チャンク）に分割するための関数です。これは、大きなデータを扱いやすい塊に分ける際などに非常に役立ちます。

この関数は、分割したい元の配列を第一引数$arrayに、各チャンクの要素数を第二引数$lengthに指定します。第三引数$preserve_keysはオプションで、デフォルトはfalseです。falseの場合、分割された各チャンク内のキーは0から再割り当てされますが、trueを指定すると元の配列のキーが保持されます。戻り値は、分割されたチャンクを含む多次元配列です。

提供されたサンプルコードでは、[1, 2, ..., 10]という元の配列をarray_chunk関数で3要素ずつのチャンクに分割しています。$preserve_keysは指定されていないためデフォルトのfalseが適用され、各チャンクのキーは0から振られます。分割された結果の多次元配列は、その後のforeachループを使って一つずつ取り出され、その内容が表示されています。このようにarray_chunkとforeachを組み合わせることで、分割されたデータを順番に処理していくことが容易になります。この機能は、データのページネーションや、特定の要素数ごとにまとめて処理を行いたい場合に特に便利です。

Copy
1<?php
2
3/**
4 * array_chunk() を連想配列で使用する例を示す関数
5 *
6 * この関数は、第3引数 $preserve_keys の違いによる動作の差を明確にします。
7 */
8function associativeArrayChunkExample(): void
9{
10    // ユーザーIDをキーとする連想配列を用意します
11    $users = [
12        'user_a' => ['name' => 'Alice', 'age' => 25],
13        'user_b' => ['name' => 'Bob', 'age' => 30],
14        'user_c' => ['name' => 'Charlie', 'age' => 22],
15        'user_d' => ['name' => 'David', 'age' => 35],
16        'user_e' => ['name' => 'Eve', 'age' => 28],
17    ];
18
19    echo "■ 元の連想配列:\n";
20    print_r($users);
21    echo "\n";
22
23    // --- ケース1: preserve_keys = false (デフォルト) ---
24    // 第3引数を省略するか false を指定すると、元のキー ('user_a' など) は破棄され、
25    // チャンク内のキーは 0 から始まる数値インデックスに振り直されます。
26    echo "■ array_chunk(\$users, 2, false) の結果 (キーは保持されない):\n";
27    $chunkedWithoutKeys = array_chunk($users, 2, false);
28    print_r($chunkedWithoutKeys);
29    echo "\n";
30
31    // --- ケース2: preserve_keys = true ---
32    // 第3引数に true を指定すると、元の連想配列のキーが保持されます。
33    echo "■ array_chunk(\$users, 2, true) の結果 (キーが保持される):\n";
34    $chunkedWithKeys = array_chunk($users, 2, true);
35    print_r($chunkedWithKeys);
36}
37
38// 関数を実行して結果を表示します
39associativeArrayChunkExample();
40

array_chunk()関数は、指定した配列を、より小さな配列のかたまり（チャンク）に分割するための関数です。戻り値として、分割されたチャンクを要素に持つ多次元配列を返します。

第1引数 $array には分割したい配列を、第2引数 $length には分割後のかたまり一つあたりに含める要素の数を整数で指定します。

特に連想配列を扱う際に重要となるのが、オプションの第3引数 $preserve_keys です。この引数で、元の配列のキーを保持するかどうかを真偽値（trueまたはfalse）で制御します。デフォルトはfalseです。

サンプルコードでは、ユーザー情報を格納した連想配列を2つの要素ずつに分割しています。第3引数をfalseに設定するか省略した場合、元のキー（例: 'user_a'）は破棄され、各チャンク内の要素には0から始まる数値のキーが新たに割り振られます。一方、第3引数にtrueを指定すると、元の連想配列のキーがそのまま保持された状態で配列が分割されます。このように、キーと値の関連性を保ったまま配列を分割したい場合に、この設定が役立ちます。