THE WORLD'S LARGEST WEB DEVELOPER SITE

PHP Tutorial

PHP HOME PHP Intro PHP Install PHP Syntax PHP Comments PHP Variables PHP Echo / Print PHP Data Types PHP Strings PHP Numbers PHP Constants PHP Operators PHP If...Else...Elseif PHP Switch PHP While Loops PHP For Loops PHP Functions PHP Arrays PHP Superglobals

PHP Forms

PHP Form Handling PHP Form Validation PHP Form Required PHP Form URL/E-mail PHP Form Complete

PHP Advanced

PHP Date and Time PHP Include PHP File Handling PHP File Open/Read PHP File Create/Write PHP File Upload PHP Cookies PHP Sessions PHP Filters PHP Filters Advanced PHP JSON

PHP OOP

PHP What is OOP PHP Classes/Objects PHP Constructor PHP Destructor PHP Access Modifiers PHP Inheritance PHP Constants PHP Abstract Classes PHP Traits PHP Static Methods PHP Static Properties

MySQL Database

MySQL Database MySQL Connect MySQL Create DB MySQL Create Table MySQL Insert Data MySQL Get Last ID MySQL Insert Multiple MySQL Prepared MySQL Select Data MySQL Delete Data MySQL Update Data MySQL Limit Data

PHP XML

PHP XML Parsers PHP SimpleXML Parser PHP SimpleXML - Get PHP XML Expat PHP XML DOM

PHP - AJAX

AJAX Intro AJAX PHP AJAX Database AJAX XML AJAX Live Search AJAX Poll

PHP Examples

PHP Examples PHP Quiz PHP Exercises PHP Certificate

PHP Reference

PHP Overview PHP Array PHP Calendar PHP Date PHP Directory PHP Error PHP Filesystem PHP Filter PHP FTP PHP JSON PHP Libxml PHP Mail PHP Math PHP Misc PHP MySQLi PHP Network PHP SimpleXML PHP Stream PHP String PHP XML Parser PHP Zip PHP Timezones

PHP file_put_contents() Function

❮ PHP Filesystem Reference

Example

Write data to a file:

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

The output of the code above will be:

21


Definition and Usage

The file_put_contents() writes data 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

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

Syntax

file_put_contents(filename, data, mode, context)

Parameter Values

Parameter Description
filename Required. Specifies the path to 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, array, or a data stream
mode Optional. Specifies how to open/write to the file. Possible values:
  • FILE_USE_INCLUDE_PATH - search for filename in the include directory
  • FILE_APPEND - if file already exists, append the data to it - instead of overwriting it
  • LOCK_EX - Put an exclusive lock on the file while writing to it
context Optional. Specifies the context of the file handle. Context is a set of options that can modify the behavior of a stream.


Technical Details

Return Value: The number of bytes written into the file on success, FALSE on failure
PHP Version: 5.0+
Binary Safe: Yes
PHP Changelog: PHP 5.1 - Added support for LOCK_EX and the ability to pass a stream resource to the data parameter

❮ PHP Filesystem Reference