(PHP 4, PHP 5, PHP 7)
current — Return the current element in an array
current ( array|object $array ) : mixed
Every array has an internal pointer to its "current" element, which is initialized to the first element inserted into the array.
array
The array.
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.
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.
| Version | Description |
|---|---|
| 7.0.0 | array is now always passed by value. Prior to this version, it was passed by reference if possible, and by value otherwise. |
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) { }
?> 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
falseelement. To properly traverse an array which may containfalseelements, see the foreach() function. 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 fromnull.
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.current.php