array_key_exists

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

array_key_exists — Checa se uma chave ou índice existe em um array

Descrição

array_key_exists(string|int $key, array $array): bool

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.

Nota:
array_key_exists() procurará pelas chaves na primeira dimensão apenas. Chaves aninhadas em arrays multidimensionais não serão encontradas.

Exemplos

Exemplo #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!";
}
?>

Exemplo #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

Nota:
Por motivo de retrocompatibilidade, a função array_key_exists() também retornará true se o parâmetro key for uma propriedade definida em um dado object como parâmetro array. Esse comportamento está depreciado 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

＋add a note

User Contributed Notes 3 notes

down

Rumour ¶

4 months ago

In PHP7+ to find if a value is set in a multidimensional array with a fixed number of dimensions, simply use the Null Coalescing Operator: ??

So for a three dimensional array where you are not sure about any of the keys actually existing

<?php

// instead of:
$exists = array_key_exists($key1, $arr) && array_key_exists($key2, $arr[$key1]) && array_key_exists($key3, $arr[$key1][$key2]) ;

// use:
$exists =  array_key_exists($key3, $arr[$key1][$key2]??[]) ;

?>

down

Julian ¶

9 months ago

When you want to check multiple array keys: 

<?php

$array = [];
$array['a'] = '';
$array['b'] = '';
$array['c'] = '';
$array['d'] = '';
$array['e'] = '';

// all given keys a,b,c exists in the supplied array
var_dump(array_keys_exists(['a','b','c'], $array)); // bool(true)

function array_keys_exists(array $keys, array $array): bool
{
    $diff = array_diff_key(array_flip($keys), $array);
    return count($diff) === 0;
}

down

-34

manhon824 at gmail dot com ¶

12 years ago

I took hours for me to debug, and I finally recognized that,

You have to reset the $array before using array_key_exists 
reset($array);
array_key_exists($needle,$array);

Or you will get no reply.

＋add a note