2021年3月2日

【PHP】【array】array_key_exists 特定の値が添字（キー）が配列に含まれているか検索

facebook

はてな

Pocket

Feedly

array_key_exists

array_key_existsの概要

array_key_existsは配列の添字（キー）に、特定の値が含まれているかを調べます。配列に格納されている値ではなく、添字（キー）の検索であることに注意してください。

array_key_existsの構文

array_key_exists ( string|int $key , array $array )

array_key_existsの引数と返り値

array_key_existsの構文の引数と返り値はこのようになります。

引数	$key	検索したい添字（キー）の値
	$array	検索対象の配列
返り値	boolean	含まれている時 true を返します含まれていないとき false を返します

array_key_existsの使い方

array_key_existsは配列の添字（キー）中に、$keyで指定した値が含まれているかを検証します。
例えば、配列 $order の中に ‘値段’ という値が含まれているかを調べたときは、このように記述します。

$order = array('名前'=>'オレンジ', '値段'=>198, '数量'=>6);

$answer1 = array_key_exists( '値段', $order);
$answer2 = array_key_exists( 198, $order);


print $answer1 // true '値段'という添字（キー）が含まれている
print $answer2 // false 198 という添字（キー）は含まれていない

array_key_existsはどんな時に使う？

例えばデータベースから通販の注文レコード情報を入手し、mysql_fetch_array使用時にMYSQL_ASSOC（連想配列）を指定すると、データベースのカラム名が添字になります（デフォルト時）。これが通販の注文レコードで、カラムを指定して操作する時に、カラム名が存在しない場合は、Undefined indexエラーが返されます。

array_key_existsで、カラム名が存在しないときに備えてのエラー処理分岐を用意する事ができます。