array_search
Searches the array for a given value and returns the first corresponding key if successful
Description
intstringfalse array_search(mixed $needle, array $haystack, bool $strict = false)
Parameters
-
needle
-
The searched value.
Note:
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
filter_value parameter instead.
WarningThis 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.
Examples
Example #1 array_search example
<?php
$array = array(0 => 'blue', 1 => 'red', 2 => 'green', 3 => 'red');
$key = array_search('green', $array); // $key = 2;
$key = array_search('red', $array); // $key = 1;
?>
See Also
- array_keys
- array_values
- array_key_exists
- in_array