Obtém a primeira chave de um array

# array_key_first

(PHP 7 >= 7.3.0, PHP 8)

array_key_first — Obtém a primeira chave de um array

### Descrição

function array_key_first(array `$array`): int|string|null

Obtém a primeira chave do `array` fornecido sem afetar o ponteiro do array interno.

### Parâmetros

`array`

  Um array.

### Valor Retornado

Retorna a primeira chave do `array` se o array não estiver vazio; `null` caso contrário.

### Exemplos

Exemplo #1 Uso básico de array_key_first()

    <?php
    $array = ['a' => 1, 'b' => 2, 'c' => 3];

    $firstKey = array_key_first($array);

    var_dump($firstKey);
    ?>

O exemplo acima produzirá:

    string(1) "a"

### Notas

Dica

Existem várias maneiras de fornecer essa funcionalidade para versões anteriores ao PHP 7.3.0. É possível usar array_keys(), mas isso pode ser bastante ineficiente. Também é possível usar reset() e key(), mas isso pode alterar o ponteiro do array interno. Uma solução eficiente, que não altera o ponteiro interno do array, escrito como polyfill:

    <?php
    if (!function_exists('array_key_first')) {
        function array_key_first(array $arr) {
            foreach($arr as $key => $unused) {
                return $key;
            }
            return NULL;
        }
    }
    ?>

### Veja Também

- array_first() - Obtém o primeiro valor de um array
- array_key_last() - Obtém a última chave de um array
- reset() - Faz o ponteiro interno de um array apontar para o seu primeiro elemento

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open