in_array

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

in_arrayCheca se um valor existe em um array

Descrição

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

Procura por needle (agulha) no haystack (palheiro) usando comparação frouxa a não ser que strict seja definido.

Parâmetros

needle

O valor procurado.

Nota:

Se needle for uma string, a comparação é feita diferenciando caracteres maiúsculos e minúsculos.

haystack

O array.

strict

Se o terceiro parâmetro strict for true então in_array() também irá checar os tipos de needle em haystack.

Nota:

Antes do PHP 8.0.0, uma needle string irá corresponder a um valor de 0 no array em modo não estrito, e vice-versa. Isso pode levar a resultados indesejáveis. Casos extremos similares exitem para outros tipos, também. Se você não tem certeza absoluta dos tipos dos valores involvidos, sempre use a flag strict para evitar comportamento inesperado.

Valor Retornado

Retorna true se needle é encontrado no array, false caso contrário.

Exemplos

Exemplo #1 Exemplo da in_array()

<?php
$os
= array("Mac", "NT", "Irix", "Linux");
if (
in_array("Irix", $os)) {
echo
"Tem Irix";
}
if (
in_array("mac", $os)) {
echo
"Tem mac";
}
?>

A segunda condicional falha pois in_array() diferencia letras minúsculas e maiúsculas. Então, a saída seria:

Tem Irix

Exemplo #2 in_array() com checagem de tipos

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

if (
in_array('12.4', $a, true)) {
echo
"'12.4' encontrado com checagem de tipo\n";
}

if (
in_array(1.13, $a, true)) {
echo
"1.13 encontrado com checagem de tipo\n";
}
?>

O exemplo acima produzirá:

1.13 encontrado com checagem de tipo

Exemplo #3 Exemplo de in_array() passando um array como um needle

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

if (
in_array(array('p', 'h'), $a)) {
echo
"'ph' foi encontrado\n";
}

if (
in_array(array('f', 'i'), $a)) {
echo
"'fi' foi encontrado\n";
}

if (
in_array('o', $a)) {
echo
"'o' foi encontrado\n";
}
?>

O exemplo acima produzirá:

    'ph' foi encontrado
    'o' foi encontrado

Veja Também

  • array_search() - Procura por um valor em um array e retorna sua chave correspondente caso seja encontrado
  • isset() - Determina se uma variável está declarada e é diferente de null
  • array_key_exists() - Verifica se uma chave ou índice existe em um array

add a note add a note

User Contributed Notes 8 notes

up
398
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

?>
up
1
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;
}
up
1
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.
up
8
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.
up
1
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.
up
-2
thomas dot sahlin at gmail dot com
15 years ago
If you're creating an array yourself and then using in_array to search it, consider setting the keys of the array and using isset instead since it's much faster.

<?php

$slow
= array('apple', 'banana', 'orange');

if (
in_array('banana', $slow))
    print(
'Found it!');

$fast = array('apple' => 'apple', 'banana' => 'banana', 'orange' => 'orange');

if (isset(
$fast['banana']))
    print(
'Found it!');

?>
up
-7
Anonymous
2 years ago
$a = new StdClass();
$b = new StdClass();

// Expected: false, got: true
var_dump(in_array($a, [$b]));
// bool(true)

// Works fine
var_dump(in_array($a, [$b], true));
// bool(false)
up
-23
Anonymous
2 years ago
$a = new StdClass();
$b = new StdClass();

// Expected: false, got: true
var_dump(in_array($a, [$b]));
// bool(true)

// Works fine
var_dump(in_array($a, [$b], true));
// bool(false)
To Top