内部の配列ポインタをひとつ前に戻す

# prev

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

prev — 内部の配列ポインタをひとつ前に戻す

### 説明

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

内部の配列ポインタをひとつ前に戻します。

prev() は、 内部の配列ポインタを進めるのではなく戻すということを除けば next() と同じです。

### パラメータ

`array`

  入力の配列。

### 戻り値

内部の配列ポインタが指している前の場所の配列値を返します。 もう要素がない場合は `false` を返します。

警告

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

### 変更履歴

バージョン | 説明
--- | ---
8.1.0 | この関数を object に対してコールすることは、推奨されなくなりました。 object に対して最初に get_mangled_object_vars() を使って配列に変換するか、ArrayIterator のような Iterator を実装したクラスのメソッドを使ってください。
7.4.0 | SPL クラスのインスタンスは、プロパティを持たない空のオブジェクトのように扱われるようになりました。これより前のバージョンでは、この関数と同じ名前の Iterator のメソッドをコールしていました。

### 例

例1 prev() および類似関数の使用例

    <?php
    $transport = array('foot', 'bike', 'car', 'plane');
    echo $mode = current($transport), PHP_EOL; // $mode = 'foot';
    echo $mode = next($transport), PHP_EOL;    // $mode = 'bike';
    echo $mode = next($transport), PHP_EOL;    // $mode = 'car';
    echo $mode = prev($transport), PHP_EOL;    // $mode = 'bike';
    echo $mode = end($transport), PHP_EOL;     // $mode = 'plane';
    ?>

### 注意

> 注意: 配列の先頭でこの関数を実行した結果は、 先頭が bool の `false` だった場合と区別できません。 区別するには、prev() 要素の key() 要素が `null` でないかを確認するようにしてください。

### 参考

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

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