【PHP】指定した値が配列に存在するかどうかを確認できるin_array関数を解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。

この記事では、 PHPで指定した値が配列に存在するかどうかを確認できるin_array関数について

in_array関数とは
in_array関数を使ったサンプルプログラム

と、丁寧に解説していきます。

前提条件：実行環境について
in_array関数とは
1. パターン1：オプション設定なし
2. パターン2：オプション設定あり
in_array関数を解説するプログラムの概要
PHPサンプルプログラム
実行結果
まとめ：in_array関数を使ってみよう！

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows10
PHPのバージョン	8.0.3
XAMPPのバージョン	8.0.3

PHPを動かすためにXAMPPを使っています。
XAMPPのインストールは、下の記事をご参考ください。

【XAMPP】インストールするやり方を解説します

in_array関数とは

in_array関数とは、配列に指定した値があればtrue、なければfalseを返す関数です。

in_array関数は

オプション設定なし
オプション設定あり

の合計2パターンの使い方があります。
それぞれ解説します。

パターン1：オプション設定なし

オプションを設定しない場合は、配列から指定した値があるかどうか確認し結果をboolで返します。
注意点は型まで厳密に見ていないことです。
in_array関数は

第一引数：探したい値
第二引数：配列

を指定して使います。
使い方サンプルは、以下になります。

$sample = [1, 2, 3];
$result = in_array('2', $sample);

1 2	$sample = [1, 2, 3]; $result = in_array('2', $sample);

上記の例だと、変数resultにはtrueが返されます。

パターン2：オプション設定あり

オプションを設定する場合は、配列から指定した値があるかどうか確認し結果をboolで返します。
パターン1と異なる点は、型まで厳密に見ることです。
in_array関数は

第一引数：探したい値
第二引数：配列
第三引数：厳密にするかどうかをboolで指定

を指定して使います。
第三引数にtrueを指定したとき、厳密に見ます。

使い方サンプルは、以下になります。

$sample = [1, 2, 3];
$result = in_array('2', $sample, true);

1 2	$sample = [1, 2, 3]; $result = in_array('2', $sample, true);

上記の例だと、変数resultにはfalseが返されます。

では、次の章で実際に使ってみます。

in_array関数を解説するプログラムの概要

in_array関数を解説するプログラムでは、配列の要素の値が同じでもint型とstring型の2種類の配列を用意します。
2種類の配列に対して

オプション設定なし
オプション設定あり

の2パターンでin_array関数を使い、結果を表示させます。
phpプログラムは

C:\xampp\htdocs

配下に、【inarraysample.php】というファイル名で格納しています。

PHPサンプルプログラム

<?php
	print('■in_array関数サンプル<br />');
	$int_array = [1, 2, 3, 4];
	$str_array = ['1', '2', '3', '4'];
	print('<br >');

	print('・オプション設定なし<br >');
	if (in_array(2, $int_array)){
		print('int_arrayに2の要素がある<br >');
	} else {
		print('int_arrayに2の要素がない<br >');
	}

	if (in_array(2, $str_array)){
		print('str_arrayに2の要素がある<br >');
	} else {
		print('str_arrayに2の要素がない<br >');
	}
	print('<br >');

	print('・オプション設定あり<br >');
	if (in_array(2, $int_array, true)){
		print('int_arrayにint型の2の要素がある<br >');
	} else {
		print('int_arrayにint型の2の要素がない<br >');
	}

	if(in_array(2, $str_array, true)){
		print('str_arrayにint型の2の要素がある<br >');
	} else {
		print('str_arrayにint型の2の要素がない<br >');
	}
?>

<?php

print('■in_array関数サンプル ');

$int_array = [1, 2, 3, 4];

$str_array = ['1', '2', '3', '4'];

print(' ');

print('・オプション設定なし ');

if (in_array(2, $int_array)){

print('int_arrayに2の要素がある ');

} else {

print('int_arrayに2の要素がない ');

}

if (in_array(2, $str_array)){

print('str_arrayに2の要素がある ');

} else {

print('str_arrayに2の要素がない ');

}

print(' ');

print('・オプション設定あり ');

if (in_array(2, $int_array, true)){

print('int_arrayにint型の2の要素がある ');

} else {

print('int_arrayにint型の2の要素がない ');

}

if(in_array(2, $str_array, true)){

print('str_arrayにint型の2の要素がある ');

} else {

print('str_arrayにint型の2の要素がない ');

}

実行結果

XAMPPを起動して、【http://localhost/inarraysample.php】のURLにアクセスします。

XAMPPでPHPの動かし方については、こちらの記事をご参考ください。

XAMPPでPHPの動かし方を解説します

PHPのin_array関数を解説

オプションを設定していると型チェックも含めて、設定していなければ値のみで指定した値の存在確認が行われていることが確認できました。

まとめ：in_array関数を使ってみよう！

以上がin_array関数についての解説でした。

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ