array_splice

PHP 4, PHP 5, PHP 7, PHP 8
array_splice - Remove a portion of the array and replace it with something else

array_splice(
     arrayarray,
     int$offset,
     [int|null$length = null],
     [mixed$replacement = []]
): array

Removes the elements designated by offset and length from the array array, and replaces them with the elements of the replacement array, if supplied.

Note:

Numerical keys in array are not preserved.

Note:

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.

Parameters

array

The input array.

offset

If offset is positive then the start of the removed portion is at that offset from the beginning of the array array.

If offset is negative then the start of the removed portion is at that offset from the end of the array 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.

Note:

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.

Return Values

Returns an array consisting of the extracted elements.

Changelog

Version Description
8.0.0 length is nullable now.

Related Functions

Example of array_splice

Show all examples for array_splice

PHP Version: