array_slice
(PHP 4, PHP 5, PHP 7, PHP 8)
array_slice — Extract a slice of the array
Description
array
$array,int
$offset,?int
$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
offsetis non-negative, the sequence will start at that offset in thearray.If
offsetis negative, the sequence will start that far from the end of thearray.Note:
The
offsetparameter denotes the position in the array, not the key. -
length -
If
lengthis 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
lengthis 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
offsetup until the end of thearray. -
preserve_keys -
Note:
array_slice() will reorder and reset the integer array indices by default. This behaviour can be changed by setting
preserve_keystotrue. 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.
Examples
Example #1 array_slice() examples
<?php
$input = array("a", "b", "c", "d", "e");
$output = array_slice($input, 2); // returns "c", "d", and "e"
$output = array_slice($input, -2, 1); // returns "d"
$output = array_slice($input, 0, 3); // returns "a", "b", and "c"
// note the differences in the array keys
print_r(array_slice($input, 2, -1));
print_r(array_slice($input, 2, -1, true));
?>
The above example will output:
Array
(
[0] => c
[1] => d
)
Array
(
[2] => c
[3] => d
)
Example #2 array_slice() and one-based array
<?php
$input = array(1 => "a", "b", "c", "d", "e");
print_r(array_slice($input, 1, 2));
?>
The above example will output:
Array
(
[0] => b
[1] => c
)
Example #3 array_slice() and array with mixed keys
<?php
$ar = array('a'=>'apple', 'b'=>'banana', '42'=>'pear', 'd'=>'orange');
print_r(array_slice($ar, 0, 3));
print_r(array_slice($ar, 0, 3, true));
?>
The above example will output:
Array
(
[a] => apple
[b] => banana
[0] => pear
)
Array
(
[a] => apple
[b] => banana
[42] => pear
)
See Also
- array_chunk() - Split an array into chunks
- array_splice() - Remove a portion of the array and replace it with something else
- unset() - Unset a given variable
