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

fflush()関数は、PHPで開いているファイルに対して出力をフラッシュ（強制書き込み）するための組み込み関数です。通常、ファイルへの書き込みはバッファリングされるため、データがすぐにディスクへ反映されるとは限りません。この関数を使うことで、バッファに溜められたすべての出力を、ファイルポインタが指すリソースに対して即座に書き込むことができます。

基本構文

fflush(file_pointer)

パラメータ

• file_pointer − 書き込み対象となる、fopen()などで開かれたファイルストリームを指定します。

戻り値

fflush()関数は、処理の結果に応じて以下の値を返します。

• 成功した場合は TRUE
• 失敗した場合は FALSE

なお、読み取り専用で開いたファイルなど、書き込みが行えないストリームに対しては FALSE が返される点に注意してください。

使用例

まずは基本的な使い方を見てみましょう。

<?php
   $file_pointer = fopen("one.txt", "r+");
   fwrite($file_pointer, "test line");
   fflush($file_pointer);
?>

出力

test line

この例では、ファイル「one.txt」を読み書きモード（r+）で開き、fflush()によってバッファ内のデータを強制的にファイルへ書き込んでいます。

続いて、別の例も見てみましょう。

使用例その2

<?php
   $file_pointer = fopen("two.txt", "r");
   $res = fgets($file_pointer);
   while(!feof($file_pointer))
      echo fgets($file_pointer) . "<br>";
   fclose($file_pointer);
?>

出力

Java is a programming language.
JavaScript is a scripting language.

まとめ

fflush()関数は、重要なデータを確実にファイルへ保存したい場合や、プログラムの途中経過をログファイルに即座に記録したい場合などに役立ちます。バッファリングによる書き込み遅延を防ぎたい場面で、ぜひ活用してみてください。