(PHP 4, PHP 5, PHP 7)
foreach は、配列を反復処理するための便利な方法です。 foreach が使えるのは配列とオブジェクトだけであり、 別のデータ型や初期化前の変数に対して使うとエラーになります。 この構造には二種類の構文があります。
foreach (array_expression as $value)
文
foreach (array_expression as $key => $value)
文
最初の形式は、array_expressionで指定した配列に 関してループ処理を行います。各反復において現在の要素の値が $valueに代入され、内部配列ポインタが一つ前に 進められます。(よって、次の反復では次の要素を見ることになります。)
2番目の形式は、さらに各反復で現在の要素のキーを変数 $keyに代入します。
オブジェクトの反復処理をカスタマイズ することもできます。
注意:
PHP 5 では、foreachの実行開始時に内部配列ポインタは、 配列の先頭要素を指すように自動的にリセットされます。 このため、foreachループの前に reset()をコールする必要はありません。
PHP 5 では、foreach は内部の配列ポインタに依存するので、 ループ内で配列ポインタを変更すると予期せぬ振る舞いを引き起こします。
PHP 7 では、foreach は内部の配列ポインタを使わなくなりました。
ループの中で配列の要素を直接変更したい場合は、 $value の前に & をつけます。こうすると、変数には リファレンス が代入されることになります。
<?php
$arr = array(1, 2, 3, 4);
foreach ($arr as &$value) {
$value = $value * 2;
}
// $arr は array(2, 4, 6, 8) となります
unset($value); // 最後の要素への参照を解除します
?>
foreach ループを終えた後でも、 $value は配列の最後の要素を参照したままとなります。 unset() でその参照を解除しておくようにしましょう。 さもないと、次のような目に遭うことになるでしょう。
<?php
$arr = array(1, 2, 3, 4);
foreach ($arr as &$value) {
$value = $value * 2;
}
// この時点で、$arr は array(2, 4, 6, 8) となります
// unset($value) しなければ、$value は今でも最後の要素 ($arr[3]) を指したままです
foreach ($arr as $key => $value) {
// $arr[3] が、$arr の各要素で上書きされて...
echo "{$key} => {$value} ";
print_r($arr);
}
// ...つまり、二番目から最後までの値が最後の値にコピーされていきます
// 出力
// 0 => 2 Array ( [0] => 2, [1] => 4, [2] => 6, [3] => 2 )
// 1 => 4 Array ( [0] => 2, [1] => 4, [2] => 6, [3] => 4 )
// 2 => 6 Array ( [0] => 2, [1] => 4, [2] => 6, [3] => 6 )
// 3 => 6 Array ( [0] => 2, [1] => 4, [2] => 6, [3] => 6 )
?>
PHP 5.5.0 より前のバージョンでは、$value の参照は、ループ処理される配列が参照可能である場合 (すなわち、 変数である) のみ使用可能です。次のコードは、PHP 5.5.0 以降でしか動作しません。
<?php
foreach (array(1, 2, 3, 4) as &$value) {
$value = $value * 2;
}
?>
注意:
foreach は、'@' によりエラーメッセージ出力を抑 制する機能をサポートしていません。
既にご存知かと思いますが、以下の文は機能的に等価です。
<?php
$arr = array("one", "two", "three");
reset($arr);
while (list(, $value) = each($arr)) {
echo "Value: $value<br />\n";
}
foreach ($arr as $value) {
echo "Value: $value<br />\n";
}
?>
以下の文も機能的に等価です。
<?php
$arr = array("one", "two", "three");
reset($arr);
while (list($key, $value) = each($arr)) {
echo "Key: $key; Value: $value<br />\n";
}
foreach ($arr as $key => $value) {
echo "Key: $key; Value: $value<br />\n";
}
?>
使用法を示すためにその他の例を示します。
<?php
/* foreach の例 1: 値のみ */
$a = array(1, 2, 3, 17);
foreach ($a as $v) {
echo "Current value of \$a: $v.\n";
}
/* foreachの例2: 値 (説明用に、手動でアクセスする際の表記を出力) */
$a = array(1, 2, 3, 17);
$i = 0; /* 説明用 */
foreach ($a as $v) {
echo "\$a[$i] => $v.\n";
$i++;
}
/* foreachの例3: キーと値 */
$a = array(
"one" => 1,
"two" => 2,
"three" => 3,
"seventeen" => 17
);
foreach ($a as $k => $v) {
echo "\$a[$k] => $v.\n";
}
/* foreach の例4: 多次元配列 */
$a = array();
$a[0][0] = "a";
$a[0][1] = "b";
$a[1][0] = "y";
$a[1][1] = "z";
foreach ($a as $v1) {
foreach ($v1 as $v2) {
echo "$v2\n";
}
}
/* foreach の例5: 動的配列 */
foreach (array(1, 2, 3, 4, 5) as $v) {
echo "$v\n";
}
?>
(PHP 5 >= 5.5.0, PHP 7)
PHP 5.5 からは、配列の配列の反復処理ができるようになりました。 値として list() を渡すと、 ネストした配列をループ変数に展開できます。
例を示します。
<?php
$array = [
[1, 2],
[3, 4],
];
foreach ($array as list($a, $b)) {
// $a にはネストした配列の最初の要素が含まれ、
// $b には二番目の要素が含まれます。
echo "A: $a; B: $b\n";
}
?>
上の例の出力は以下となります。
A: 1; B: 2 A: 3; B: 4
list() で指定する要素数を、ネストした配列の要素数より少なくしてもかまいません。 その場合は、配列の残りの要素は無視されます。
<?php
$array = [
[1, 2],
[3, 4],
];
foreach ($array as list($a)) {
// $b を指定していないことに注目。
echo "$a\n";
}
?>
上の例の出力は以下となります。
1 3
list() で指定した変数を埋めるだけの要素が足りないときには、notice が発生します。
<?php
$array = [
[1, 2],
[3, 4],
];
foreach ($array as list($a, $b, $c)) {
echo "A: $a; B: $b; C: $c\n";
}
?>
上の例の出力は以下となります。
Notice: Undefined offset: 2 in example.php on line 7 A: 1; B: 2; C: Notice: Undefined offset: 2 in example.php on line 7 A: 3; B: 4; C:
| バージョン | 説明 |
|---|---|
| 7.0.0 | foreach が内部の配列ポインタを使わなくなりました。 |
| 5.5.0 | 式から $value を参照できるようになりました。 これより前のバージョンでは、変数からの参照にだけ対応していました。 |
| 5.5.0 | ネストした配列の list() による展開に対応しました。 |