Função array_search() do PHP

Exemplo

Procurar o valor de chave "red" no array e retornar o nome da chave correspondente:

<?php
$a=array("a"=>"red","b"=>"green","c"=>"blue");
echo array_search("red",$a);
?>

Executar Exemplo

Definição e uso

A função array_search() busca um valor de chave em um array e retorna o nome da chave correspondente.

Explicação detalhada

A função array_search() com in_array() Da mesma forma, encontrar um valor de chave em um array. Se encontrar o valor, o nome da chave do elemento correspondente será retornado. Se não encontrar, retornará false.

Antes do PHP 4.2.0, a função retornava null em caso de falha em vez de false.

Se o terceiro parâmetro strict Se especificado como true, retorna o nome da chave correspondente apenas quando os tipos de dados e valores dos elementos coincidirem.

Sintaxe

array_search(value,array,strict)
Parâmetros Descrição
value Obrigatório. Especifica o valor da chave a ser pesquisada.
array Obrigatório. Especifica o array a ser pesquisado.
strict

Opcional. Se o parâmetro for definido como TRUE, a função busca elementos no array que tenham o mesmo tipo de dados e valor.

  • true
  • false - Padrão

Se definido como true, verifica o tipo do valor fornecido no array, o número 5 e a string 5 são diferentes (veja o exemplo 2).

Detalhes Técnicos

Retorno:

Se encontrar o valor da chave especificada no array, retorna o nome da chave correspondente, caso contrário, retorna FALSE.

Se encontrar o valor da chave mais de uma vez no array, retorna o nome da chave correspondente à primeira ocorrência.

Versão do PHP: 4.0.5+
Registro de Atualizações:

Se passar parâmetros inválidos para a função, a função retorna NULL (aplicável a todas as funções PHP a partir do PHP 5.3.0).

A partir do PHP 4.2.0, se a busca falhar, a função retorna FALSE em vez de NULL.

Mais Exemplos

Exemplo 1

Procurar pelo valor 5 na chave do array e retornar o nome da chave (observe ""):

<?php
$a=array("a"=>"5","b"=>5,"c"=>"5");
echo array_search(5,$a,true);
?>

Executar Exemplo