array_key_first()


関数array_key_first()は、指定された配列の最初のキーを取得するために使用されます。この関数は、配列が空でない場合に最初のキーを返し、空の場合はnullを返します。

シンタックス

array_key_first( array $array )
  • $array (array) — 最初のキーを取得する対象の配列。

例 1: 配列の最初のキーを取得する

以下のコードは、配列の最初のキーを取得して表示します。

<?php
$array = ['apple' => 1, 'banana' => 2, 'cherry' => 3];
echo array_key_first($array); // 出力: apple
?>

例 2: 空の配列で使用した場合

空の配列でarray_key_first()を使用した場合はnullを返します。

<?php
$array = [];
var_dump(array_key_first($array)); // 出力: NULL
?>

例 3: 数値キーの配列

数値キーを持つ配列でも最初のキーを取得できます。

<?php
$array = [100 => 'A', 200 => 'B', 300 => 'C'];
echo array_key_first($array); // 出力: 100
?>

例 4: 多次元配列での使用

多次元配列の最初のキーを取得する場合も同様に使用できます。

<?php
$array = [
    'first' => ['a' => 1, 'b' => 2],
    'second' => ['c' => 3, 'd' => 4]
];
echo array_key_first($array); // 出力: first
?>

例 5: 条件付きで使用する

条件付きで最初のキーを取得し、値を操作する例です。

<?php
$array = ['x' => 10, 'y' => 20, 'z' => 30];
$key = array_key_first($array);
if ($key === 'x') {
    echo "最初のキーはxです。値: " . $array[$key]; // 出力: 最初のキーはxです。値: 10
}
?>

注意点

  • 空の配列を渡すとnullを返すため、適切なエラーハンドリングを実装することが重要です。
  • 配列の順序が変更される可能性がある場合は、この関数の結果に依存しすぎないようにしてください。

関連機能：