将数组的内部指针指向第一个单元

# reset

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

reset — 将数组的内部指针指向第一个单元

### 说明

function reset(array|object `&$array`): mixed

reset() 将 `array` 的内部指针倒回到第一个单元并返回第一个数组单元的值。

### 参数

`array`

  输入的数组。

### 返回值

返回数组第一个单元的值，如果数组为空则返回 `false`。

警告

此函数可能返回布尔值 `false`，但也可能返回等同于 `false` 的非布尔值。请阅读 布尔类型章节以获取更多信息。应使用 === 运算符来测试此函数的返回值。

### 更新日志

版本 | 说明
--- | ---
8.1.0 | 弃用在 object 上调用此函数。 要么首先使用 get_mangled_object_vars() 将 object 转换为 array，要么使用实现 Iterator 的类提供的方法，例如 ArrayIterator。
7.4.0 | SPL 类的实例现在被视为没有属性的空对象，而不是调用与此函数同名的 Iterator 方法。

### 示例

示例 #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() - 获取指定数组的第一个键

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open