Return the current key and value pair from an array and advance the array cursor (original) (raw)

each

(PHP 4, PHP 5, PHP 7)

each — Return the current key and value pair from an array and advance the array cursor

Warning

This function has been_DEPRECATED_ as of PHP 7.2.0. Relying on this function is highly discouraged.

Description

each ( array &$array ) : array

After each() has executed, the array cursor will be left on the next element of the array, or past the last element if it hits the end of the array. You have to usereset() if you want to traverse the array again using each.

Parameters

array

The input array.

Return Values

Returns the current key and value pair from the arrayarray. This pair is returned in a four-element array, with the keys 0, 1,key, and value. Elements0 and key contain the key name of the array element, and 1 and value contain the data.

If the internal pointer for the array points past the end of the array contents, each() returns**FALSE**.

Examples

Example #1 each() examples

<?php $foo = array("bob", "fred", "jussi", "jouni", "egon", "marliese"); <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>b</mi><mi>a</mi><mi>r</mi><mo>=</mo><mi>e</mi><mi>a</mi><mi>c</mi><mi>h</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">bar = each(</annotation></semantics></math>bar=each(foo); print_r($bar); ?>

$bar now contains the following key/value pairs:

Array ( [1] => bob [value] => bob [0] => 0 [key] => 0 )

<?php $foo = array("Robert" => "Bob", "Seppo" => "Sepi"); <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>b</mi><mi>a</mi><mi>r</mi><mo>=</mo><mi>e</mi><mi>a</mi><mi>c</mi><mi>h</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">bar = each(</annotation></semantics></math>bar=each(foo); print_r($bar); ?>

$bar now contains the following key/value pairs:

Array ( [1] => Bob [value] => Bob [0] => Robert [key] => Robert )

each() is typically used in conjunction withlist() to traverse an array, here's an example:

Example #2 Traversing an array with each()

<?php <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>f</mi><mi>r</mi><mi>u</mi><mi>i</mi><mi>t</mi><mo>=</mo><mi>a</mi><mi>r</mi><mi>r</mi><mi>a</mi><mi>y</mi><msup><mo stretchy="false">(</mo><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><msup><mi>a</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mo>=</mo><msup><mo>></mo><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mi>a</mi><mi>p</mi><mi>p</mi><mi>l</mi><msup><mi>e</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><msup><mo separator="true">,</mo><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><msup><mi>b</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mo>=</mo><msup><mo>></mo><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mi>b</mi><mi>a</mi><mi>n</mi><mi>a</mi><mi>n</mi><msup><mi>a</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><msup><mo separator="true">,</mo><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><msup><mi>c</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mo>=</mo><msup><mo>></mo><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mi>c</mi><mi>r</mi><mi>a</mi><mi>n</mi><mi>b</mi><mi>e</mi><mi>r</mi><mi>r</mi><msup><mi>y</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mo stretchy="false">)</mo><mo separator="true">;</mo><mi>r</mi><mi>e</mi><mi>s</mi><mi>e</mi><mi>t</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">fruit = array('a' => 'apple', 'b' => 'banana', 'c' => 'cranberry');reset(</annotation></semantics></math>fruit=array(′a′=>′apple′,′b′=>′banana′,′c′=>′cranberry′);reset(fruit); while (list($key, <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>v</mi><mi>a</mi><mi>l</mi><mo stretchy="false">)</mo><mo>=</mo><mi>e</mi><mi>a</mi><mi>c</mi><mi>h</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">val) = each(</annotation></semantics></math>val)=each(fruit)) { echo "$key => $val\n"; } ?>

The above example will output:

a => apple b => banana c => cranberry

Caution

Because assigning an array to another variable resets the original array's pointer, our example above would cause an endless loop had we assigned $fruit to another variable inside the loop.