key

(PHP 4, PHP 5, PHP 7, PHP 8)

key — Retorna uma chave de um array

Descrição

key(array|object $array): int|string|null

key() retorna a chave da posição atual de um array.

Parâmetros

array

O array.

Valor Retornado

A função key() simplesmente retorna a chave do elemento do array que está atualmente sendo apontada pelo ponteiro interno. Isso não move o ponteiro de nenhuma forma. Se o ponteiro interno aponta além do fim de elementos da lista ou o array está vazio, key() retorna null.

Registro de Alterações

Versão Descrição
8.1.0 Chamar esta função em objects tornou-se defasado. Converta o object para um array usando get_mangled_object_vars() primeiro ou, em vez disso, use os métodos fornecidos por uma classe que implementa Iterator, como ArrayIterator.
7.4.0 Instâncias de classes SPL agora são tratadas como objetos vazios que não possuem propriedades em vez de chamar o método da interface Iterator com o mesmo nome desta função.

Exemplos

Example #1 Exemplo da key()

<?php
$array = array(
    'fruit1' => 'apple',
    'fruit2' => 'orange',
    'fruit3' => 'grape',
    'fruit4' => 'apple',
    'fruit5' => 'apple');

// este ciclo exibirá toda a chave do array associativo
// onde o valor é igual a "apple"
while ($fruit_name = current($array)) {
    if ($fruit_name == 'apple') {
        echo key($array), "\n";
    }
    next($array);
}
?>

O exemplo acima produzirá:

fruit1
fruit4
fruit5

Veja Também