PHP array_splice()関数

PHP Array Reference完全な PHP Array リファレンスマニュアル

例

配列から要素を削除し、新しい要素で置き換えます:

<?php $a1=array("a"=>"red","b"=>"green","c"=>"blue","d"=>"yellow"); $a2=array("a"=>"purple","b"=>"orange"); array_splice($a1,0,2,$a2); print_r($a1); ?>

例を実行 »

定義と使用方法

array_splice() 関数は、配列から選択した要素を削除し、新しい要素で置き換えます。この関数は削除された要素を含む配列も返します。

ヒント:関数が要素を削除しない場合(length=0)、代替配列は start パラメータの位置から挿入されます(例 2 を参照)。

注:代替配列のキー名は保持されません。


構文

array_splice(array1,start,length,array2)

パラメータ 説明
array1 必須。配列を指定します。
start 必須。数値。削除する要素の開始位置を指定します。 0 = 最初の要素。 この値が正の数の場合、配列内でその値が指定するオフセットから削除を開始します。この値が負の数の場合、配列の末尾からその値が指定するオフセットを遡った位置から削除を開始します。 -2 は、配列の末尾から2番目の要素から開始することを意味します。
length オプション。数値。削除する要素の数、および返される配列の長さを指定します。 この値が正の数の場合、その数の要素を削除します。この値が負の数の場合、start から配列の末尾から数えて length までの中間にあるすべての要素を削除します。この値が設定されていない場合、start パラメータで設定された位置から配列の末尾までのすべての要素を削除します。
array2 オプション。元の配列に挿入する要素を持つ配列を指定します。要素が1つだけの場合は、配列ではなく文字列として設定できます。

技術詳細

戻り値: 抽出された要素を含む配列を返します。
PHP バージョン: 4+


その他の例

例 1

このページの前のセクションの例と同じですが、返された配列を出力します:

<?php $a1=array("a"=>"red","b"=>"green","c"=>"blue","d"=>"yellow"); $a2=array("a"=>"purple","b"=>"orange"); print_r(array_splice($a1,0,2,$a2)); ?>

例を実行 »

例 2

length パラメータを 0 に設定した場合:

<?php $a1=array("0"=>"red","1"=>"green"); $a2=array("0"=>"purple","1"=>"orange"); array_splice($a1,1,0,$a2); print_r($a1); ?>

例を実行 »


PHP Array Reference完全な PHP Array リファレンスマニュアル その他の拡張