pos()

pos() — Alias of current().

Built-in function of PHP 8.5. The manual lists it as available in PHP 4, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

pos() is an alias of current(): same parameters, same return value.

Signature

pos(array|object $array): mixed

Parameters

Return value

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.

Example

A runnable snippet:

$transport = array('foot', 'bike', 'car', 'plane'); echo $mode = current($transport), PHP_EOL; // $mode = 'foot'; echo $mode = next($transport), PHP_EOL; // $mode = 'bike'; echo $mode = current($transport), PHP_EOL; // $mode = 'bike'; echo $mode = prev($transport), PHP_EOL; // $mode = 'foot'; echo $mode = end($transport), PHP_EOL; // $mode = 'plane'; echo $mode = current($transport), PHP_EOL; // $mode = 'plane'; $arr = array(); var_dump(current($arr)); // bool(false) $arr = array(array()); var_dump(current($arr)); // array(0) { }

All PHP 8.5 built-in functions

Reference card built from the PHP manual page pos() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.