prev
(PHP 4, PHP 5, PHP 7, PHP 8)
prev — Rewind the internal array pointer
Description
Rewind the internal array pointer.
prev() behaves just like next(), except it rewinds the internal array pointer one place instead of advancing it.
Parameters
-
array -
The input array.
Return Values
Returns the array value in the previous 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 prev() 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 beginning of an array is indistinguishable from a bool
falseelement. To make the distinction, check that the key() of the prev() element is notnull.
See Also
- current() - Return the current element in an array
- end() - Set the internal pointer of an array to its last element
- next() - Advance the internal pointer of an array
- 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
