file_put_contents

PHP関数リファレンス

file_put_contents

(PHP 5)
file_put_contents — 文字列をファイルに書き込む

説明

int file_put_contents ( string filename, mixed data [, int flags [, resource context]] )
連続して fopen(), fwrite(), fclose() をコールすることと等価です。
data パラメータに配列を指定することも可能です (多次元配列は不可) 。この関数は file_put_contents($filename, implode('', $array)). と同等です。
PHP 5.1.0 以降、data パラメータにストリームリソースを渡すことも可能です。 結果として、ストリームに残っているバッファは指定されたファイルに コピーされます。これは stream_copy_to_stream() を使用することと似ています。

パラメータ

filename

データを書き込むファイル

data

書き込むデータ。文字列, 配列 もしくは ストリーム リソース (上述) のいずれかを指定可能です。

flags

flags には FILE_USE_INCLUDE_PATH, FILE_APPEND かつ/または LOCK_EX (排他的ロックを取得します) を取ることができます。しかし、 FILE_USE_INCLUDE_PATH オプションは注意して使用してください。

context

コンテキストリソース。

返り値

この関数はファイルに書き込まれたバイト数を返します。 あるいは失敗した場合には FALSE を返します。

変更履歴

バージョン	説明
5.1.0	LOCK_EX のサポートが追加され、 data パラメータにストリームリソースを指定することが可能になりました。

注意

注意: この関数はバイナリデータに対応しています。
注意: コンテキストのサポートは、 PHP 5.0.0 で追加されました。contexts の説明に関しては、 ストリーム を参照してください。

ティップ

fopen wrappers が有効の場合、この関数のファイル名として URL を使用することができます。ファイル名の指定方法に関する詳細は fopen()、サポートされる URL プロトコルの種類 については、(例えば)付録 M. サポートされるプロトコル/ラッパー を参照してください。

参考

fopen()

fwrite()

file_get_contents()

stream_context_create()