Using PHP's array_search() Function: Syntax, Examples, and Tips

PHP is a widely used scripting language for web development, offering a powerful function library; among them, the array_search() function allows searching for a given value within an array and returns its corresponding key.

The basic syntax is array_search($needle, $haystack, $strict = false) , where $needle is the value to search, $haystack is the array, and $strict toggles strict type comparison.

Basic Usage

To find the position of 'orange' in a simple array, you can use:

$arr = array('apple', 'banana', 'orange', 'grape');
$index = array_search('orange', $arr);
echo $index; // outputs 2

Note that array indices start at 0.

Strict Mode

When strict mode is enabled, PHP also compares element types. Searching for the integer 1 in $arr = array(1, 2, '1', '2'); with $strict = true returns the index of the element that matches both value and type.

$index = array_search(1, $arr, true);
echo $index; // outputs 0

Multidimensional Arrays

The function can search within a specific sub‑array of a multidimensional array. For example, to locate 'orange' inside the 'fruit' sub‑array:

$multiArr = array(
    'fruit' => array('apple', 'banana', 'orange'),
    'color' => array('red', 'yellow', 'orange')
);
$key = array_search('orange', $multiArr['fruit']);
echo $key; // outputs 2

Be aware of the added complexity when dealing with nested arrays.

Return Value

If the search succeeds, array_search() returns the key; otherwise it returns false . Since a key of 0 is also considered falsy, proper type checking is required.

Conclusion

The array_search() function is a practical tool for quickly locating values in arrays, especially when used with strict mode and in multidimensional contexts, helping improve development efficiency.