PHP マニュアル: foreach

foreach

foreach は、配列と Traversable オブジェクトを反復処理する簡単な方法を提供します。それらと異なるデータ型や、未初期化の変数と一緒に foreach を使うと、エラーが発生します。

foreach は、オプションで以下のようにして要素ごとの key も取得できます。

foreach (iterable_expression as $value) {
    statement_list
}

foreach (iterable_expression as $key => $value) {
    statement_list
}

最初の形式は、iterable_expression で指定した反復可能な値に関してループ処理を行います。各反復において現在の要素の値が $valueに代入されます。

2番目の形式は、さらに各反復で現在の要素のキーを変数 $keyに代入します。

foreach は、 current や key のような関数で使われる、内部的な配列のポインタを変更しない点に注意して下さい。

オブジェクトの反復処理をカスタマイズすることもできます。

例1 一般的な foreach の使用法

<?php

echo "Value only\n";
$array = [1, 2, 3, 17];

foreach ($array as $value) {
    echo "Current element of \$array: $value.\n";
}

echo "\n\nKey and value:\n";
$array = [
    "one" => 1,
    "two" => 2,
    "three" => 3,
    "seventeen" => 17
];

foreach ($array as $key => $value) {
    echo "Key: $key => Value: $value\n";
}

echo "\n\nMulti-dimensional key-value arrays:\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 "Value at position x=$x and y=$y: $value\n";
    }
}

echo "\n\nDynamic arrays:\n";
foreach (range(1, 5) as $value) {
    echo "$value\n";
}

上の例の出力は以下となります。

Value only
Current element of $array: 1.
Current element of $array: 2.
Current element of $array: 3.
Current element of $array: 17.


Key and value:
Key: one => Value: 1
Key: two => Value: 2
Key: three => Value: 3
Key: seventeen => Value: 17


Multi-dimensional key-value arrays:
Value at position x=0 and y=0: a
Value at position x=1 and y=0: b
Value at position x=0 and y=1: y
Value at position x=1 and y=1: z


Dynamic arrays:
1
2
3
4
5

注意:
foreach は、 @ を使ってエラーメッセージを抑制する機能はサポートしていません。

ネストした配列のアンパック

配列の配列を反復処理し、ネストした配列をループ変数に展開させることができます。配列の分解を [] で行うか、list 言語構造を反復処理の値として指定します。

注意: [] による配列の分解処理は、PHP 7.1.0 以降でのみ利用可能である点に注意しましょう。

以下の例は両方、 $a にネストされた配列の最初の要素が設定され、 $b には二番目の要素が含まれます:

<?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, 5],
    [3, 4, 6],
];

foreach ($array as [$a, $b]) {
    // Note that there is no $c here.
    echo "$a $b\n";
}

foreach ($array as [, , $c]) {
    // Skipping over $a and $b
    echo "$c\n";
}

上の例の出力は以下となります。

以下のように、list を埋めるだけの十分な要素数が配列にない場合、警告が発生します:

<?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:

foreach とリファレンス

ループ中で、 $value の前に & をつけることで、配列の要素を直接変更することができます。この場合、値はリファレンスとして代入されます。

<?php
$arr = [1, 2, 3, 4];
foreach ($arr as &$value) {
    $value = $value * 2;
}
// $arr is now [2, 4, 6, 8]
var_dump($arr);
unset($value); // break the reference with the last element

上の例の出力は以下となります。

array(4) {
  [0]=>
  int(2)
  [1]=>
  int(4)
  [2]=>
  int(6)
  [3]=>
  &int(8)
}

警告

配列の最後の要素の $value へのリファレンスは、 foreach が終了した後も残ったままです。このリファレンスは unset することをお勧めします。そうしないと、以下のようなことが起きてしまいます:

<?php
$arr = [1, 2, 3, 4];
foreach ($arr as &$value) {
    $value = $value * 2;
}
// $arr は現在 [2, 4, 6, 8]
var_dump($arr);

// unset($value) しないと、$value はまだ最後の要素 $arr[3] を指した状態のままです

echo "\nAnother loop:\n";
foreach ($arr as $key => $value) {
    // $arr[3] は $arr の値ごとに更新され続けてしまいます...
    echo "{$key} => {$value}\n";
}
// ...最終的に、最後から2番目の値が最後の値にコピーされるまで
var_dump($arr);

上の例の出力は以下となります。

array(4) {
  [0]=>
  int(2)
  [1]=>
  int(4)
  [2]=>
  int(6)
  [3]=>
  &int(8)
}

Another loop:
0 => 2
1 => 4
2 => 6
3 => 6
array(4) {
  [0]=>
  int(2)
  [1]=>
  int(4)
  [2]=>
  int(6)
  [3]=>
  &int(6)
}

例2 定数の配列の値を、リファレンスで反復処理する

<?php
foreach ([1, 2, 3, 4] as &$value) {
    $value = $value * 2;
    echo $value . "\n";
}

上の例の出力は以下となります。

参考

array
Traversable
iterable
list