(PHP 4, PHP 5, PHP 7, PHP 8)
reset — Faz o ponteiro interno de um array apontar para o seu primeiro elemento
reset() retrocede o ponteiro interno de array
para o primeiro elemento e retorna o valor do primeiro elemento do array.
array
O array de entrada.
Retorna o valor do primeiro elemento do array, ou false
se o array estiver vazio.
Esta função pode retornar o valor booleano false
, mas também pode retornar um valor não booleano que pode ser avaliado como false
. Leia a seção sobre Booleanos para mais informações. Use o operador === para testar o valor retornado por esta função.
Versão | Descrição |
---|---|
8.1.0 | Chamar esta função em objects tornou-se defasado. Converta o object para um array usando get_mangled_object_vars() primeiro ou, em vez disso, use os métodos fornecidos por uma classe que implementa Iterator, como ArrayIterator. |
7.4.0 | Instâncias de classes SPL agora são tratadas como objetos vazios que não possuem propriedades em vez de chamar o método da interface Iterator com o mesmo nome desta função. |
Exemplo #1 Exemplo da reset()
<?php
$array = array('primero passo', 'segundo passo', 'terceiro passo', 'quarto passo');
// por definição, o ponteiro está sobre o primeiro elemento
echo current($array)."<br />\n"; // "Primeiro passo"
// pula dois passos
next($array);
next($array);
echo current($array)."<br />\n"; // "passo três"
// reinicia o ponteiro, começa novamente o primeiro passo
reset($array);
echo current($array)."<br />\n"; // "primeiro passo"
?>
Nota: O valor retornado em um array vazio não é diferente de o valor retornado no caso de um array contendo um primeiro elemento bool
false
. Para verificar corretamente o primeiro elemento de um array que possa conter elementosfalse
, primeiro verifique se count() do array, ou verifique se key() não énull
, depois de chamar reset().