PHPのfpassthru()関数の使い方を徹底解説

fpassthru()関数とは

PHPのfpassthru()関数は、開いているファイルからEOF（ファイルの終端）までデータを読み込み、その内容を出力バッファに書き出すための関数です。ファイルポインタから読み取った文字数を返し、エラーが発生した場合はFALSEを返します。

構文

fpassthru(file_pointer):

パラメータ

• file_pointer − fopen()またはfsockopen()によって正常にオープンされ、まだfclose()で閉じられていないファイルを指すファイルポインタを指定します。

戻り値

fpassthru()関数は、ファイルポインタから読み取った文字数を返します。エラーが発生した場合はFALSEを返します。

使用例

<?php
    $file_pointer = fopen("new.txt", "r");
    fgets($file_pointer);
    echo fpassthru($file_pointer);
    fclose($file_pointer);
?>

上記のコードでは、まず「new.txt」を読み取りモードで開き、fgets()で1行目を読み飛ばした後、残りの部分をfpassthru()で出力しています。実行結果は以下のとおりで、読み取られた文字数は22です。

出力

Demo text!!
This is it!22

まとめ

fpassthru()関数は、ファイルの残りの内容をそのままブラウザなどへ出力したい場合に便利な関数です。ダウンロード処理や画像・PDFなどのバイナリファイルの出力にもよく使われます。使用する際は、ファイルポインタが有効であること、およびファイルが閉じられていないことに注意してください。