(PHP 4, PHP 5, PHP 7, PHP 8)
key — 配列からキーを取り出す
$array): int|string|nullkey() は、 現在の配列位置における連想配列要素のキーを返します。
array配列。
key() 関数は、内部ポインタが現在指している配列要素のキーを返します。
ポインタを移動することはありません。内部ポインタが要素リストの末尾にいる場合や配列が空の場合は
key() は null を返します。
| バージョン | 説明 |
|---|---|
| 8.1.0 | この関数を object に対してコールすることは、推奨されなくなりました。 object に対して最初に get_mangled_object_vars() を使うか、ArrayIterator を使って下さい。 |
例1 key() の例
<?php
$array = array(
'fruit1' => 'リンゴ',
'fruit2' => 'オレンジ',
'fruit3' => 'ブドウ',
'fruit4' => 'リンゴ',
'fruit5' => 'リンゴ');
// このループは値が "リンゴ" である
// 全ての連想配列のキーを表示します
while ($fruit_name = current($array)) {
if ($fruit_name == 'リンゴ') {
echo key($array), "\n";
}
next($array);
}
?>
上の例の出力は以下となります。
fruit1 fruit4 fruit5