PHP マニュアル: 内部の配列ポインタをひとつ前に戻す

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

説明

mixed prev(arrayobject &$array)

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

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');
$mode = current($transport); // $mode = 'foot';
$mode = next($transport);    // $mode = 'bike';
$mode = next($transport);    // $mode = 'car';
$mode = prev($transport);    // $mode = 'bike';
$mode = end($transport);     // $mode = 'plane';
?>

注意

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

参考

current
end
next
reset
each