(PHP 4, PHP 5, PHP 7, PHP 8)
foreach 構文は、array や Traversable オブジェクトを簡単に反復処理する方法を提供します。
それらと別のデータ型を含む変数や、初期化されていない変数とともに使用するとエラーになります。
foreach は、各要素の key をオプションで取得できます:
foreach (iterable_expression as $value) {
文のリスト
}
foreach (iterable_expression as $key => $value) {
文のリスト
}
最初の形式は、iterable_expression で指定した反復可能な値に
関してループ処理を行います。各反復において現在の要素の値が
$valueに代入されます。
2番目の形式は、さらに各反復で現在の要素のキーを変数
$keyに代入します。
foreach は、
current() や
key()
のような関数で使われる、内部的な配列のポインタを変更しない点に注意して下さい。
オブジェクトの反復処理をカスタマイズ することもできます。
例1 一般的な foreach の使用法
<?php
/* 例: 値のみ */
$array = [1, 2, 3, 17];
foreach ($array as $value) {
echo "現在の \$array の要素: $value\n";
}
/* 例: キーと値 */
$array = [
"one" => 1,
"two" => 2,
"three" => 3,
"seventeen" => 17
];
foreach ($array as $key => $value) {
echo "キー: $key => 値: $value\n";
}
/* 例: 多次元のキーと値の配列 */
$grid = [];
$grid[0][0] = "a";
$grid[0][1] = "b";
$grid[1][0] = "y";
$grid[1][1] = "z";
foreach ($grid as $y => $row) {
foreach ($row as $x => $value) {
echo "x=$x, y=$y の位置の値: $value\n";
}
}
/* 例: 動的配列 */
foreach (range(1, 5) as $value) {
echo "$value\n";
}
?>注意:
foreachは、@による、エラーメッセージの出力を抑制する機能をサポートしていません。
(PHP 5 >= 5.5.0, PHP 7, PHP 8)
配列の配列を反復処理し、ネストされた配列をループ変数に展開することが可能です。
配列の分解
を [] で行うか、list() 言語構造の値として配列を指定します。
注意:
[]による 配列の分解 は、PHP 7.1.0 以降でのみ可能であることに注意してください。
次の例では、どちらも $a がネストされた配列の最初の要素に設定され、
$b が2番目の要素を含むようになります:
<?php
$array = [
[1, 2],
[3, 4],
];
foreach ($array as [$a, $b]) {
echo "A: $a; B: $b\n";
}
foreach ($array as list($a, $b)) {
echo "A: $a; B: $b\n";
}
?>上の例の出力は以下となります。
A: 1; B: 2 A: 3; B: 4
配列内の要素よりも少ない変数を指定すると、 残りの要素は無視されます。 同様に、カンマを使用して要素をスキップできます:
<?php
$array = [
[1, 2, 3],
[4, 5, 6],
];
foreach ($array as [$a, $b]) {
// ここに $c がないことに注意してください。
echo "$a $b\n";
}
foreach ($array as [, , $c]) {
// $a と $b をスキップ
echo "$c\n";
}
?>上の例の出力は以下となります。
1 2 3 4 5 6
list() で指定した変数を埋めるだけの要素が足りないときには、notice が発生します。
<?php
$array = [
[1, 2],
[3, 4],
];
foreach ($array as [$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:
ループ内で配列要素を直接変更するには、$value の前に & を付けます。
その場合、値はリファレンスによって代入されます。
<?php
$arr = [1, 2, 3, 4];
foreach ($arr as &$value) {
$value = $value * 2;
}
// $arr is now [2, 4, 6, 8]
unset($value); // 最後の要素へのリファレンスを解除する
?>
最後の配列要素の $value への参照は、foreach ループの後も残ります。
unset() を使ってこれらを破棄することをお勧めします。
そうしないと、以下のようなことが起こります:
<?php
$arr = [1, 2, 3, 4];
foreach ($arr as &$value) {
$value = $value * 2;
}
// $arr is now [2, 4, 6, 8]
// unset($value) しないと、$value はまだ最後の要素 $arr[3] への参照です
foreach ($arr as $key => $value) {
// $arr[3] は $arr の各値で更新されます...
echo "{$key} => {$value} ";
print_r($arr);
}
// ...最終的に、最後から2番目の値が最後の値にコピーされるまで
?>上の例の出力は以下となります。
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 )
例2 リファレンスによる、定数配列の値の反復処理
<?php
foreach ([1, 2, 3, 4] as &$value) {
$value = $value * 2;
}
?>