array_chunk

配列を分割する

説明

array array_chunk(array $array, int $length, bool $preserve_keys = false)

配列を、要素数が length の配列に分割します。 最後の部分の要素数は length より小さくなることもあります。

パラメータ

array

処理を行う配列。

length

各部分のサイズ。

preserve_keys

true の場合はキーをそのまま保持します。 デフォルトは false で、各部分のキーをあらためて数字で振りなおします。

戻り値

数値添字の多次元配列を返します。添え字はゼロから始まり、 各次元の要素数が length となります。

エラー / 例外

length1 より小さい場合、 ValueError がスローされます。

変更履歴

バージョン 説明
8.0.0 length1 より小さい場合、ValueError がスローされるようになりました。 これより前のバージョンでは、 E_WARNING が発生し、 null を返していました。

例1 array_chunk の例

<?php
$input_array = array('a', 'b', 'c', 'd', 'e');
print_r(array_chunk($input_array, 2));
print_r(array_chunk($input_array, 2, true));
?>

上の例の出力は以下となります。

Array
(
    [0] => Array
        (
            [0] => a
            [1] => b
        )

    [1] => Array
        (
            [0] => c
            [1] => d
        )

    [2] => Array
        (
            [0] => e
        )

)
Array
(
    [0] => Array
        (
            [0] => a
            [1] => b
        )

    [1] => Array
        (
            [2] => c
            [3] => d
        )

    [2] => Array
        (
            [4] => e
        )

)

参考

  • array_slice