in_array

(PHP 4, PHP 5, PHP 7, PHP 8)

in_array — Перевіряє, чи існує в масиві значення

Опис

in_array(mixed $needle, array $haystack, bool $strict = false): bool

Шукає значення needle у haystack. Якщо параметр strict не встановлений, використовується м'яке порівняння.

Параметри

needle: Шукане значення.

Зауваження:
Якщо needle є рядком, то порівняння виконуватиметься з урахуванням регістру.
haystack: Масив.
strict: Якщо третій необов'язковий параметр strict встановлений у true, то функція in_array() перевірятиме також типи needle у haystack.

Зауваження:
До PHP 8.0.0, рядковий параметр needle відповідатиме значенню масиву 0 в нестрогому режимі і навпаки. Це може призвести до небажаних результатів. Подібні крайні випадки стаються і з іншими типами також. Якщо достеменно невідомо тип використаного значення, то для уникнення неочікуваної поведінки застосовується прапорець strict.

Значення, що повертаються

Повертає true якщо значення needle знайдене у масиві, інакше — false.

Приклади

Приклад #1 Використання in_array()

<?php
$os = array("Mac", "NT", "Irix", "Linux");
if (in_array("Irix", $os)) {
    echo "Знайшов Irix";
}
if (in_array("mac", $os)) {
    echo "Знайшов mac";
}
?>

Другого збігу не буде, тому що in_array() регістро-чутлива. Програма виведе:

Знайшов Irix

Приклад #2 Використанняin_array з строгою перевіркою()

<?php
$a = array('1.10', 12.4, 1.13);

if (in_array('12.4', $a, true)) {
    echo "'12.4' знайдено з строгою перевіркою\n";
}

if (in_array(1.13, $a, true)) {
    echo "1.13 знайдено з строгою перевіркою\n";
}
?>

Поданий вище приклад виведе:

1.13 знайдено з строгою перевіркою

Приклад #3 Використання in_array() з шуканим-масивом

<?php
$a = array(array('p', 'h'), array('p', 'r'), 'o');

if (in_array(array('p', 'h'), $a)) {
    echo "'ph' знайдено\n";
}

if (in_array(array('f', 'i'), $a)) {
    echo "'fi' знайдено\n";
}

if (in_array('o', $a)) {
    echo "'o' знайдено\n";
}
?>

Поданий вище приклад виведе:

'ph' знайдено
  'o' знайдено

Прогляньте також

array_search() - Searches the array for a given value and returns the first corresponding key if successful
isset() - Визначає, чи для змінної встановлено значення та воно не рівне null
array_key_exists() - Checks if the given key or index exists in the array

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 5 notes

down

411

beingmrkenny at gmail dot com ¶

13 years ago

Loose checking returns some crazy, counter-intuitive results when used with certain arrays. It is completely correct behaviour, due to PHP's leniency on variable types, but in "real-life" is almost useless.

The solution is to use the strict checking option.

<?php

// Example array

$array = array(
    'egg' => true,
    'cheese' => false,
    'hair' => 765,
    'goblins' => null,
    'ogres' => 'no ogres allowed in this array'
);

// Loose checking -- return values are in comments

// First three make sense, last four do not

in_array(null, $array); // true
in_array(false, $array); // true
in_array(765, $array); // true
in_array(763, $array); // true
in_array('egg', $array); // true
in_array('hhh', $array); // true
in_array(array(), $array); // true

// Strict checking

in_array(null, $array, true); // true
in_array(false, $array, true); // true
in_array(765, $array, true); // true
in_array(763, $array, true); // false
in_array('egg', $array, true); // false
in_array('hhh', $array, true); // false
in_array(array(), $array, true); // false

?>

down

Julian Sawicki ¶

1 year ago

Here is a recursive in_array function: 

<?php

$myNumbers = [
    [1,2,3,4,5],
    [6,7,8,9,10],
];

$array = [
    'numbers' => $myNumbers
];

// Let's try to find number 7 within $array
$hasNumber = in_array(7, $array, true); // bool(false)
$hasNumber = in_array_recursive(7, $array, true); // bool(true)

function in_array_recursive(mixed $needle, array $haystack, bool $strict): bool
{
    foreach ($haystack as $element) {
        if ($element === $needle) {
            return true;
        }

        $isFound = false;
        if (is_array($element)) {
            $isFound = in_array_recursive($needle, $element, $strict);
        }
        
        if ($isFound === true) {
            return true;
        }
    }

    return false;
}

down

rhill at xenu-directory dot net ¶

15 years ago

I found out that in_array will *not* find an associative array within a haystack of associative arrays in strict mode if the keys were not generated in the *same order*:

<?php

$needle = array(
    'fruit'=>'banana', 'vegetable'=>'carrot'
    );

$haystack = array(
    array('vegetable'=>'carrot', 'fruit'=>'banana'),
    array('fruit'=>'apple', 'vegetable'=>'celery')
    );

echo in_array($needle, $haystack, true) ? 'true' : 'false';
// Output is 'false'

echo in_array($needle, $haystack) ? 'true' : 'false';
// Output is 'true'

?>

I had wrongly assumed the order of the items in an associative array were irrelevant, regardless of whether 'strict' is TRUE or FALSE: The order is irrelevant *only* if not in strict mode.

down

leonhard dot radonic+phpnet at gmail dot com ¶

2 years ago

I got an unexpected behavior working with in_array. I'm using following code:

<?php
// ...
$someId = getSomeId(); // it gets generated/fetched by another service, so I don't know what value it will have. P.S.: it's an integer

// The actual data in my edge-case scenario:
// $someId = 0;
// $anyArray = ['dataOne', 'dataTwo'];
if (in_array($someId, $anyArray)) {
    // do some work
}
// ...
?>

With PHP7.4, in_array returns boolean true.
With PHP8.1, in_array returns boolean false.

It took me quite some time to find out what's going on.

down

-4

Armands Rieksti ¶

1 year ago

I'd like to point out that, if you're using Enum data structures and want to compare whether an array of strings has a certain string Enum in it, you need to cast it to a string.

From what I've tested, the function works correctly:
if the array is filled with strings and you're searching for a string;
if the array is filled with Enums and you're searching for an Enum.

＋add a note