array_key_first

(PHP 7 >= 7.3.0, PHP 8)

array_key_first — Получает первый ключ массива

Описание

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

Получить первый ключ заданного массива array, не затрагивая внутренний указатель массива.

Список параметров

array: Массив.

Возвращаемые значения

Возвращает первый ключ массива array, если он не пустой; null в противном случае.

Примеры

Пример #1 Пример использования array_key_first()

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

$firstKey = array_key_first($array);

var_dump($firstKey);
?>

Результат выполнения приведённого примера:

string(1) "a"

Примечания

Подсказка

Есть несколько способов предоставить функциональность для версий до PHP 7.3.0. Можно использовать array_keys(), но это может быть довольно неэффективно. Также можно использовать reset() и key(), но это может изменить внутренний указатель массива. Эффективное решение, которое не изменяет внутренний указатель массива, записанный, как полифил:

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

Смотрите также

array_key_last() - Получает последний ключ массива
reset() - Устанавливает внутренний указатель массива на первый элемент

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей 1 note

down

MaxiCom dot Developpement at gmail dot com ¶

1 year ago

A polyfill serves the purpose of retroactively incorporating new features from PHP releases into older PHP versions, ensuring API compatibility.

In PHP 7.3.0, the array_key_first() function was introduced, demonstrated in the following example:

<?php

$array = [
    'first_key' => 'first_value',
    'second_key' => 'second_value',
];

var_dump(array_key_first($array));

?>

The provided polyfill in this documentation allows the convenient use of array_key_first() with API compatibility in PHP versions preceding PHP 7.3.0, where the function was not implemented:

<?php

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

$array = [
    'first_key' => 'first_value',
    'second_key' => 'second_value',
];

var_dump(array_key_first($array));

?>

＋Добавить