current

(PHP 4, PHP 5)

current — Retorna o elemento corrente em um array

Descrição

mixed current ( array &$array )

Todo array tem um ponteiro interno para o elemento "atual", o qual é inicializado para apontar para o primeiro elemento inserido em um array.

Parâmetros

array: O array.

Valor Retornado

A função current() simplesmente retorna o elemento do array para o qual esse ponteiro interno está apontando. Não move o ponteiro de forma alguma. Se o ponteiro interno estiver apontando para além do final da lista de elementos ou o array é vazio, current() retorna FALSE.

Aviso

Esta função pode retornar o booleano FALSE, mas também pode retornar um valor não-booleano que pode ser avaliado como FALSE, como 0 ou "". Leia a seção em Booleanos para maiores informações. Utilize o operador === para testar o valor retornado por esta função.

Exemplos

Exemplo #1 Exemplo do uso de current() e amigos


<?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) { }
?>

Notas

Nota: Você não será capaz de distinguir o fim de um array de um elemento boolean FALSE. Para percorer um array que pode conter elementos FALSE, veja a função each().

Veja Também

end() - Faz o ponteiro interno de um array apontar para o seu último elemento
key() - Retorna uma chave de um array
each() - Retorna o par chave/valor corrente de um array e avança o seu cursor
prev() - Retrocede o ponteiro interno de um array
reset() - Faz o ponteiro interno de um array apontar para o seu primeiro elemento
next() - Avança o ponteiro interno de um array