array_key_first

(PHP 7 >= 7.3.0, PHP 8)

array_key_firstObtém a primeira chave de um array

Descrição

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

Obtenha a primeira chave do array fornecido sem afetar o ponteiro do array interno.

Parâmetros

array

Um array.

Valor Retornado

Retorna a primeira key 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_key_last() - Obtém a última chave de um array
  • reset() - Faz o ponteiro interno de um array apontar para o seu primeiro elemento
add a note add a note

User Contributed Notes 3 notes

up
1
nekto at nekto dot com dot ua
2 years ago
A proper one-liner polyfill for version < 7.3:

<?php
function array_key_first((array) $a)
{
    return
array_keys($a)[0];
}
up
-6
Vee W.
3 years ago
Another way to get first array key with PHP older than 7.3.

<?php

$array
= ['one', 'two', 'three'];
$array2 = ['one' => 'Number one', 'two' => 'Number two'];

reset($array);// go to first array
echo key($array);// get its key (first array)
// expect 0.

reset($array2);
echo
key($array2);
// expect one.
up
-7
github.com / ahsankhatri
3 years ago
One-liner polyfill (php version < 7.3.0)

<?php
function array_key_first(array $array)
{
    return
key(array_slice($array, 0, 1));
}
To Top