array_slice
array$array,
int$offset,
[int|null$length = null],
[bool$preserve_keys = false]
): array
array_slice returns the sequence of elements from the array array as specified by the offset and length parameters.
Parameters
- array
-
The input array.
- offset
-
If offset is non-negative, the sequence will start at that offset in the array.
If offset is negative, the sequence will start that far from the end of the array.
Note:
The offset parameter denotes the position in the array, not the key.
- length
-
If length is given and is positive, then the sequence will have up to that many elements in it.
If the array is shorter than the length, then only the available array elements will be present.
If length is given and is negative then the sequence will stop that many elements from the end of the array.
If it is omitted, then the sequence will have everything from offset up until the end of the array.
- preserve_keys
-
Note:
array_slice will reorder and reset the integer array indices by default. This behaviour can be changed by setting preserve_keys to true. String keys are always preserved, regardless of this parameter.
Return Values
Returns the slice. If the offset is larger than the size of the array, an empty array is returned.