array_search

(PHP 4 >= 4.0.5, PHP 5)

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

Descrição

mixed array_search ( mixed needle, array haystack [, bool strict] )

Procura em haystack pelo valor needle e retorna sua chave se for encontrado no array, e FALSE em caso contrário.

Nota: Se needle for uma string, a comparação é feita de uma maneira que diferencia maiúsculas e minúsculas.

Nota: A partir do PHP 4.2.0, array_search() retorna NULL em caso de falha ao invés de FALSE.

Se o terceiro parâmetro opcional strict for passado como TRUE então array_search() também fará uma checagem de tipos de needle em haystack.

Se needle for encontrado em haystack mais de uma vez, a primeira chave que combinar é retornada. Para retornar as chaves para todos os valores que combinar, use array_keys() com o parâmetro opcional search_value.

Exemplo 1. Exemplo array_search()

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

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

Atenção

Esta função pode retornar o booleano FALSE, mas também pode retornar um valor não-booleano que pode ser avaliado como FALSE, como 0 ou "". Leia a seção em Booleanos para maiores informações. Utilize o operador === para testar o valor retornado por esta função.

Veja também array_keys(), array_values(), array_key_exists() e in_array().