Retrocede o ponteiro interno de um array

(PHP 4, PHP 5, PHP 7, PHP 8)

prev — Retrocede o ponteiro interno de um array

Descrição

prev(array|object &$array): mixed

Retrocede o ponteiro interno do array.

prev() funciona como next(), exceto que ela retrocede o ponteiro interno do array ao invés de avançá-lo.

Parâmetros

array: O array de entrada.

Valor Retornado

Retorna o valor do array que está na posição anterior à posição apontada pelo ponteiro interno, ou false se não houver mais elementos.

Warning

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.

Registro de Alterações

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.

Exemplos

Example #1 Exemplo de uso de prev() e funções relacionadas

<?php
$transport = array('foot', 'bike', 'car', 'plane');
$mode = current($transport); // $mode = 'foot';
$mode = next($transport);    // $mode = 'bike';
$mode = next($transport);    // $mode = 'car';
$mode = prev($transport);    // $mode = 'bike';
$mode = end($transport);     // $mode = 'plane';
?>

Notas

Note: Não será possível distinguir entre o início de um array e um elemento bool false. Para que seja possível identificar o início do array, deve ser verificado se a key() do elemento prev() não é null.

Veja Também

current() - Retorna o elemento atual em um array
end() - Define o ponteiro interno de um array para seu último elemento
next() - Avança o ponteiro interno de um array
reset() - Faz o ponteiro interno de um array apontar para o seu primeiro elemento
each() - Retorna o par atual de chave e valor de um array e avança o seu cursor