reset

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

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

説明

reset(array|object &$array): mixed

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

パラメータ

array: 入力の配列。

戻り値

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

警告

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

変更履歴

バージョン	説明
8.1.0	この関数を object に対してコールすることは、推奨されなくなりました。 object に対して最初に get_mangled_object_vars() を使うか、ArrayIterator を使って下さい。

例

例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"

?>

注意

注意: 空の配列に対してこの関数を実行した場合の戻り値は、配列の先頭要素に bool false がある配列に対して実行した場合の戻り値と区別できません。配列の先頭に false が含まれている可能性がある値を適切にチェックするには、まず最初に配列の count() をチェックするか、 reset() を呼び出した後に、要素の key() が null でないことを確かめるようにしてください。

参考

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

関連キーワード: 　配列, 要素, ポインタ, 内部, 先頭, セット, 関数, array, 最初, 論理