【PHP】file_get_contentsでファイルの情報を取得する方法

2023年8月12日

まゆ

file_get_contentsの使い方がいまいち分からないです。

今回は、file_get_contentsの使い方について説明していきたいと思います。

【file_get_contents】とは

file_get_contents関数とは、指定されたURLやファイルからデータを取得する関数です。簡単に言うと、指定されたファイルを読み込み、その中身を文字列で返す機能です。

取得するのは、文字列ですのでfile関数とは異なります。

file_get_contentsがサポートされているプロトコルは、http, https, ftp, ftps, fileなどがあります。

file_get_contentsの書き方は以下のようになります。

file_get_contents($ファイル名/URLパス[,$インクルードパス][,$コンテキスト][,$オフセット][,$読み込むデータの最大バイト数])

なんだか引数が多くてよく分からないですね（笑）

以下に引数の説明をしています。

引数	説明
第１引数	読み込むパス/ファイル名
第２引数	インクルードパスを指定
第３引数	stream_context_create関数で作成したコンテキストリソースを指定
第４引数	読込みを開始するオフセット値
第５引数	読み込むデータの最大バイト数を指定デフォルトではファイルの終端まで読み込み

パス名を引数に渡しただけでも、情報を取得してくれるので難しく考える必要はありません！

返り値としては、ファイルの内容が格納された文字列を返します。失敗した場合はFALSEを返します。指定したファイルが見つからなかった場合や最大バイト数がゼロよりも小さいなどの場合はE_WARNINGのエラーが発生します。

file_get_contentsの基本的な使い方を以下に記載します。

まずはファイルをすべて読み込む場合の方法について説明します。

text.php

aaaaa
bbbbb
ccccc
ddddd

実行コード

<?php
  echo file_get_contents('text.php');
?>

実行結果

aaaaa
bbbbb
ccccc
ddddd

このサンプルコードでは、text.phpというファイルを全て読み込んでいます。

出力すると上記のような結果になります。

次にファイルを部分的に読み込む方法について説明していきます。

text.php

aaaaa
bbbbb
ccccc
ddddd

実行コード

<?php
  echo file_get_contents("test.php", NULL, NULL, 6, 5");
?>

実行結果

bbbbb

このサンプルコードでは“test.php”ファイルの6文字目から5文字を取得しています。
実行結果のとおり、file_get_contents関数を使用すれば、部分的にも読み込むことができます。

ファイル全体をメモリに読み込んでしまう。file_get_contents関数は、指定されたファイルの内容全体をメモリに読み込んでしまいます。大きなファイルを処理する場合や、同時に多くのファイルを処理する場合には、メモリの使用量が増える可能性があります。
ファイルのエラーハンドリングが限定的。エラーが発生した場合、falseを返しますが、詳細なエラーメッセージやエラーコードを提供しません。エラーハンドリングが必要な場合には、追加のエラーチェックや例外処理が必要です。
ファイルにアクセスするための権限が必要。実行中のスクリプトがファイルにアクセスするために必要な権限を持っている必要があります。ファイルのパスやパーミッションに注意する必要があります。