php man page for current

Query: current

OS: php

Section: 3

Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar

CURRENT(3)								 1								CURRENT(3)

current - Return the current element in an array

SYNOPSIS
mixed current (array &$array)
DESCRIPTION
Every array has an internal pointer to its "current" element, which is initialized to the first element inserted into the array.
PARAMETERS
o $array - The array.
RETURN VALUES
The current(3) 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(3) returns FALSE. Warning 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.
EXAMPLES
Example #1 Example use of current(3) 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 You won't be able to distinguish the end of an array from a boolean FALSE element. To properly traverse an array which may contain FALSE elements, see the each(3) function.
SEE ALSO
end(3), key(3), each(3), prev(3), reset(3), next(3). PHP Documentation Group CURRENT(3)
Related Man Pages
array_map(3) - php
array_filter(3) - php
isset(3) - php
collator_asort(3) - php
current(3) - php
Similar Topics in the Unix Linux Community
accessing my first element of array
function return array
Checking an array for NULL in C++
Integer array length
Need a Bash script for iterating thru an array and running a command