PHPのfile_get_contents()：ファイルを文字列として読み込む

Q: PHPでファイルを文字列として読み込むには？

filegetcontents('path/to/file.txt')を呼びます。ファイル全体を文字列として返し、ファイルを読めなければfalseを返すので、使う前に結果を=== falseと比較しましょう。

Q: PHPでファイルに追記するには？

FILEAPPENDフラグを渡します：fileputcontents('log.txt', "new line\n", FILEAPPEND);。これがないと、fileputcontents()はファイル全体を置き換えます。複数のリクエストが同時に書き込むかもしれないときはLOCKEXを加えます（FILEAPPEND | LOCK_EX）。

Q: PHPでファイルを1行ずつ読むには？

小さなファイルなら、file('data.txt', FILEIGNORENEW_LINES)が1行1要素の配列を返します。大きなファイルなら、fopen()で開いてwhileループの中のfgets()で1行ずつ読みます。こうすればメモリに置くのは1行だけです。

Q: file_get_contentsでURLを読めますか？

php.iniでallowurlfopenが有効なら読めます：filegetcontents('https://example.com/')はレスポンスの本文を返します。ヘッダー、POSTデータ、タイムアウトにはstreamcontextcreate()のコンテキストを渡します。もっと込み入ったことには、cURLのほうがエラー処理に優れています。

file_get_contents('notes.txt')はファイル全体を読んで、1つの文字列として返します。ファイルを読めなければfalseを返します。書き込むにはfile_put_contents('notes.txt', $text)を使い、ファイルを作るか、中身を置き換えます。

<?php
file_put_contents('notes.txt', "Buy milk\nCall Ada\nWrite docs\n");

$text = file_get_contents('notes.txt');

echo $text;
echo strlen($text), " bytes\n";
echo substr_count($text, "\n"), " lines\n";

出力：

Buy milk
Call Ada
Write docs
29 bytes
3 lines

このブロックは、扱うファイルがあるよう先にnotes.txtを書き出してから読み戻します。'notes.txt'のようなパスは現在の作業ディレクトリからの相対なので、Webアプリでは__DIR__ . '/notes.txt'のようにスクリプト自身のフォルダーからパスを組み立てます。

file_put_contents()で書き込む、追記する

file_put_contents()は書き込んだバイト数を返し、失敗するとfalseを返します。デフォルトではファイルを上書きします。FILE_APPENDフラグを付けると代わりに末尾に追加し、これが簡単なログの仕組みです。LOCK_EXは2つのリクエストが同時に書き込むのを防ぎます。

<?php
$bytes = file_put_contents('log.txt', "started\n");
echo "Wrote $bytes bytes\n";

file_put_contents('log.txt', "step 1 done\n", FILE_APPEND | LOCK_EX);
file_put_contents('log.txt', "step 2 done\n", FILE_APPEND | LOCK_EX);
echo file_get_contents('log.txt'), "\n";

file_put_contents('log.txt', "replaced\n");   // no flag: the old content is gone
echo file_get_contents('log.txt'), "\n";

// An array is written with its elements joined, with nothing between them
file_put_contents('list.txt', ['a', 'b', 'c']);
echo file_get_contents('list.txt'), "\n";
echo file_put_contents('list.txt', implode("\n", ['a', 'b', 'c'])), " bytes\n";

出力：

Wrote 8 bytes
started
step 1 done
step 2 done

replaced

abc
5 bytes

配列を保存して配列として取り戻すには、json_encode()でJSONとして書き、json_decode()で読みます。

file()でファイルを1行ずつ読む

file()はファイルを1行1要素の配列に読み込みます。FILE_IGNORE_NEW_LINESを渡さない限り各行の末尾には改行が残り、FILE_SKIP_EMPTY_LINESは空行を取り除きます（FILE_IGNORE_NEW_LINESと一緒のときだけ働きます）。

<?php
file_put_contents('todo.txt', "Buy milk\nCall Ada\n\nWrite docs\n");

$lines = file('todo.txt');
var_dump($lines[0]);   // the newline is still there

$lines = file('todo.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
foreach ($lines as $i => $line) {
    echo $i + 1, ". $line\n";
}

echo count($lines), " tasks\n";

出力：

string(9) "Buy milk
"
1. Buy milk
2. Call Ada
3. Write docs
3 tasks

file()とfile_get_contents()はファイル全体をメモリに読み込みます。設定ファイルや数メガバイトのログなら問題ありません。数百メガバイトのファイルは、代わりにfopen()とfgets()で1行ずつ読みましょう。

読む前にファイルが存在するか確認する

ファイルがないと、file_get_contents()はfalseを返し、PHPは警告を表示します。

Warning: file_get_contents(missing.txt): Failed to open stream: No such file or directory in /home/index.php on line 2

先にis_file()（存在していてディレクトリでないファイル）かfile_exists()（ファイルかディレクトリ）で確認し、結果は必ず=== falseと比較しましょう。空のファイルは""を返し、これもfalseと評価されるからです。

<?php
file_put_contents('empty.txt', '');

foreach (['empty.txt', 'missing.txt', '.'] as $path) {
    echo str_pad($path, 12);
    echo file_exists($path) ? 'exists ' : 'missing ';
    echo is_file($path) ? 'file ' : '';
    echo is_dir($path) ? 'directory ' : '';
    echo "\n";
}

$path = 'missing.txt';
if (!is_file($path) || !is_readable($path)) {
    echo "Cannot read $path, using defaults\n";
} else {
    $text = file_get_contents($path);
}

$text = file_get_contents('empty.txt');
var_dump($text === false, $text == false);   // not a failure, just empty
echo filesize('empty.txt'), " bytes\n";

出力：

empty.txt   exists file 
missing.txt missing 
.           exists directory 
Cannot read missing.txt, using defaults
bool(false)
bool(true)
0 bytes

@file_get_contents()で警告を隠さないでください。先に確認するかfalseを処理すれば、ほかの何かがおかしくなったときにエラーが見えるままになります。

ファイルの一部を読む

4つ目と5つ目の引数は、読み始めるバイトのオフセットと、読むバイト数です。負のオフセットはファイルの末尾から数えます。名前付き引数を使えば、間の2つの引数を飛ばせます。

<?php
file_put_contents('data.txt', "HEADER\nline 2\nline 3\nlast line\n");

echo file_get_contents('data.txt', false, null, 0, 6), "\n";   // first 6 bytes
echo file_get_contents('data.txt', offset: 7, length: 6), "\n";
echo file_get_contents('data.txt', offset: -10);                 // last 10 bytes

出力：

HEADER
line 2
last line

オフセットは文字ではなくバイトを数えます。UTF-8では日本語の文字は3バイトなので、その途中のオフセットは文字を半分に切ってしまいます。文字単位で扱うには、文字列全体を読んでmb_substr()を使います。

テキストファイルをWebページに表示する

ファイルの中身はテキストで、HTMLに出力するテキストはエスケープしなければなりません。そうしないとファイルの中の<がタグになってしまいます。htmlspecialchars()がそれをエスケープし、nl2br()が改行を<br>タグに変えます。実行してPageタブを見てください。

<?php
file_put_contents('changelog.txt', <<<TXT
v1.2: Fixed <title> encoding
v1.1: Added "export" & "import"
v1.0: First release
TXT);

$text = file_get_contents('changelog.txt');
?>
<h3>Changelog</h3>
<p style="font-family: monospace"><?= nl2br(htmlspecialchars($text)) ?></p>
<p><?= count(file('changelog.txt')) ?> entries, <?= filesize('changelog.txt') ?> bytes</p>

htmlspecialchars()を外してもう一度実行すると、ページは「v1.2: Fixed」で終わってしまいます。ブラウザが<title>を本物のタグとして読み、そのあとのすべてをページのタイトルとして飲み込んでしまうからです。ユーザーが書けるあらゆるものにとってこれがなぜ重要かは、htmlspecialchars()のページで扱っています。

file_get_contents()でURLを読む

allow_url_fopenが有効なら（php.iniのデフォルト）、file_get_contents()はURLも読み、レスポンスの本文を返します。ストリームコンテキストで、メソッド、ヘッダー、本文、タイムアウトを加えられます。

<?php
$html = file_get_contents('https://example.com/');

$context = stream_context_create([
    'http' => [
        'method'  => 'POST',
        'header'  => "Content-Type: application/json\r\n",
        'content' => json_encode(['name' => 'Ada']),
        'timeout' => 5,
        'ignore_errors' => true,   // return the body of 4xx/5xx responses too
    ],
]);

$response = file_get_contents('https://api.example.com/users', false, $context);
if ($response === false) {
    // DNS failure, timeout, or a refused connection
}

再試行、上限付きのリダイレクト、わかりやすいエラーコードには、cURLやGuzzleのようなHTTPクライアントライブラリのほうが適した道具です。

file_get_contents、file()、fopen()の使い分け

やりたいこと	使うもの	メモリ
ファイル全体を1つの文字列で	`file_get_contents()`	ファイル全体
行を配列で	`file($path, FILE_IGNORE_NEW_LINES)`	ファイル全体
1回の呼び出しでファイルを書き込む、置き換える	`file_put_contents()`	書き込むデータ
ログに1行追加する	`file_put_contents($path, $line, FILE_APPEND \| LOCK_EX)`	1行
大きなファイルやCSVの行を1行ずつ読む	`fopen()`と`fgets()`か`fgetcsv()`	1行
開いた同じファイルを読み書きする	`r+`、`a+`、`c+`での`fopen()`	読んだ分

1回で済む関数は、ファイルを開き、読むか書き、閉じるところまでをやってくれるので、デフォルトの選択として正解です。ファイルがメモリに収まらないほど大きいときや、操作の間ファイルを開いたままにする必要があるときにfopen()を選びましょう。

よくある質問

PHPでファイルを文字列として読み込むには？

file_get_contents('path/to/file.txt')を呼びます。ファイル全体を文字列として返し、ファイルを読めなければfalseを返すので、使う前に結果を=== falseと比較しましょう。

PHPでファイルに追記するには？

FILE_APPENDフラグを渡します：file_put_contents('log.txt', "new line\n", FILE_APPEND);。これがないと、file_put_contents()はファイル全体を置き換えます。複数のリクエストが同時に書き込むかもしれないときはLOCK_EXを加えます（FILE_APPEND | LOCK_EX）。

PHPでファイルを1行ずつ読むには？

小さなファイルなら、file('data.txt', FILE_IGNORE_NEW_LINES)が1行1要素の配列を返します。大きなファイルなら、fopen()で開いてwhileループの中のfgets()で1行ずつ読みます。こうすればメモリに置くのは1行だけです。

file_get_contentsがfalseを返すのはなぜですか？

ファイルが存在しないか、パスが思っているのとは別のディレクトリからの相対になっているか、PHPに読む権限がないかです。PHPはFailed to open stream: No such file or directoryのような警告も表示します。is_file()とis_readable()で確認し、パスは__DIR__から組み立てましょう。

file_get_contentsでURLを読めますか？

php.iniでallow_url_fopenが有効なら読めます：file_get_contents('https://example.com/')はレスポンスの本文を返します。ヘッダー、POSTデータ、タイムアウトにはstream_context_create()のコンテキストを渡します。もっと込み入ったことには、cURLのほうがエラー処理に優れています。