array_key_exists
(PHP 4 >= 4.0.7, PHP 5, PHP 7, PHP 8)
array_key_exists — Verifica se uma chave ou índice existe em um array
Descrição
array_key_exists() retorna true
se a chave
key
existe no array.
key
pode ser qualquer valor possível para um
índice de um array.
Parâmetros
key
-
Valor para verificar.
array
-
Um array com chaves para verificar.
Valor Retornado
Retorna true
em caso de sucesso ou false
em caso de falha.
Note:
array_key_exists() procurará pelas chaves na primeira dimensão apenas. Chaves aninhadas em arrays multidimensionais não serão encontradas.
Registro de Alterações
Versão | Descrição |
---|---|
8.0.0 |
O parâmetro key agora aceita
bool , float , int ,
null , resource e
string como argumentos.
|
Exemplos
Example #1 Exemplo da função array_key_exists()
<?php
$busca_array = array("primeiro" => 1, "segundo" => 4);
if (array_key_exists("primeiro", $busca_array)) {
echo "O elemento 'primeiro' está no array!";
}
?>
Example #2 array_key_exists() versus isset()
isset() não retorna true
para valores de chave
que correspondam a um valor null
, enquanto que
array_key_exists() faz isto.
<?php
$search_array = array('first' => null, 'second' => 4);
// returns false
isset($search_array['first']);
// returns true
array_key_exists('first', $search_array);
?>
Notas
Note:
Por motivo de retrocompatibilidade, a função array_key_exists() também retornará
true
se o parâmetrokey
for uma propriedade definida em um dado object como parâmetroarray
. Esse comportamento está descontinuado a partir do PHP 7.4.0, e removido a partir do PHP 8.0.0.Para checar a existência de uma propriedade em um objeto, property_exists() deve ser utilizada.
Veja Também
- isset() - Determina se uma variável está declarada e é diferente de null
- array_keys() - Retorna todas as chaves ou uma parte das chaves de um array
- in_array() - Checa se um valor existe em um array
- property_exists() - Verifica se o objeto ou a classe tem uma propriedade