PHP reset() Function
Topic: PHP Array ReferencePrev|Next
Description
The reset() function set the internal pointer of an array to its first element, and returns its value.
The following table summarizes the technical details of this function.
| Return Value: | Returns the value of the first element in the array, or FALSE if the array is empty. |
|---|---|
| Version: | PHP 4+ |
Tip: Every array has an internal pointer that points to the current element in the array. When a new array is created, the current pointer is initialized reference the first element in the array.
Syntax
The basic syntax of the reset() function is given with:
The following example shows the reset() function in action.
Example
Run this code »<?php
// Sample array
$colors = array("red", "green", "blue", "orange", "yellow", "black");
// Getting the values
echo current($colors); // Prints: red
echo next($colors); // Prints: green
echo reset($colors); // Prints: red
?>Parameters
The reset() function accepts the following parameters.
| Parameter | Description |
|---|---|
| array | Required. Specifies the array to work on. |
More Examples
Here're some more examples showing how reset() function actually works:
The following example demonstrates how to get the first value from an associative array:
Example
Run this code »<?php
// Sample array
$alphabets = array("a"=>"apple", "b"=>"ball", "c"=>"cat", "d"=>"dog");
// Getting the element's values
echo current($alphabets); // Prints: apple
echo next($alphabets); // Prints: ball
echo reset($alphabets); // Prints: apple
// Getting the first element's key
echo key($alphabets); // Prints: a
?>The reset() function is commonly used along with the following functions:
current()– Returns the value of the current element in an array.next()– Moves the internal pointer of an array to the next element, and returns its value.prev()– Moves the internal pointer of an array to the previous element, and returns its value.end()– Moves the internal pointer of an array to its last element, and returns its value.key()– Returns the key of the current element in an array.
Here's an example that demonstrates how these functions basically work:
Example
Run this code »<?php
// Sample array
$colors = array("red", "green", "blue", "orange", "yellow", "black");
// Getting the values
echo current($colors); // Prints: red
echo next($colors); // Prints: green
echo current($colors); // Prints: green
echo end($colors); // Prints: black
echo current($colors); // Prints: black
echo prev($colors); // Prints: yellow
echo current($colors); // Prints: yellow
echo reset($colors); // Prints: red
echo current($colors); // Prints: red
// Getting the current element's key
echo key($colors); // Prints: 0
?>
