PHP file_put_contents() Function

PHP Filesystem Reference Complete PHP Filesystem Reference

Definition and Usage

The file_put_contents() writes a string to a file.

This function follows these rules when accessing a file:

  1. If FILE_USE_INCLUDE_PATH is set, check the include path for a copy of *filename*
  2. Create the file if it does not exist
  3. Open the file
  4. Lock the file if LOCK_EX is set
  5. If FILE_APPEND is set, move to the end of the file. Otherwise, clear the file content
  6. Write the data into the file
  7. Close the file and release any locks

This function returns the number of character written into the file on success, or FALSE on failure.



Parameter Description
file Required. Specifies the file to write to. If the file does not exist, this function will create one
data Required. The data to write to the file. Can be a string, an array or a data stream
mode Optional. Specifies how to open/write to the file. Possible values:
context Optional. Specifies the context of the file handle. Context is a set of options that can modify the behavior of a stream.

Tips and Notes

Note: Use FILE_APPEND to avoid deleting the existing content of the file.


echo file_put_contents("test.txt","Hello World. Testing!");

The output of the code above will be:


PHP Filesystem Reference Complete PHP Filesystem Reference


Color Picker