Invalid argument supplied for foreach()の原因と対処法を解説

システム
エンジニア

PHPを使っていて「Invalid argument supplied for foreach()」というエラーが出て困っているのですが、どうすればいいですか。

プロジェクト
マネージャー

そのエラーはforeach文に渡された引数が間違っているという意味です。

Invalid argument supplied for foreach()とは？

PHPで「Invalid argument supplied for foreach()」というエラーが出て困っている人は多いのではないでしょうか。このエラーの出る理由とその直し方についてこの記事で解説しましょう。

なおPHPとは「Personal Home Page」の略で、サーバサイドの処理をHTMLに埋め込むことができるプログラム言語です。JavaScriptのような感覚でサーバサイド処理を記述できてとても手軽で便利なので広く普及しています。

PHPのforeach文とは？

「Invalid argument supplied for foreach()」とはforeach文に渡された引数が間違っているという意味です。foreach文とは何なのでしょうか。foreach文はfor文やwhile文のように繰り返し処理をする命令文です。

ただしforeach文はfor文やwhile文と違い、引数で渡された配列の数だけ繰り返して、その配列の中身に対して処理を行う機能があります。例えば以下のようにすると、

$members = array(“太郎”, “次郎”, “花子”);
foreach($members as $hito){
echo $hito . “<br>”;
}

ブラウザには以下のように表示されます。

太郎
次郎
花子

foreach文は多次元配列も使える

foreach文は多次元配列も使えます。以下のサンプルを実行すると、

$members = [
[“太郎”, 21],
[“次郎”, 15],
[“花子”, 26],
];

foreach ($members as $val) {
echo $val[0] . ” は ” . $val[1] . ” 歳です。<br>”;
}

以下のように表示されます。

太郎 は 21 歳です。
次郎 は 15 歳です。
花子 は 26 歳です。

なおこのarray()を使わない記述は短縮構文と言いますが、使えるのはPHPのバージョン5.4以降なのでご注意下さい。

foreach文は連想配列も使える

foreach文には連想配列も使うことができます。連想配列とは2つの値をセットにして格納することができる配列です。以下がそのサンプルです。=>で2つの値をセットにしています。

$members = array(“太郎”=>”大学生”, “次郎”=>”中学生”, “花子”=>”社会人”);
foreach($members as $name => $status){
echo $name . ” は ” . $status . ” です。<br>”;
}

実行すると以下のように表示されます。

太郎 は 大学生 です。
次郎 は 中学生 です。
花子 は 社会人 です。

「Invalid argument supplied for foreach()」が発生する理由

前置きが長くなりましたが、それでは「Invalid argument supplied for foreach()」がなぜ出るのかについて解説しましょう。foreach文の構文は、

foreach (配列変数 as 要素を1つ入れる変数)

となっています。「Invalid argument supplied for foreach()」はこの配列変数を入れるはずのasの前の変数が、配列変数ではなかった時かnullだった時に発生するのです。

foreachの引数が配列でないかnullだった場合にエラーになる

以下の場合は$membersが配列ではないため「Invalid argument supplied for foreach()」が発生します。

$members = “太郎”;
foreach($members as $hito){
echo $hito . “<br>”;
}

上のサンプルで$membersがnullだった場合も「Invalid argument supplied for foreach()」が発生します。

エラーへの対策方法

foreachは、配列とオブジェクトだけを対象としており、初期化前の変数、あるいは別のデータ型に対して使ってしまうとエラーになる仕様になっています。これにひっかかっているということです。

ではどのように対策すればよいのでしょうか。以下のように、nullチェックと「配列かどうかチェック」を入れればエラーは防げます。

if ($members != null && is_array($array)) {
foreach($members as $hito){
echo $hito . “<br>”;
}
}

もっと簡単な解決方法

しかしforeach文の処理の前に毎回このチェックを入れるのは大変面倒です。もっと簡単な方法はないのでしょうか。実はあるのです。以下のようにすれば解決します。

foreach((array)$members as $hito){
echo $hito . “<br>”;
}

このようにforeachのasの前の変数を、(array)でキャストすれば「Invalid argument supplied for foreach()」を防げるのです。

array型でキャストすれば解決する

キャストとは指定した型で変数を扱うようにする処理です。(array)でキャストすることで、foreachに渡す変数が配列ではなかった場合でも、強制的に配列として扱うことができます。もし以下の場合、

$members = “太郎”;
foreach((array)$members as $hito){
echo $hito . “<br>”;
}

(array)によって$membersは”太郎”という要素を1つだけ持つ配列として扱われます。これは便利です。

nullにも対応できる

また以下のようにnullの場合は、

$members = “太郎”;
foreach((array)$members as $hito){
echo $hito . “<br>”;
}

$membersは中身が空の配列になります。以下と同じになるということです。

$members = array();

foreach文では必ず(array)でキャストするようにすれば、もう「Invalid argument supplied for foreach()」が出ることはなくなります。

(array)は根本的な解決にはならない

ただし(array)でキャストすることで解決した場合、foreach文の引数にnullや配列ではない変数が渡されるというバグはそのまま残ることになります。ですので根本的な解決にはなっていないと言えます。

そういった不具合があるPHPコードはより大きな問題を抱えている可能性もあるので、開発中やテストではむしろエラーを積極的に出すべきです。(array)でキャストするのは最終的にリリースする時の保険にした方が良いかもしれません。

エラーログを出力する

「Invalid argument supplied for foreach()」の理想的な対処法としては、以下のようにエラーログを出力するのが良いでしょう。error_logの2つ目の引数の0は、php.iniファイルの「error_log =」で指定したファイルに出力するという意味です。

if ($members != null && is_array($array)) {
foreach($members as $hito){
echo $hito . “<br>”;
}
} else {
error_log(“[“.date(‘Y-m-d H:i:s’).”]”.”$membersが不正な値でした。”, 0);
}

システム
エンジニア

foreachのasの前の変数を(array)でキャストしておけばエラーを防げるのですね。

プロジェクト
マネージャー

(array)でキャストして解決しても、それでは根本的な解決にはなっていません。不具合があるPHPコードは開発中やテストでエラーを積極的に出して、(array)でキャストするのは最終的にリリースする時の保険にした方がいいかもしれません。

Invalid argument supplied for foreach()は回避できる

「Invalid argument supplied for foreach()」の回避方法について解説しましたが、ご理解頂けましたでしょうか。

とりあえず(array)でキャストすることで簡単に回避することができますが、本来はforeachに渡される変数が正しくないという不具合を直す方が望ましいです。