Array search functions in PHP

Introduction

Array search functions help you find if a value exists in a list and where it is. This saves time compared to checking each item yourself.

You want to check if a name is in a list of attendees.

You need to find the position of a product ID in an inventory array.

You want to verify if a user input matches any value in a predefined list.

You want to find the key of a specific value in an associative array.

You want to check if a value exists before adding it to avoid duplicates.

Syntax

PHP

<?php
// Search for a value in an array and get its key
$key = array_search(mixed $needle, array $haystack, bool $strict = false);

// Check if a value exists in an array
$exists = in_array(mixed $needle, array $haystack, bool $strict = false);
?>

array_search returns the key of the found value or false if not found.

in_array returns true if the value exists, otherwise false.

Examples

Finds the key of 'banana' in the array. Keys start at 0.

PHP

<?php
$fruits = ['apple', 'banana', 'cherry'];
$key = array_search('banana', $fruits);
echo $key; // Outputs 1
?>

Checks if 'grape' is in the array. It is not, so it prints 'Not found'.

PHP

<?php
$fruits = ['apple', 'banana', 'cherry'];
$exists = in_array('grape', $fruits);
echo $exists ? 'Found' : 'Not found'; // Outputs 'Not found'
?>

Searching in an empty array returns false.

PHP

<?php
$emptyArray = [];
$key = array_search('anything', $emptyArray);
var_dump($key); // Outputs bool(false)
?>

Searching for the only element returns key 0.

PHP

<?php
$singleElement = ['only'];
$key = array_search('only', $singleElement);
echo $key; // Outputs 0
?>

Sample Program

This program shows how to use array_search and in_array to find values in arrays. It prints the array, searches for values, and handles empty arrays.

PHP

<?php
// Define an array of colors
$colors = ['red', 'green', 'blue', 'yellow'];

// Print the original array
echo "Original array:\n";
print_r($colors);

// Search for 'blue' in the array
$searchKey = array_search('blue', $colors);
if ($searchKey !== false) {
    echo "\nFound 'blue' at key: $searchKey\n";
} else {
    echo "\n'blue' not found in the array.\n";
}

// Check if 'purple' exists in the array
$exists = in_array('purple', $colors);
echo $exists ? "\n'purple' is in the array.\n" : "\n'purple' is not in the array.\n";

// Search for 'red' in an empty array
$emptyArray = [];
$emptySearch = array_search('red', $emptyArray);
echo $emptySearch === false ? "\n'red' not found in empty array.\n" : "\nFound 'red' in empty array.\n";
?>

Important Notes

Time complexity: Both array_search and in_array check items one by one, so they take time proportional to the array size (O(n)).

Space complexity: These functions do not use extra space beyond a few variables.

A common mistake is to check if (array_search(...) == false) which fails if the found key is 0. Always use strict comparison !== false.

Use array_search when you need the key of the found value. Use in_array when you only need to know if the value exists.

Summary

Array search functions help find values or keys in arrays easily.

array_search returns the key or false if not found.

in_array returns true or false depending on presence.

Practice

1. Which PHP function returns the key of a value in an array if found, or false if not found?

easy

A. in_array

B. array_search

C. array_key_exists

D. array_keys

Solution

1. Step 1: Understand function purpose

   array_search looks for a value and returns its key if found.

2. Step 2: Compare with other functions

   in_array returns true/false, not key; array_key_exists checks keys; array_keys returns all keys.

3. Final Answer:

   array_search -> Option B

4. Quick Check:

   Key returned by array_search = array_search [OK]

Hint: array_search returns key, in_array returns true/false [OK]

Common Mistakes:

• Confusing array_search with in_array
• Thinking array_key_exists returns value
• Assuming array_keys searches values

2. Which of the following is the correct syntax to check if the value 5 exists in array $arr using in_array?

easy

A. in_array(5, $arr);

B. in_array($arr, 5);

C. in_array($arr => 5);

D. in_array(5 => $arr);

Solution

1. Step 1: Recall in_array syntax

   The correct syntax is in_array(value, array).

2. Step 2: Match syntax with options

   in_array(5, $arr); matches in_array(5, $arr); which is correct.

3. Final Answer:

   in_array(5, $arr); -> Option A

4. Quick Check:

   in_array(value, array) = in_array(5, $arr) [OK]

Hint: Remember in_array(value, array) order [OK]

Common Mistakes:

• Swapping parameters order
• Using arrow syntax instead of comma
• Passing array as first argument

3. What is the output of the following PHP code?

$arr = ['apple', 'banana', 'cherry'];
$key = array_search('banana', $arr);
echo $key;

medium

A. 0

B. banana

C. false

D. 1

Solution

1. Step 1: Understand array_search behavior

   It returns the key of the searched value if found.

2. Step 2: Check array keys and searched value

   Array keys are 0=>'apple', 1=>'banana', 2=>'cherry'. Searching 'banana' returns key 1.

3. Final Answer:

   1 -> Option D

4. Quick Check:

   array_search('banana', $arr) = 1 [OK]

Hint: array_search returns index/key of found value [OK]

Common Mistakes:

• Expecting value instead of key
• Confusing false with 0
• Assuming it returns boolean

4. Identify the error in the following PHP code snippet:

$arr = ['x' => 10, 'y' => 20];
if (array_search(30, $arr)) {
    echo 'Found';
} else {
    echo 'Not Found';
}

medium

A. array_search returns false but condition treats 0 as false

B. array_search returns key but 30 is not in array, so condition fails correctly

C. array_search should be replaced with in_array for this check

D. No error, code works as expected

Solution

1. Step 1: Analyze array_search return and condition

   array_search returns key or false. If key is 0, condition fails because 0 is falsey.

2. Step 2: Check searched value presence

   30 is not in array, so array_search returns false, condition is false, prints 'Not Found'. But if value was at key 0, condition would fail incorrectly.

3. Step 3: Suggest correct function for boolean check

   Use in_array which returns true/false directly for presence check.

4. Final Answer:

   array_search should be replaced with in_array for this check -> Option C

5. Quick Check:

   Use in_array for boolean presence check [OK]

Hint: Use in_array for true/false presence checks [OK]

Common Mistakes:

• Using array_search in if without strict check
• Ignoring 0 key treated as false
• Not using === to check false

5. Given the array $data = ['a' => 0, 'b' => false, 'c' => null, 'd' => '0'];, which function call correctly checks if the value 0 exists in the array considering type?

hard

A. in_array(0, $data, true);

B. array_search(0, $data);

C. in_array(0, $data);

D. array_search('0', $data, true);

Solution

1. Step 1: Understand strict checking

   Using third parameter true enforces type checking in in_array and array_search.

2. Step 2: Analyze array values and types

   Values are 0 (int), false (bool), null, and '0' (string). Only strict check distinguishes 0 (int) from others.

3. Step 3: Choose correct function and parameters

   in_array(0, $data, true) returns true only if exact int 0 found. array_search without strict may confuse types.

4. Final Answer:

   in_array(0, $data, true); -> Option A

5. Quick Check:

   Use in_array with strict=true for exact type match [OK]

Hint: Use in_array with strict=true to check exact value and type [OK]

Common Mistakes:

• Ignoring strict parameter causing false positives
• Using array_search without strict for type-sensitive check
• Confusing '0' string with 0 integer