array_slice — Extract a slice of the array

array_slice

(PHP 4, PHP 5)

array_slice — Extract a slice of the array

Description ¶

array array_slice ( array $array , int $offset [, int $length = NULL [, bool $preserve_keys = false ]] )

array_slice() returns the sequence of elements from the array array as specified by the offset and lengthparameters.

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.

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 that array_slice() will reorder and reset the numeric array indices by default. You can change this behaviour by setting preserve_keys to TRUE.

Return Values ¶

Returns the slice.

Changelog ¶

Version	Description
5.2.4	The default value of the length parameter was changed to NULL. A NULL length now tells the function to use the length of array. Prior to this version, a NULL length was taken to mean a zero length (nothing will be returned).
5.0.2	The optional preserve_keys parameter was added.

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 keysprint_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
)

See Also ¶

• array_splice() - Remove a portion of the array and replace it with something else
• unset() - Unset a given variable
• array_chunk() - Split an array into chunks

 add a note

User Contributed Notes 42 notes

up

down

16

taylorbarstow at the google mail service ¶

9 years ago

Array slice function that works with associative arrays (keys):

function array_slice_assoc($array,$keys) {
    return array_intersect_key($array,array_flip($keys));
}

up

down

5

robert dot johnson at icap dot com ¶

10 months ago

array_slice() seems to work on associative arrays and preserves the keys.  I just ran this test on PHP 5.5:

<?php
$test = array(
    'a'=>'hello 1',
    'r'=>'hello 2',
    'h'=>'hello 3',
    'w'=>'hello 4',
    't'=>'hello 5',
    'n'=>'hello 6',
    'k'=>'hello 7',
    'b'=>'hello 8');print_r( array_slice($test,2,5) );?>
Output:
Array
(
    [h] => hello 3
    [w] => hello 4
    [t] => hello 5
    [n] => hello 6
    [k] => hello 7
)http://php.net/manual/en/function.array-slice.php