PHPのarray_splice()関数の使い方を解説！配列要素の削除・置換・挿入

PHPのarray_splice()関数は、配列から指定した要素を削除したり、別の要素に置き換えたりするための関数です。この関数は、取り除かれた要素で構成される配列を返します。また、削除する要素数を0にすれば、既存の要素を削除せずに任意の位置へ新しい要素を挿入することも可能です。

構文

array_splice(arr1, begin, len, arr2)

パラメータ

• arr1 − 操作の対象となる配列です。

• begin − 要素の削除を開始する位置を指定します。0は最初の要素を表し、負の数を指定すると配列の末尾から数えた位置になります。例えば-2は、配列の末尾から2番目の要素から処理を開始することを意味します。

• len − 削除する要素の数を指定します。この値は、返される配列の長さにもなります。

• arr2 − 元の配列に挿入する要素を含む配列です。単一の値だけを挿入したい場合は、配列全体を指定する必要はなく、その値だけを渡すこともできます。

戻り値

array_splice()関数は、取り除かれた要素で構成される配列を返します。

使用例

以下は、array_splice()関数の基本的な使用例です。

<?php
$arr1 = array("mac", "windows", "linux");
array_splice($arr1, 2);
print_r($arr1);
?>

出力

Array (
    [0] => mac
    [1] => windows
)

この例では、開始位置として2を指定しているため、インデックス2（3番目の要素）である「linux」以降が削除されます。その結果、$arr1には「mac」と「windows」だけが残ります。

使用例：要素の挿入

次に、要素を削除せずに新しい要素を挿入する例を見てみましょう。

<?php
$arr1 = array("accessories", "tablet", "laptop", "mobile");
array_splice($arr1, 3, 0, "desktop");
print_r($arr1);
?>

出力

Array (
    [0] => accessories
    [1] => tablet
    [2] => laptop
    [3] => desktop
    [4] => mobile
)

この例では、削除する要素数（len）に0を指定しているため、既存の要素は一切削除されません。代わりに、位置3（4番目）に「desktop」が挿入され、それ以降の要素は後ろにシフトされます。このようにarray_splice()関数を使えば、配列の任意の位置への要素追加も簡単に行えます。