PHP array_key_first 函数

最后修改于 2025 年 3 月 13 日

PHP 的 array_key_first 函数用于获取数组的第一个键。 当您需要访问第一个元素而无需重置数组指针时，它非常有用。

基本定义

array_key_first 函数返回给定数组的第一个键。它适用于索引数组和关联数组。

语法：array_key_first(array $array): int|string|null。对于空数组，返回 null。 自 PHP 7.3 起可用。

array_key_first 基本示例

这演示了如何从一个简单的关联数组中获取第一个键。

<?php

$colors = [
    'red' => '#FF0000',
    'green' => '#00FF00',
    'blue' => '#0000FF'
];

$firstKey = array_key_first($colors);

echo "First color key: $firstKey"; 

函数返回 'red'，因为它是数组中的第一个键。原始数组保持不变。

索引数组示例

array_key_first 同样适用于数字索引。

<?php

$fruits = ['apple', 'banana', 'cherry'];
$firstIndex = array_key_first($fruits);

echo "First fruit index: $firstIndex"; 

对于索引数组，它返回 0（第一个数字索引）。 这与 PHP 的标准数组索引行为匹配。

空数组处理

当使用空数组调用该函数时，它返回 null。

<?php

$emptyArray = [];
$result = array_key_first($emptyArray);

var_dump($result); 

此行为有助于区分具有 null 键的数组和真正的空数组。在使用未知数组时，请务必检查 null。

混合键类型

该函数处理具有混合键类型（数字和字符串）的数组。

<?php

$mixed = [
    10 => 'ten',
    'color' => 'blue',
    20 => 'twenty'
];

$firstKey = array_key_first($mixed);

echo "First key: "; 
var_dump($firstKey); 

尽管后面有字符串键，但该函数返回第一个键 (10)。类型（int）保留在返回值中。

实际使用示例

以下是如何在实际场景中使用 array_key_first。

<?php

$userPreferences = [
    'theme' => 'dark',
    'language' => 'en',
    'notifications' => true
];

$mainPreference = array_key_first($userPreferences);

echo "Main preference setting: $mainPreference"; 

这展示了如何在不影响数组的情况下获取首选键。 当您需要第一个设置但又想保留数组时，这很有用。

最佳实践

• 空值检查： 始终验证返回值是否不为 null。
• PHP 版本： 确保 PHP 7.3+ 支持此函数。
• 可读性： 为了清晰起见，优先于 reset()+key()。
• 性能： 对于大型数组，比 array_keys()[0] 更快。

来源

PHP array_key_first 文档

本教程涵盖了 PHP array_key_first 函数，并提供了实际示例，展示了它在数组键检索中的用法。

作者

我叫 Jan Bodnar，是一位充满激情的程序员，拥有丰富的编程经验。自 2007 年以来，我一直在撰写编程文章。迄今为止，我已撰写了 1,400 多篇文章和 8 本电子书。我拥有超过十年的编程教学经验。

列出 所有 PHP 数组函数。