PHP file_put_contents()関数

PHP Filesystem 参考手册完全な PHP Filesystem リファレンスマニュアル

定義と使用方法

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

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

  1. FILE_USE_INCLUDE_PATH が設定されている場合、*filename* のコピーの組み込みパスがチェックされます。
  2. ファイルが存在しない場合は、新しいファイルが作成されます。
  3. ファイルを開く
  4. LOCK_EX が設定されている場合、ファイルはロックされます。
  5. FILE_APPEND が設定されている場合、ファイルの末尾に移動します。それ以外の場合は、ファイルの内容がクリアされます。
  6. ファイルにデータを書き込みます。
  7. ファイルを閉じ、すべてのファイルのロックを解除します。

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

構文

int file_put_contents ( string $filename , mixed $data [, int $flags = 0 [, resource $context ]] )

パラメータ 説明
filename 必須。データを書き込むファイルを指定します。ファイルが存在しない場合は、新しいファイルを作成します。
data 必須。ファイルに書き込むデータを指定します。文字列、配列、またはデータストリームにすることができます。
flags オプション。ファイルを開く/書き込む方法を指定します。指定可能な値：
  • FILE_USE_INCLUDE_PATH
  • FILE_APPEND
  • LOCK_EX
context オプション。ファイルハンドルの環境を指定します。context は、ストリームの動作を変更できるオプションのセットです。

ヒントと注釈

注釈：ファイルに既存の内容を削除しないようにするには、FILE_APPEND を使用してください。

例

例

<?php echo file_put_contents("sites.txt","サンプル"); ?>

上記の例を実行した場合の出力結果は次のとおりです：

6

次に、ファイル sites.txt に内容を追加します：

例

<?php $file = 'sites.txt'; $site = "\nGoogle"; //ファイルに内容を追加して書き込む //FILE_APPEND フラグを使用すると、ファイルの末尾に内容を追加できます。 //LOCK_EX フラグは、複数のユーザーが同時に書き込むことを防げます。 file_put_contents($file, $site, FILE_APPEND | LOCK_EX); ?>

実行に成功した後、sites.txt ファイルを開くと、内容は次のとおりです：

サンプル
Google

PHP Filesystem 参考手册完全な PHP Filesystem リファレンスマニュアル

その他の拡張機能