reset

(PHP 4, PHP 5, PHP 7)

reset — 配列の内部ポインタを先頭の要素にセットする

説明

reset ( array &$array ) : mixed

reset() は、array の内部ポインタの先頭の要素に戻し、配列の最初の要素の値を返します。

パラメータ

array: 入力の配列。

返り値

配列の最初の要素の値を返します。配列が空の場合 FALSE を返します。

警告

この関数は論理値 FALSE を返す可能性がありますが、FALSE として評価される値を返す可能性もあります。詳細については論理値のセクションを参照してください。この関数の返り値を調べるには ===演算子を使用してください。

例

例1 reset() の例


<?php

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

// デフォルトでは、ポインタは先頭要素を指しています
echo current($array) . "<br />\n"; // "step one"

// 次の２ステップをとばします
next($array);
next($array);
echo current($array) . "<br />\n"; // "step three"

// ポインタをリセットし、再度ステップ１開始します
reset($array);
echo current($array) . "<br />\n"; // "step one"

?>

注意

注意: The return value for an empty array is indistinguishable from the return value in case of an array which has a boolean FALSE first element. To properly check the value of the first element of an array which may contain FALSE elements, first check the count() of the array, or check that key() is not NULL, after calling reset().

参考

current() - 配列内の現在の要素を返す
each() - 配列から現在のキーと値のペアを返して、カーソルを進める
end() - 配列の内部ポインタを最終要素にセットする
next() - 配列の内部ポインタを進める
prev() - 内部の配列ポインタをひとつ前に戻す
array_key_first() - Gets the first key of an array