PHPのarray_slice()：配列の一部を取得する

array_slice($array, $offset, $length)は、位置$offsetから始まる$length個の要素を持つ新しい配列を返します。元の配列は変わりません。$lengthを省くと、末尾まですべてを取り出します。

<?php
$letters = ["a", "b", "c", "d", "e", "f"];

print_r(array_slice($letters, 0, 3)); // first three
print_r(array_slice($letters, 2));    // from position 2 to the end
print_r($letters);                    // unchanged

オフセットはキーではなく位置です（0が最初の要素）。連想配列や、キーが0, 1, 2でない配列ではこの点が重要になります。

負のオフセットで最後のN個の要素を取得する

負のオフセットは末尾から数えます。-1は最後の要素、-3は末尾から3つ目から始まります。負の長さは、末尾からその数だけ手前で止まります。

<?php
$log = ["boot", "login", "upload", "resize", "logout"];

print_r(array_slice($log, -2));     // last two
print_r(array_slice($log, 1, -1));  // drop the first and the last
print_r(array_slice($log, -3, 2));  // two, starting three from the end

存在するより多くの要素を求めてもかまいません。array_slice($log, 0, 100)は5つすべてを返します。

preserve_keysで元のキーを保つ

4つ目の引数にtrueを渡さない限り、整数キーは0から振り直されます。文字列キーは常に保たれます。

<?php
$ranked = [10 => "gold", 20 => "silver", 30 => "bronze", 40 => "fourth"];

print_r(array_slice($ranked, 1, 2));
print_r(array_slice($ranked, 1, 2, true));

$prices = ["tea" => 3, "coffee" => 4, "juice" => 5, "water" => 1];
print_r(array_slice($prices, 1, 2)); // string keys kept anyway

データベースのIDのようにキーに意味があり、あとでそのキーで要素を探す場合はtrueを使います。

array_sliceで配列をページ分けする

1ページに$perPage件ずつ表示するリストの$pageページ目は、1回のスライスで取り出せます。オフセットは($page - 1) * $perPageです。この例はページのリンク付きのHTMLリストを出力します。実行してページ番号をクリックすると、リンクから$_GET['page']がセットされた状態で同じスクリプトがもう一度実行されます。

<?php
$items = [];
for ($i = 1; $i <= 23; $i++) {
    $items[] = "Item $i";
}

$perPage = 5;
$pages = (int) ceil(count($items) / $perPage);
$page = max(1, min($pages, (int) ($_GET['page'] ?? 1)));

$visible = array_slice($items, ($page - 1) * $perPage, $perPage);

echo "<p>Page $page of $pages</p>\n<ul>\n";
foreach ($visible as $item) {
    echo "  <li>$item</li>\n";
}
echo "</ul>\n<p>";
for ($p = 1; $p <= $pages; $p++) {
    echo $p === $page ? " <strong>$p</strong>" : " <a href=\"?page=$p\">$p</a>";
}
echo "</p>\n";

max(1, min($pages, ...))の行は、手で入力された?page=99や?page=-1を有効な範囲に収めます。データベースなら、すべての行を読み込む代わりにLIMITとOFFSETで1ページ分だけを取得しますが、すでにメモリにあるリストならarray_sliceだけで済みます。

array_sliceとarray_spliceの違い

名前は1文字違うだけですが、元の配列に対して正反対のことをします。array_sliceは一部をコピーして取り出します。array_spliceは渡した配列からその部分を切り取り、番号を振り直し、取り除いた要素を返します。切り取った場所に置き換えの要素を挿入することもできます。

<?php
$a = ["mon", "tue", "wed", "thu", "fri"];
$copy = array_slice($a, 1, 2);
echo "slice returned: " . implode(", ", $copy) . "\n";
echo "original now:   " . implode(", ", $a) . "\n\n";

$b = ["mon", "tue", "wed", "thu", "fri"];
$cut = array_splice($b, 1, 2);
echo "splice returned: " . implode(", ", $cut) . "\n";
echo "original now:    " . implode(", ", $b) . "\n\n";

$c = ["mon", "tue", "wed", "thu", "fri"];
array_splice($c, 1, 2, ["TUE", "WED", "extra"]);
echo "replaced: " . implode(", ", $c) . "\n";

要素を削除するほかの方法は、配列から要素を削除するを参照してください。

配列をチャンクに分割する

商品を3つずつの行に並べるときのように、すべてのページを一度に必要とするなら、array_chunkが繰り返しのスライスを代わりにやってくれます。

<?php
$products = ["Lamp", "Desk", "Chair", "Shelf", "Rug", "Mirror", "Clock"];

foreach (array_chunk($products, 3) as $i => $row) {
    echo "Row " . ($i + 1) . ": " . implode(" | ", $row) . "\n";
}

3を2や4に変えて、もう一度実行してみてください。最後のチャンクには残ったものが入ります。