current
Return the current element in an array
Description
mixed current(arrayobject $array
)
Parameters
-
array
-
The array.
Return Values
The current function simply returns the
value of the array element that's currently being pointed to by the
internal pointer. It does not move the pointer in any way. If the
internal pointer points beyond the end of the elements list or the array is
empty, current returns false
.
WarningThis 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.
Examples
Example #1 Example use of current and friends
<?php
$transport = array('foot', 'bike', 'car', 'plane');
$mode = current($transport); // $mode = 'foot';
$mode = next($transport); // $mode = 'bike';
$mode = current($transport); // $mode = 'bike';
$mode = prev($transport); // $mode = 'foot';
$mode = end($transport); // $mode = 'plane';
$mode = current($transport); // $mode = 'plane';
$arr = array();
var_dump(current($arr)); // bool(false)
$arr = array(array());
var_dump(current($arr)); // array(0) { }
?>
Notes
Note:
The results of calling current on an empty array
and on an array, whose internal pointer points beyond the end of the elements,
are indistinguishable from a bool false
element.
To properly traverse an array which may contain false
elements, see the
foreach control structure.
To still use current and properly check if the value
is really an element of the array, the key
of the current element should be checked to be strictly
different from null
.
See Also
- end
- key
- each
- prev
- reset
- next
- foreach