foreach

(PHP 4, PHP 5)

foreach は、配列を反復処理するための便利な方法です。 foreach が使えるのは配列とオブジェクトだけであり、別のデータ型や初期化前の変数に対して使うとエラーになります。この構造には二種類の構文があります。

foreach (array_expression as $value)
    文
foreach (array_expression as $key => $value)
    文

最初の形式は、array_expressionで指定した配列に関してループ処理を行います。各反復において現在の要素の値が $valueに代入され、内部配列ポインタが一つ前に進められます。(よって、次の反復では次の要素を見ることになります。)

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

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

注意:
foreachの実行開始時に内部配列ポインタは、配列の先頭要素を指すように自動的にリセットされます。このため、foreachループの前に reset()をコールする必要はありません。

foreach は内部の配列ポインタに依存するので、ループ内で配列ポインタを変更すると予期せぬ振る舞いを引き起こします。

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


<?php
$arr = array(1, 2, 3, 4);
foreach ($arr as &$value) {
    $value = $value * 2;
}
// $arr は array(2, 4, 6, 8) となります
unset($value); // 最後の要素への参照を解除します
?>

$value の参照は、ループ処理される配列が参照可能である場合 (すなわち、変数である) のみ使用可能です。つまり、次のコードは動作しません。


<?php
foreach (array(1, 2, 3, 4) as &$value) {
    $value = $value * 2;
}
?>

警告

foreach ループを終えた後でも、 $value は配列の最後の要素を参照したままとなります。 unset() でその参照を解除しておくようにしましょう。

注意:
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";
}
?>