array_search

(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)

array_search — Procura por um valor em um array e retorna sua chave correspondente caso seja encontrado

Descrição

array_search(mixed $needle, array $haystack, bool $strict = false): int|string|false

Procura a needle (agulha) em haystack (palheiro).

Parâmetros

needle: O valor procurado.

Nota:
Se needle for uma string, a comparação é feita de uma maneira que diferencia maiúsculas e minúsculas.
haystack: O array.
strict: Se o terceiro parâmetro opcional strict for informador como true então array_search() fará uma busca por elementos idênticos em haystack. Isto significa que haverá uma checagem adicional de tipos no parâmetro needle ao percorrer haystack, de forma que os objetos sejam a mesma instância.

Valor Retornado

Retorna a chave para needle se foi encontrada no array, false caso contrário.

Se needle for encontrado em haystack mais de uma vez, a primeira chave encontrada é retornada. Para retornar as chaves de todos os valores correspondentes, utilize a função array_keys() com o parâmetro opcional filter_value.

Aviso

Esta função pode retornar o valor booleano false, mas também pode retornar um valor não booleano que pode ser avaliado como false. Leia a seção sobre Booleanos para mais informações. Use o operador === para testar o valor retornado por esta função.

Exemplos

Exemplo #1 Exemplo de array_search()

<?php
$array = array(0 => 'blue', 1 => 'red', 2 => 'green', 3 => 'red');

$key = array_search('green', $array); // $key = 2;
print_r($key);

$key = array_search('red', $array);   // $key = 1;
print_r($key);
?>

Veja Também

array_keys() - Retorna todas as chaves ou uma parte das chaves de um array
array_values() - Retorna todos os valores de um array
array_key_exists() - Verifica se uma chave ou índice existe em um array
in_array() - Verifica se um valor existe em um array