関数の概要
array_key_first は、PHPで配列の最初のキーを取得するための関数です。連想配列や数値添字配列のいずれでも使え、配列の最初の要素のキーを簡単に取得できます。PHP 7.3.0以降で使用可能です。
パラメータの説明
array(配列): キーを取得したい配列を指定します。空の配列を指定した場合はnullが返ります。
戻り値
配列の最初のキーを返します。キーの型は元の配列のキーの型(整数または文字列)に依存します。配列が空の場合は null を返します。
使用例
基本的な使い方
<?php
$array = ['apple' => 1, 'banana' => 2, 'cherry' => 3];
$key = array_key_first($array);
echo $key; // 出力: apple
?>
連想配列の最初のキーが「apple」と正しく取得できています。
数値添字配列の場合
<?php
$array = [10 => 'a', 20 => 'b', 30 => 'c'];
$key = array_key_first($array);
echo $key; // 出力: 10
?>
数値添字配列であっても最初のキー(この場合は 10)を取得できます。
空の配列の場合の挙動
<?php
$array = [];
$key = array_key_first($array);
var_dump($key); // 出力: NULL
?>
配列が空の場合は null が返ってくるため、キーが存在しないことがわかります。
多次元配列の最初のキーも取得可能
<?php
$array = [
'fruits' => ['apple', 'banana'],
'vegetables' => ['carrot', 'spinach']
];
$key = array_key_first($array);
echo $key; // 出力: fruits
?>
多次元配列でも最初の要素のキー「fruits」が取得できます。
関連する関数
reset: 配列の内部ポインタを最初に移動し、その値を返すarray_key_last: 配列の最後のキーを取得するkey: 現在の配列要素のキーを取得する(内部ポインタによる)
まとめ
array_key_first は配列の最初のキーを簡単に取得できるPHP標準関数です。連想配列や数値添字配列のどちらにも対応していて、キーの存在チェックや初期要素の取得に役立ちます。PHP 7.3以降で使用できるため、互換性を気にしつつ実務でもぜひ活用してください。
