array_splice

Remove a portion of the array and replace it with something else

Syntax

array_splice ( array &$input , int $offset [, int $length = count($input) [, mixed $replacement = array() ]] ) : array

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, everything is removed from offset to the end of the array.

If length is positive, then that many elements will be removed.

If length is negative, then the end of the removed portion will be that many elements from the end of the array.

If length is zero, no elements will be removed.

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.

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.

Note: Keys in the replacement array are not preserved.

Return

Returns an array consisting of the extracted elements.

Examples

1 · input offset · Negative

<?

$input = array("a", "b", "c", "d", "e");
$offset = -1;

$return = array_splice($input, $offset);

print_r($return);

?>
Array
(
    [0] => e
)

2 · input offset · Positive

<?

$input = array("a", "b", "c", "d", "e");
$offset = 1;

$return = array_splice($input, $offset);

print_r($return);

?>
Array
(
    [0] => b
    [1] => c
    [2] => d
    [3] => e
)

3 · length · Negative

<?

$input = array("a", "b", "c", "d", "e");
$offset = 0;
$length = -1;

$return = array_splice($input, $offset, $length);

print_r($return);

?>
Array
(
    [0] => a
    [1] => b
    [2] => c
    [3] => d
)

4 · length · Zero

<?

$input = array("a", "b", "c", "d", "e");
$offset = 0;
$length = 0;

$return = array_splice($input, $offset, $length);

print_r($return);

?>
Array
(
)

5 · length · Positive

<?

$input = array("a", "b", "c", "d", "e");
$offset = 0;
$length = 1;

$return = array_splice($input, $offset, $length);

print_r($return);

?>
Array
(
    [0] => a
)

6 · replacement

<?

$input = array("a", "b", "c", "d", "e");
$offset = 0;
$length = 1;
$replacement = array("f", "g");

$return = array_splice($input, $offset, $length, $replacement);

print_r($return);
print_r($input);

?>
Array
(
    [0] => a
)
Array
(
    [0] => f
    [1] => g
    [2] => b
    [3] => c
    [4] => d
    [5] => e
)

array_chunk

array_slice

array

array_change_key_case

array_chunk

array_column

array_combine

array_count_values

array_diff

array_diff_assoc

array_diff_key

array_diff_uassoc

array_diff_ukey

array_fill

array_fill_keys

array_filter

array_flip

array_intersect

array_intersect_assoc

array_intersect_key

array_intersect_uassoc

array_intersect_ukey

array_key_exists

array_key_first

array_key_last

array_keys

array_map

array_merge

array_merge_recursive

array_multisort

array_pad

array_pop

array_product

array_push

array_rand

array_reduce

array_replace

array_replace_recursive

array_reverse

array_search

array_shift

array_slice

array_sum

array_udiff

array_udiff_assoc

array_udiff_uassoc

array_uintersect

array_uintersect_assoc

array_uintersect_uassoc

array_unique

array_unshift

array_values

array_walk

array_walk_recursive

arsort

asort

compact

count

current

end

extract

in_array

key

key_exists

krsort

ksort

list

natcasesort

natsort

next

pos

prev

range

reset

rsort

shuffle

sizeof

sort

uasort

uksort

usort

PHP

Home Menu