An easier way to unpack nested array elements
$array = [
[1, 2],
[3, 4],
];
foreach ($array as [$a, $b]) {
echo "A: $a; B: $b\n";
}
(PHP 4, PHP 5, PHP 7, PHP 8)
O construtor foreach fornece uma maneira fácil de
iterar sobre arrays e objetos Traversable.
O foreach emitirá um erro quando usado com
uma variável contendo um tipo de dado diferente ou com uma variável não inicializada.
foreach pode, opcionalmente, obter a chave (key) de cada elemento:
foreach (expressão_iterável as $valor) {
lista_de_instruções
}
foreach (expressão_iterável as $chave => $valor) {
lista_de_instruções
}
A primeira forma percorre o iterável dado por
iterable_expression. A cada iteração, o valor
do elemento atual é atribuído a $valor.
A segunda forma var, adicionalmente, atribuir a chave do elemento corrente a
variável $chave a cada iteração.
Note que o foreach não modifica o ponteiro interno
do array, que é usado por funções como current()
e key().
É possível customizar a iteração em objetos.
Exemplo #1 Usos comuns de foreach
<?php
/* Exemplo: somente valor */
$array = [1, 2, 3, 17];
foreach ($array as $value) {
echo "Elemento atual de \$array: $value.\n";
}
/* Exemplo: chave e valor */
$array = [
"um" => 1,
"dois" => 2,
"três" => 3,
"dezessete" => 17
];
foreach ($array as $key => $value) {
echo "Chave: $key => Valor: $value\n";
}
/* Exemplo: arrays chave-valor multidimensionais */
$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 "Valor na posição x=$x e y=$y: $value\n";
}
}
/* Exemplo: arrays dinâmicos */
foreach (range(1, 5) as $value) {
echo "$value\n";
}
?>Nota:
foreachnão suporta a capacidade de supressão de mensagens de erro usando o operador@.
(PHP 5 >= 5.5.0, PHP 7, PHP 8)
É possível iterar sobre um array de arrays e desempacotar o array aninhado
em variáveis do laço usando
desestruturação de array
através de [] ou usando o contrutor de linguagem list()
como o valor.
Nota: Observe que desestruturação de array através de
[]só é possível a partir do PHP 7.1.0.
Em ambos os exemplos a seguir, $a será definida para
o primeiro elemento do array aninhado e $b
conterá o segundo elemento:
<?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";
}
?>O exemplo acima produzirá:
A: 1; B: 2 A: 3; B: 4
Ao fornecer menos variáveis que o número de elementos no array, os elementos restantes serão ignorados. Da mesma forma, elementos podem ser pulados usando uma vírgula:
<?php
$array = [
[1, 2, 3],
[3, 4, 6],
];
foreach ($array as [$a, $b]) {
// Observe que não existe $c aqui.
echo "$a $b\n";
}
foreach ($array as [, , $c]) {
// Pulando $a e $b
echo "$c\n";
}
?>O exemplo acima produzirá:
1 2 3 4 5 6
Um aviso será gerado se não houver elementos suficientes no array para o preenchimento do construtor list():
<?php
$array = [
[1, 2],
[3, 4],
];
foreach ($array as [$a, $b, $c]) {
echo "A: $a; B: $b; C: $c\n";
}
?>O exemplo acima produzirá:
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:
É possível modificar elementos de array diretamente dentro de um laço precedendo
$value com &.
Neste caso, o valor será atribuído por
referência.
<?php
$arr = [1, 2, 3, 4];
foreach ($arr as &$value) {
$value = $value * 2;
}
// $arr agora é [2, 4, 6, 8]
unset($value); // quebra a referência com o último elemento
?>
A referência a um $value do último elemento do array
permanece mesmo depois do laço foreach. É recomendado
destruir essas referências usando unset().
Caso contrário, o comportamento a seguir irá ocorrer:
<?php
$arr = [1, 2, 3, 4];
foreach ($arr as &$value) {
$value = $value * 2;
}
// $arr agora é [2, 4, 6, 8]
// sem um unset($value), $value ainda é uma referência ao último item: $arr[3]
foreach ($arr as $key => $value) {
// $arr[3] será atualizado com cada valor de $arr...
echo "{$key} => {$value} ";
print_r($arr);
}
// ...até finalmente o penúltimo valor ser copiado no último valor
?>O exemplo acima produzirá:
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 )
Exemplo #2 Iterando valores de um array constante por referência
<?php
foreach ([1, 2, 3, 4] as &$value) {
$value = $value * 2;
}
?>An easier way to unpack nested array elements
$array = [
[1, 2],
[3, 4],
];
foreach ($array as [$a, $b]) {
echo "A: $a; B: $b\n";
}