each
—
Return the current key and value pair from an array and advance the array cursor
Warning
This function has been
DEPRECATED
as of PHP 7.2.0, and
REMOVED
as of PHP 8.0.0. Relying on this function is highly discouraged.
Description
each(array|object&$array):array
Return the current key and value pair from an array and advance the array cursor.
After
each()
has executed, the array cursor will be left on the next element of the array, or past the last element if it hits the end of the array. You have to use
reset()
if you want to traverse the array again using each.
Parameters
array
The input array.
Return Values
Returns the current key and value pair from the array
array
. This pair is returned in a four-element array, with the keys
0
,
1
,
key
, and
value
. Elements
0
and
key
contain the key name of the array element, and
1
and
value
contain the data.
If the internal pointer for the array points past the end of the array contents,
each()
returns
false
.
Because assigning an array to another variable resets the original array's pointer, our example above would cause an endless loop had we assigned
$fruit
to another variable inside the loop.
Warning
each()
will also accept objects, but may return unexpected results. It's therefore not recommended to iterate though object properties with
each()
.
See Also
key() - Fetch a key from an array
list() - Assign variables as if they were an array
current() - Return the current element in an array
reset() - Set the internal pointer of an array to its first element
next() - Advance the internal pointer of an array
prev() - Rewind the internal array pointer
foreach
Object Iteration
PHP / end — DevDocs
end
(PHP 4, PHP 5, PHP 7, PHP 8)
end
—
Set the internal pointer of an array to its last element
Description
end(array|object&$array):mixed
end()
advances
array
's internal pointer to the last element, and returns its value.
Parameters
array
The array. This array is passed by reference because it is modified by the function. This means you must pass it a real variable and not a function returning an array because only actual variables may be passed by reference.
Return Values
Returns the value of the last element or
false
for empty array.
Changelog
Version
Description
8.1.0
Calling this function on
object
s is deprecated. Either use
get_mangled_object_vars()
on the
object
first, or use
ArrayIterator
.