array_key_last

関数の概要

array_key_lastは、PHPで配列の最後のキーを取得するための関数です。配列の要素の中で最後に位置するキーを返すため、配列の終端にどのキーがあるか知りたい場合に便利です。PHP 7.3.0 以降で利用可能です。

パラメータの説明

  • array:最後のキーを取得したい配列を指定します。連想配列やインデックス配列どちらも対応しています。

戻り値

指定された配列の最後のキーを返します。配列が空の場合は null を返します。キーは配列の型に応じて整数または文字列になる場合があります。

使用例

基本的な使い方

$fruits = ['apple' => 'りんご', 'banana' => 'バナナ', 'cherry' => 'さくらんぼ'];
$lastKey = array_key_last($fruits);
echo $lastKey;  // 出力結果: cherry

この例では連想配列の最後のキー「cherry」が取得されます。

インデックス配列の場合

$numbers = [100, 200, 300, 400];
$lastIndex = array_key_last($numbers);
echo $lastIndex;  // 出力結果: 3

数値添字の配列でも最後のキー(インデックス)を得られます。この場合は配列の最後の要素のインデックス「3」が取得されます。

空の配列の場合

$emptyArray = [];
$lastKey = array_key_last($emptyArray);
var_dump($lastKey);  // 出力結果: NULL

配列が空の場合は null が返るため、呼び出し前に配列の中身を確認するか、戻り値のチェックを行うことが重要です。

多次元配列の例

$multiArray = ['a' => [1, 2], 'b' => [3, 4], 'c' => [5, 6]];
$lastKey = array_key_last($multiArray);
echo $lastKey;  // 出力結果: c

多次元配列でも最外側の最後のキーを取得します。ここでは「c」が返されます。

関連する関数

  • array_key_first:配列の最初のキーを取得する関数
  • end:配列の最後の要素に移動して値を取得する関数
  • key:現在の配列のキーを取得する関数

まとめ

array_key_lastは配列の最後のキーを簡単に取得できる便利な関数です。配列の構造を調べたり、最後の要素を特定するときに役立ちます。配列が空のときは null を返す点に注意してください。PHP 7.3.0以降で利用可能なため、対応バージョンの確認も忘れずに行いましょう。