next
(PHP 4, PHP 5, PHP 7, PHP 8)
next — Advance the internal pointer of an array
Description
next() behaves like current(), with one difference. It advances the internal array pointer one place forward before returning the element value. That means it returns the next array value and advances the internal array pointer by one.
Parameters
-
array -
The array being affected.
Return Values
Returns the array value in the next place that's pointed to by the
internal array pointer, or false if there are no more elements.
This function may
return Boolean false, but may also return a non-Boolean value which
evaluates to false. Please read the section on Booleans for more
information. Use the ===
operator for testing the return value of this
function.
Changelog
| Version | Description |
|---|---|
| 8.1.0 | Calling this function on objects is deprecated. Either use get_mangled_object_vars() on the object first, or use ArrayIterator. |
Examples
Example #1 Example use of next() and friends
<?php
$transport = array('foot', 'bike', 'car', 'plane');
$mode = current($transport); // $mode = 'foot';
$mode = next($transport); // $mode = 'bike';
$mode = next($transport); // $mode = 'car';
$mode = prev($transport); // $mode = 'bike';
$mode = end($transport); // $mode = 'plane';
?>
Notes
Note: The end of an array is indistinguishable from a bool
falseelement. To properly traverse an array which may containfalseelements, see theforeachfunction. To still use next() and properly check if the end of the array has been reached, verify that the key() isnull.
See Also
- current() - Return the current element in an array
- end() - Set the internal pointer of an array to its last element
- prev() - Rewind the internal array pointer
- reset() - Set the internal pointer of an array to its first element
- each() - Return the current key and value pair from an array and advance the array cursor
