array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'pt_BR', ), 'this' => array ( 0 => 'function.array-search.php', 1 => 'array_search', ), 'up' => array ( 0 => 'ref.array.php', 1 => 'Funções para Array', ), 'prev' => array ( 0 => 'function.array-reverse.php', 1 => 'array_reverse', ), 'next' => array ( 0 => 'function.array-shift.php', 1 => 'array_shift', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'pt_BR', 'path' => 'reference/array/functions/array-search.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(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
Procura a needle
(agulha) em haystack
(palheiro).
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.
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
.
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.
Exemplo #1 Exemplo de 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;
?>