key

(PHP 4, PHP 5, PHP 7)

key配列からキーを取り出す

説明

key ( array $array ) : mixed

key() は、 現在の配列位置における連想配列要素のキーを返します。

パラメータ

array

配列。

返り値

key() 関数は、内部ポインタが現在指している配列要素のキーを返します。 ポインタを移動することはありません。内部ポインタが要素リストの末尾にいる場合や配列が空の場合は key()NULL を返します。

変更履歴

バージョン 説明
7.0.0 array は常に値で渡されるようになりました。 このバージョンより前は、可能な場合は参照で、それ以外の場合は値で 渡されていました。

例1 key() の例

<?php
$array 
= array(
    
'fruit1' => 'リンゴ',
    
'fruit2' => 'オレンジ',
    
'fruit3' => 'ブドウ',
    
'fruit4' => 'リンゴ',
    
'fruit5' => 'リンゴ');

// このループは値が "リンゴ" である
// 全ての連想配列のキーを表示します
while ($fruit_name current($array)) {
    if (
$fruit_name == 'リンゴ') {
        echo 
key($array).'<br />';
    }
    
next($array);
}
?>

上の例の出力は以下となります。

fruit1<br />
fruit4<br />
fruit5<br />

参考