If
needle
is a string, the comparison is done in a case-sensitive manner.
haystack
The array.
strict
If the third parameter
strict
is set to
true
then the
array_search()
function will search for
identical
elements in the
haystack
. This means it will also perform a strict type comparison of the
needle
in the
haystack
, and objects must be the same instance.
Return Values
Returns the key for
needle
if it is found in the array,
false
otherwise.
If
needle
is found in
haystack
more than once, the first matching key is returned. To return the keys for all matching values, use
array_keys()
with the optional
search_value
parameter instead.
Warning
This function may return Boolean
false
, but may also return a non-Boolean value which evaluates to
false
. Please read the section on Booleans for more information. Use the === operator for testing the return value of this function.
array_shift
—
Shift an element off the beginning of array
Description
array_shift(array&$array):mixed
array_shift()
shifts the first value of the
array
off and returns it, shortening the
array
by one element and moving everything down. All numerical array keys will be modified to start counting from zero while literal keys won't be affected.
Note
:
This function will
reset()
the
array
pointer of the input array after use.
Parameters
array
The input array.
Return Values
Returns the shifted value, or
null
if
array
is empty or is not an 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.
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
)
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.
Tip
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.
Example #2 Equivalent statements to various
array_splice()
examples
The following statements are equivalent:
<?php// append two elements to $inputarray_push($input,$x,$y);array_splice($input,count($input),0,array($x,$y));// remove the last element of $inputarray_pop($input);array_splice($input,-1);// remove the first element of $inputarray_shift($input);array_splice($input,0,1);// insert an element at the start of $inputarray_unshift($input,$x,$y);array_splice($input,0,0,array($x,$y));// replace the value in $input at index $x$input[$x]=$y;// for arrays where key equals offsetarray_splice($input,$x,1,$y);?>