PHPのpos()関数とは？使い方とサンプルコードを解説

PHPのpos()関数は、current()関数のエイリアス（別名）として定義されている関数です。配列の内部ポインタが現在指している要素（カレント要素）の値を取得するために使用されます。

構文

pos(arr)

パラメータ

• arr − 対象となる配列を指定します。必須パラメータです。

戻り値

pos()関数は、配列内の現在の要素（カレント要素）の値を返します。なお、内部ポインタが配列の範囲外にある場合や、空の配列が渡された場合は FALSE を返す点に注意してください。

使用例

以下は、pos()関数を使って配列の先頭要素を取得する基本的な例です。

<?php
$arr = array("one", "two");
echo pos($arr);
?>

出力結果

one

配列を作成した直後は内部ポインタが先頭要素を指しているため、「one」が出力されます。

使用例：next()関数との組み合わせ

次に、current()関数やnext()関数と組み合わせた例を見てみましょう。pos()関数はcurrent()関数と完全に同じ動作をするため、同じタイミングで呼び出せば同じ結果が得られます。

<?php
$a = array('one', 'two', 'three');
echo current($a)."\n";
echo next($a)."\n";
echo pos($a)."\n";
?>

出力結果

one
two
two

この例では、まずcurrent()関数で先頭要素「one」を取得し、続くnext()関数によって内部ポインタが次の要素へ進みます。その後、pos()関数を呼び出すと、現在ポインタが指している「two」が返されることが確認できます。このように、pos()関数はcurrent()関数の代替として自由に使うことができます。