【PHP8.x】fread関数の使い方

Copy
1<?php
2
3/**
4 * fread()関数を使ってファイルの内容を読み込むサンプル関数
5 *
6 * この関数は、一時ファイルを作成し、そのファイルの内容をfread()で読み込んで
7 * 表示した後、ファイルを削除するまでの一連の流れを示します。
8 *
9 * @return void
10 */
11function readFileContentExample(): void
12{
13    // 読み込み対象のファイル名
14    $filename = 'sample_for_fread.txt';
15    // ファイルに書き込むサンプルテキスト
16    $contentToWrite = "Hello, World!\nPHP's fread() function is useful for reading files.";
17
18    // --- 準備: 読み込むためのサンプルファイルを作成 ---
19    // file_put_contents() はファイルの作成と書き込みを一度に行います。
20    // 戻り値が false の場合は失敗です。
21    if (file_put_contents($filename, $contentToWrite) === false) {
22        echo "Error: Failed to create a sample file.\n";
23        return;
24    }
25
26    // --- メイン処理: ファイルのオープン、読み込み、クローズ ---
27    // ファイルポインタ（リソース）を格納する変数を初期化
28    $fileHandle = null;
29    try {
30        // 1. ファイルを読み込み専用モード('r')で開く
31        // fopen() は成功するとファイルリソースを、失敗すると false を返します。
32        $fileHandle = fopen($filename, 'r');
33        if ($fileHandle === false) {
34            echo "Error: Failed to open the file '{$filename}'.\n";
35            return;
36        }
37
38        // 2. ファイルからデータを読み込む
39        // fread(リソース, 読み込む最大バイト数)
40        // filesize() でファイル全体のサイズを取得し、すべてを一度に読み込みます。
41        // 読み込みに成功した場合は文字列、失敗した場合は false を返します。
42        $readContent = fread($fileHandle, filesize($filename));
43
44        if ($readContent !== false) {
45            echo "Successfully read content from the file:\n";
46            echo "----------------------------------------\n";
47            echo $readContent . "\n";
48            echo "----------------------------------------\n";
49        } else {
50            echo "Error: Failed to read from the file.\n";
51        }
52    } finally {
53        // 3. ファイルを閉じる
54        // ファイルハンドルが有効な場合、fclose()でリソースを必ず解放します。
55        // finallyブロックに記述することで、エラー発生時も確実に実行されます。
56        if ($fileHandle) {
57            fclose($fileHandle);
58        }
59    }
60
61    // --- 後処理: 作成したサンプルファイルを削除 ---
62    unlink($filename);
63}
64
65// サンプル関数を実行します
66readFileContentExample();

PHPのfread()関数は、すでに開かれているファイルから指定した長さ（バイト数）のデータを読み込むための基本的な関数です。ファイルの内容を部分的に、あるいは全体的に取得する際に使用されます。

この関数は主に2つの引数を取ります。第1引数には、fopen()関数でファイルを開いた際に得られるファイルポインタ（リソース）を指定します。これは、どのファイルストリームからデータを読み込むかをPHPに伝えるためのものです。第2引数には、読み込むデータの最大バイト数を整数で指定します。

戻り値は、読み込みに成功した場合はその内容が文字列として返されます。一方、ファイルの終端に達した場合や、何らかのエラーで読み込みに失敗した場合はfalseが返されます。

サンプルコードでは、fopen()でファイルを開き、そのリソースをfread()の第1引数に渡しています。第2引数にはfilesize()関数を使ってファイル全体のサイズを指定することで、ファイルの内容をすべて一度に読み込んでいます。読み込んだ文字列は変数に代入され、画面に出力されます。処理が完了した後、fclose()関数でファイルを閉じるのが一連の流れです。エラー発生時でも確実にファイルを閉じるため、finallyブロック内でfclose()を呼び出すことが推奨されます。