array_spliceRemove a portion of the array and replace it with something else
&reftitle.description;
arrayarray_splicearrayinputintoffsetintlengthcount($input)mixedreplacementarray()
Removes the elements designated by offset and
length from the input array,
and replaces them with the elements of the
replacement array, if supplied.
Numerical keys in input are not preserved.
If replacement is not an array, it will be
typecast
to one (i.e. (array) $replacement). This may result in unexpected
behavior when using an object or &null; replacement.
&reftitle.parameters;
input
The input array.
offset
If offset is positive then the start of the
removed portion is at that offset from the beginning of the
input array.
If offset is negative then the start of the
removed portion is at that offset from the end of the
input array.
length
If length is omitted, removes everything
from offset to the end of the array.
If length is specified and is positive,
then that many elements will be removed.
If length is specified and is negative,
then the end of the removed portion will be that many elements
from the end of the array.
If length is specified and is zero,
no elements will be removed.
To remove everything from offset to the end of
the array when replacement is also specified,
use count($input) for length.
replacement
If replacement array is specified, then the
removed elements are replaced with elements from this array.
If offset and length
are such that nothing is removed, then the elements from the
replacement array are inserted in the place
specified by the offset.
Keys in the replacement array are not preserved.
If replacement is just one element it is
not necessary to put array() or square brackets
around it, unless the element is an array itself, an object or &null;.
&reftitle.returnvalues;
Returns an array consisting of the extracted elements.
&reftitle.examples;
<function>array_splice</function> examples
]]>
&example.outputs;
string(3) "red"
[1]=>
string(5) "green"
}
array(2) {
[0]=>
string(3) "red"
[1]=>
string(6) "yellow"
}
array(2) {
[0]=>
string(3) "red"
[1]=>
string(6) "orange"
}
array(5) {
[0]=>
string(3) "red"
[1]=>
string(5) "green"
[2]=>
string(4) "blue"
[3]=>
string(5) "black"
[4]=>
string(6) "maroon"
}
]]>
Equivalent statements to various <function>array_splice</function> examples
The following statements are equivalent:
]]>
&reftitle.seealso;
array_mergearray_sliceunset