reset

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

resetReinicia el puntero interno del array al principio

Descripción

reset(array|object &$array): mixed

reset() reemplaza el puntero del array array al primer elemento y devuelve el valor del primer elemento.

Parámetros

array

El array de entrada.

Valores devueltos

Devuelve el valor del primer elemento del array, o false si el array está vacío.

Advertencia

Esta función puede devolver el valor booleano false, pero también puede devolver un valor no booleano que se evalúa como false. Por favor lea la sección sobre Booleanos para más información. Use el operador === para comprobar el valor devuelto por esta función.

Historial de cambios

Versión Descripción
8.1.0 Calling this function on objets is deprecated. Either convert the objet to an tableau using get_mangled_object_vars() first, or use the methods provided by a class that implements Iterator, such as ArrayIterator, instead.
7.4.0 Instances of SPL classes are now treated like empty objects that have no properties instead of calling the Iterator method with the same name as this function.

Ejemplos

Ejemplo #1 Ejemplo con reset()

<?php

$array
= array('step one', 'step two', 'step three', 'step four');

// Por omisión, el puntero está en el primer elemento
echo current($array) . "<br />\n"; // "step one"

// se saltan dos elementos
next($array);
next($array);
echo
current($array) . "<br />\n"; // "step three"

// se reinicia el puntero al principio
reset($array);
echo
current($array) . "<br />\n"; // "step one"

?>

Notas

Nota: El valor devuelto para un array vacío no es distinguible del valor devuelto para un array que contiene un valor bool false como primer elemento. Para verificar correctamente el valor del primer elemento de un array, que puede contener un elemento false, se debe primero verificar el count() del array, o verificar si la key() no es null, después de haber llamado reset().

Ver también

  • current() - Devuelve el elemento actual del array
  • each() - Devuelve cada par clave/valor de un array
  • end() - Posiciona el puntero del array al final del array
  • next() - Avance el puntero interno de un array
  • prev() - Retrocede el puntero actual del array
  • array_key_first() - Recupera la primera clave de un array