|  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #80541 Using a reference as iterator variable turns the whole array into a reference
Submitted: 2020-12-22 09:54 UTC Modified: -
From: andre at webkr dot de Assigned:
Status: Open Package: Arrays related
PHP Version: 8.0.0 OS:
Private report: No CVE-ID: None
Have you experienced this issue?
Rate the importance of this bug to you:

 [2020-12-22 09:54 UTC] andre at webkr dot de
I'm not sure whether this is a bug or a documentation bug. I'd consider it a bug but given the promise of backwards compatibility it's unlikely to be fixed.

If the iterator variable in a foreach is a reference, then the whole array becomes a reference and it is no longer safe to append to the array. This is true even when the iterator variable is not actually used anywhere.

At least this behavior should be documented. The documentation currently says:

> In order to be able to directly modify array elements within the loop precede $value with &. In that case the value will be assigned by reference.

It says nothing about the array itself, only about the array values, reenforcing the wrong impression that it is still safe to add or remove array elements.

Test script:
$arr = ['a','b','c'];

foreach ($arr as &$dummy)
    $arr []= 'foo';


Expected result:
array(6) {
  string(1) "a"
  string(1) "b"
  string(1) "c"
  string(3) "foo"
  string(3) "foo"
  string(3) "foo"

Actual result:
Fatal error: Allowed memory size of [...] bytes exhausted


Add a Patch

Pull Requests

Add a Pull Request


AllCommentsChangesGit/SVN commitsRelated reports
 [2021-02-16 06:29 UTC] jeanettegomez17 at gmail dot com
To create an array, you have to declare a variable with an array type and then create the array itself. As explained in Section 7.2, array variables contain references to arrays.
 [2021-05-24 00:20 UTC] a3ron223 at gmail dot com
The foreach function will continue to run until it has reached the end of the array.
If the foreach function adds another key to the array every time it runs, then it will not stop running (until it exhausts the script's memory).

I'm a little surprised that it isn't documented.
PHP Copyright © 2001-2021 The PHP Group
All rights reserved.
Last updated: Sat Jun 19 07:01:23 2021 UTC