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

UPDATE:2019年12月12日

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

PHP4 PHP5 PHP7

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

php key() サンプル

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

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

説明	配列のカレントの要素（現在内部ポインタが示している要素）のキーを取得します。 ※配列には各要素に対する現在の位置を指し示す内部ポインタがあります。
引数	array 必須 $array	関数に入力する配列です。
返り値	mixed	成功すると配列要素のキーを返し、要素のキーが無い場合、FALSE を返す。空の配列を指定した場合、NULL を返す。

サンプル

<?php
$array = array('id' => 1, 'name' => '山田太郎', 'mail' => 'yamadataro@mail.com', 'tel' => '050-1234-5678');
echo key($array)."<br>\n"; //id
echo next($array)."<br>\n"; //山田太郎
echo key($array)."<br>\n"; //name
echo next($array)."<br>\n"; //yamadataro@mail.com
echo key($array)."<br>\n"; //mail
?>

<?php

$array = array('id' => 1, 'name' => '山田太郎', 'mail' => 'yamadataro@mail.com', 'tel' => '050-1234-5678');

echo key($array)." \n"; //id

echo next($array)." \n"; //山田太郎

echo key($array)." \n"; //name

echo next($array)." \n"; //yamadataro@mail.com

echo key($array)." \n"; //mail

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

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

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

◆ key() 内容

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

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

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

◆ key() パラメーター

値	内容
必須 array $array	関数に入力する配列です。

◆ key() 返り値

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

mixed 複数のデータ型を受け入れる（パラメーター）、或いは、返す（返り値）ことが可能。全てのデータ型ではありません。例えば gettype()関数は全ての型を受け入れますが、一方、str_replace()関数は、文字列型と配列型のみを受け入れます。また、reset()関数や end()関数は、返り値に配列型と論理型（FALSE）を返します。

◆ key() 変更履歴

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

php key() サンプル

<?php
$array = array(
	'january' => '1月',
	'february' => '2月',
	'march' => '3月',
	'april' => '4月',
	'may' => '5月',
	'june' => '6月',
	'july' => '7月',
	'august' => '8月',
	'september' => '9月',
	'october' => '10月',
	'november' => '11月',
	'december' => '12月'
);
while($key = key($array)){
	echo $key."<br>\n";
	next($array);
}
?>

<?php

$array = array(

'january' => '1月',

'february' => '2月',

'march' => '3月',

'april' => '4月',

'may' => '5月',

'june' => '6月',

'july' => '7月',

'august' => '8月',

'september' => '9月',

'october' => '10月',

'november' => '11月',

'december' => '12月'

);

while($key = key($array)){

echo $key." \n";

next($array);

}

実行結果

january
february
march
april
may
june
july
august
september
october
november
december

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

<?php
$array = array();
echo gettype(key($array))."<br>\n"; //false
?>

<?php

$array = array();

echo gettype(key($array))." \n"; //false

実行結果

NULL

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

<?php
$array = array('Apple', 'Banana', 'Pineapple', 'Strawberry');
echo end($array)."<br>\n"; //id
echo gettype(next($array))."<br>\n"; //false
?>

<?php

$array = array('Apple', 'Banana', 'Pineapple', 'Strawberry');

echo end($array)." \n"; //id

echo gettype(next($array))." \n"; //false

実行結果

Strawberry
boolean

タグ（＝記事関連ワード）

タグ: key, PHP, 配列

日付

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

php current 配列の現在の内部ポインタの要素の値を取得

php filter_input POST や GET などの変数をフィルタリングする

このページのトップへ

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

php bin2hex() バイナリデータ（2進法）を16進表現に変換

count_chars() 文字列の文字情報を取得

echo() 1 つ以上の文字列を出力

explode() 文字列を指定文字列で分割

html_entity_decode() HTMLエンティティを適切な文字に戻す

htmlspecialchars_decode() HTMLエンティティを文字に戻す

htmlspecialchars() 文字列をHTML エンティティにエンコード

php strstr を検索【大文字／小文字区別あり】

php crypt 文字列をハッシュ化する（一方向）

php stripslashes 文字列の「バックスラッシュ（ \ ）」を取り除く

php htmlentities 文字列をHTMLエンティティにエンコード

php getdate 日付や時刻を取得する

php checkdate 日付が正しいか調べる

php reset 配列の内部ポインタを最初の要素にセットして値を取得

php end 配列の内部ポインタを最後まで進めて要素の値を取得

php next 配列の内部ポインタを次へ進めて要素の値を取得

php prev 配列の内部ポインタを前へ戻して要素の値を取得

php current 配列の現在の内部ポインタの要素の値を取得

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

php filter_input POST や GET などの変数をフィルタリングする

php filter_id フィルタの ID を取得する

php filter_input_array POST や GET などの変数を一括フィルタリングする

php filter_var_array 配列で複数のデータをフィルタリングして値をチェックする

php filter_var データをフィルタリングして値をチェックする

php filter_list フィルタ一覧を取得する

php gettype 変数の型情報を取得する

php is_array 変数が配列型かどうかチェックする

php is_bool 変数が論理型かどうかチェックする

php is_float 変数が浮動小数点型かどうかチェックする

php implode() 配列要素を連結して文字列に変換（一繋ぎのテキストになる）

php is_int 変数が整数型かどうかチェックする

php addcslashes 指定文字の前にバックスラッシュを付ける(クォートする)

php is_null 変数がヌル型（NULL型）かどうかチェックする

php stristr 文字列を検索【大文字／小文字区別なし】

php is_string 変数が文字列型かどうかチェックする

php is_object 変数がオブジェクト型かどうかチェックする

php strtoupper 文字列（アルファベット部分）を大文字に変換

php is_numeric 変数が数値か文字列型の数字かどうかチェックする

php is_resource 変数がリソース型かどうかチェックする

php is_scalar 変数がスカラー型かどうかチェックする

php date 日付や時刻の取得

php time 現在日時のタイムスタンプを取得する

php strtotime 日付からタイムスタンプを取得

php mktime 日時からタイムスタンプを取得する

この記事へのコメント

トラックバックurl

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

php current 配列の現在の内部ポインタの要素の値を取得

php filter_input POST や GET などの変数をフィルタリングする

このページのトップへ

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

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

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

◆ key() 内容

◆ key() パラメーター

◆ key() 返り値

◆ key() 変更履歴

php key() サンプル

タグ（＝記事関連ワード）

日付

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

この記事へのコメント

トラックバックurl

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