PHP file_get_contents() 関数

定義と用法

file_get_contents() 関数は、ファイル全体を文字列に読み込みます。

および file() 同様ですが、file_get_contents()はファイルを文字列に読み込みます。

file_get_contents() 関数は、ファイルの内容を文字列に読み込むために使用される推奨方法です。OSがサポートしている場合、メモリマッピング技術を使用してパフォーマンスを向上させます。

文法

file_get_contents(path,include_path,context,start,max_length)
パラメータ 説明
path 必須。読み込むファイルを指定します。
include_path オプション。include_path でファイルを検索することもできます。このパラメータを「1」に設定します。
context

オプション。ファイルハンドルの環境を指定します。

context は、ストリームの動作を変更できるオプションセットです。nullを使用すると、無視されます。

start オプション。ファイル内の読み込みを開始する位置を指定します。このパラメータは PHP 5.1 で追加されました。
max_length オプション。読み込むバイト数を指定します。このパラメータは PHP 5.1 で追加されました。

説明

に対して context パラメータのサポートは PHP 5.0.0 で追加されました。

ヒントとコメント

コメント:この関数はバイナリオブジェクトに安全に使用できます。

<?php
echo file_get_contents("test.txt");
?>

出力:

これはテストテキストが含まれるテストファイルです。