PHP rewind()関数の使い方｜ファイルポインタを先頭に戻す方法を解説

rewind()関数とは

PHPのrewind()関数は、ファイルポインタを巻き戻すための関数です。この関数を呼び出すと、現在のファイルポインタの位置に関係なく、ポインタはファイルの先頭に移動されます。処理が成功した場合はTRUEを返し、失敗した場合はFALSEを返します。

なお、rewind($fp) は fseek($fp, 0, SEEK_SET) と同等の動作を行いますが、fseek()と異なり戻り値が常に無視される点には注意が必要です。

構文

rewind(file_pointer)

パラメータ

• file_pointer：fopen()によって開かれた有効なファイルリソースを指定する必要があります。開かれていないファイルや無効なリソースを渡すと、エラーが発生します。

戻り値

rewind()関数は、処理が成功した場合にTRUEを、失敗した場合にFALSEを返します。

使用例

$file_pointer = fopen("new.txt", "r");
// fseek()でファイルポインタの位置を変更
fseek($file_pointer, "12");
// rewind()でファイルポインタをファイルの先頭に移動
rewind($file_pointer);
fclose($file_pointer);

この例では、まずfopen()を使って「new.txt」を読み込みモードで開いています。続くfseek()により、ファイルポインタを12バイト目の位置へ移動させた後、rewind()を呼び出すことで、ファイルポインタは再びファイルの先頭に戻されます。最後にfclose()でファイルを閉じて処理を完了しています。

注意点

• 追記モード（"a" または "a+"）で開いたファイルに対してrewind()を実行しても、書き込まれるデータは常にファイルの末尾に追加されます。
• 書き込みモードで開いたファイルに対してrewind()を使用する場合は、あらかじめfflush()を呼び出しておくことが推奨されています。

出力

TRUE