PHP file_put_contents() 関数


❮ 完全な PHP ファイルシステム・リファレンス

定義と用法

file_put_contents() 関数は、ファイルに文字列を書き出します。

この関数は、ファイルにアクセスするときに次の規則に従います:

  1. FILE_USE_INCLUDE_PATH が設定されている場合は、*filename* のコピーのインクルードパスをチェックします
  2. ファイルが存在しない場合は作成します
  3. ファイルをオープンします
  4. LOCK_EX が設定されている場合はファイルをロックする
  5. FILE_APPEND が設定されている場合は、ファイルの最後に移動します。それ以外の場合は、ファイルの内容を消去します
  6. データをファイルに書き出します
  7. ファイルをクローズしてロックを解除する

この関数は、成功した場合はファイルに書き出した文字数を返します。失敗した場合はFALSEを返します。

構文

file_put_contents(file,data,mode,context)

パラメータ 説明
file 必須。書き出すファイルを指定する。ファイルが存在しない場合、この関数はファイルを作成する
data 必須。ファイルに書き出すデータ。 文字列、配列、またはデータストリームにすることができる
mode 任意。ファイルの open/write 方法を指定する。指定可能な値:
  • FILE_USE_INCLUDE_PATH
  • FILE_APPEND
  • LOCK_EX
context 任意。ファイルハンドルのコンテキストを指定する。コンテキストとは、ストリームの動作を変更できる一連のオプションのことです。

チップスと注意

注:ファイルの既存の内容を削除しないようにするには FILE_APPEND を使用します。


<?php
echo file_put_contents("test.txt","Hello World. Testing!");
?>

上のコードの出力は、次の通り:

21

❮ 完全な PHP ファイルシステム・リファレンス