【PHP】配列から指定した値を検索し、キーを取得できるarray_search関数を解説します

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

この記事では、 PHPで配列から指定した値を検索し、キーを取得できるarray_search関数について

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

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

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

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

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

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

array_search関数とは

array_search関数とは、配列から指定した値を検索し、最初に見つかったキーを返す関数です。
見つからなかった場合は【false】を返します。

array_search関数の使い方は以下になります。

指定した引数は以下の意味をします。

第一引数(必須) 検索したい値
第二引数(必須) 検索する配列
第三引数(任意) 厳密にするかどうか

第三引数の厳密にするかどうかとは、値だけでなく型も同じであることをチェックするか?、を指定します。
上記のサンプルだと第一引数に指定したのは文字の「3」と一致する値を検索します。
配列には数値の「3」で値は同じであるものの、型が異なるため、resultには【false】が返ります。

指定するbool値の意味は下記の通りです。

trueを指定 型と値が一致している場合のみ、キーを返す
falseを場合 値が一致していれば、キーを返す
型は異なっていても良い

第三引数を指定しなかった場合のデフォルト値は【false】です。

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

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

array_search関数を解説するプログラムでは

  • オプションを設定しない
  • オプションを設定する
  • 連想配列で実施する

の3パターンでarray_search関数で配列から値を検索し、結果を表示させます。

phpプログラムは

C:\xampp\htdocs

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

PHPサンプルプログラム

実行結果

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

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

第三引数に指定した値によって、取得できたりできないことが確認できました!

まとめ:array_search関数を使ってみよう!

以上がarray_search関数についての解説でした!

あなたのご参考になったのなら、とても嬉しいです(*´▽`*)
ではでは~(・ω・)ノシ

コメント

タイトルとURLをコピーしました