menu
ホーム > PHP関数リファレンス > 配列系 > php key 配列の現在の内部ポインタの要素のキーを取得

php key 配列の現在の内部ポインタの要素のキーを取得

php key 配列の現在の内部ポインタの要素のキーを取得 | wepicks!

PHP4 PHP5 PHP7


php key 配列の現在の内部ポインタの要素のキーを取得

key() 書式
mixed 配列要素の値 = key(array $array);
配列が空の場合 NULL を返す
内部ポインタが最後の次の場合 FALSE を返す

サンプル

引数 や 返り値 のデータ型の説明

引数や返り値内容
string文字列型 を受け入れる。
int整数型 を受け入れる。
float浮動小数点数型 を受け入れる。
bool論理型 を受け入れる。
number整数型 | 浮動小数点数型 どちらでも可。
mixed引数に複数のデータ型を使うことが可能。全てではない。例えば gettype()関数 は全ての型を受け入れます。一方、 str_replace()関数 は、文字列型と配列型のみを受け入れる。
array|objectarray|object は、引数が array 配列型 または object オブジェクト型 のどちらでもよいことを示します。
void返り値の型が void である場合、 返り値に意味がないことを表します。パラメータ一覧で void が使用されている場合は、 その関数がパラメータを受け付けないことを表します。
callbackcallback 疑似型がこのドキュメントで使われていたのは、PHP 5.4 で callable タイプヒントが導入される前のことでした。両者はまったく同じ意味です。

key() 内容

配列のカレント要素のキーを返す

配列には各要素に対する現在の位置を指し示す内部ポインタがあります。key()関数 は、配列のカレントの要素(現在内部ポインタが示している要素)のキーを取得します。
配列の要素にはキーと値がセットで格納されており、key は 要素のキーを取得します。key は、ポインタを移動させません。key() は、内部ポインタが配列の最終要素の次を指している場合、FALSE を返します。また、空の配列を指定した場合、NULL を返します。
ポインタは配列作成時に初期化されており、最初の要素を示します。reset()関数 で配列の内部ポインタを先頭の要素にセットすることが出来ます。

配列には、現在配列内のどの要素を指しているかを示す内部ポインタがある

key() パラメーター

内容
array $array入力配列

key() 返り値

mixed
配列のカレントの要素(現在内部ポインタが指し示している要素)のキーを返す。内部ポインタが配列の最終要素の次を指している場合、FALSE を返します。また、空の配列を指定した場合、NULL を返します。

key() 変更履歴

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

php key() サンプル

実行結果
january
february
march
april
may
june
july
august
september
october
november
december

空の要素を指定した場合 NULL を返す。

実行結果
NULL

内部ポインタが配列の最終要素の次を指している場合、FALSE を返す

実行結果
Strawberry
boolean


タグ(=記事関連ワード)

タグ: , ,

日付

投稿日:2019年7月11日
最終更新日:

関連記事

配列関数サンプル

このカテゴリの他のページ

この記事へのコメント

トラックバックurl

https://wepicks.net/phpfunction-array-key/trackback/

page top