PHP Doku:: Write a string to a file - function.file-put-contents.html

Verlauf / Chronik / History: (1) anzeigen

Sie sind hier:
Doku-StartseitePHP-HandbuchFunktionsreferenzDateisystemrelevante ErweiterungenDateisystemDateisystem-Funktionenfile_put_contents

Ein Service von Reinhard Neidl - Webprogrammierung.





(PHP 5)

file_put_contentsWrite a string to a file


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

This function is identical to calling fopen(), fwrite() and fclose() successively to write data to a file.

If filename does not exist, the file is created. Otherwise, the existing file is overwritten, unless the FILE_APPEND flag is set.



Path to the file where to write the data.


The data to write. Can be either a string, an array or a stream resource.

If data is a stream resource, the remaining buffer of that stream will be copied to the specified file. This is similar with using stream_copy_to_stream().

You can also specify the data parameter as a single dimension array. This is equivalent to file_put_contents($filename, implode('', $array)).


The value of flags can be any combination of the following flags, joined with the binary OR (|) operator.

Available flags
Flag Description
FILE_USE_INCLUDE_PATH Search for filename in the include directory. See include_path for more information.
FILE_APPEND If file filename already exists, append the data to the file instead of overwriting it.
LOCK_EX Acquire an exclusive lock on the file while proceeding to the writing.


A valid context resource created with stream_context_create().


The function returns the number of bytes that were written to the file, or FALSE on failure.


Diese Funktion kann sowohl das boolsche FALSE zurückliefern, als auch einen nicht-boolschen Wert, wie zum Beispiel 0 oder "", der von einem einfachen if-Statement als FALSE ausgewertet wird. Weitere Informationen entnehmen Sie bitte dem Abschnitt über die boolschen Typen. Benutzen Sie deshalb den === Operator, um den Rückgabewert dieser Funktion zu überprüfen.


Beispiel #1 Simple usage example

// Open the file to get existing content
$current file_get_contents($file);
// Append a new person to the file
$current .= "John Smith\n";
// Write the contents back to the file

Beispiel #2 Using flags

// The new person to add to the file
$person "John Smith\n";
// Write the contents to the file, 
// using the FILE_APPEND flag to append the content to the end of the file
// and the LOCK_EX flag to prevent anyone else writing to the file at the same time
file_put_contents($file$personFILE_APPEND LOCK_EX);


Version Beschreibung
5.0.0 Added context support
5.1.0 Added support for LOCK_EX and the ability to pass a stream resource to the data parameter


Hinweis: Diese Funktion ist binary safe.


Mit dieser Funktion können Sie eine URL als Dateinamen verwenden, falls Sie fopen wrappers ermöglicht haben. Mehr Details dazu, wie Sie den Dateinamen angeben müssen finden Sie bei fopen(). Eine Liste der unterstützten URL Protokolle, die Fähigkeiten der verschiedenen Wrapper, Hinweise zu deren Verwendung und Informationen zu den eventuell vorhandenen vordefinierten Variablen finden Sie unter Supported Protocols and Wrappers.

Siehe auch

18 BenutzerBeiträge:
- Beiträge aktualisieren...
ravianshmsr08 at gmail dot com
15.12.2010 10:39
To upload file from your localhost to any FTP server.
pease note 'ftp_chdir' has been used instead of putting direct remote file ftp_put ...remoth file should be only file name

= '*****';
$usr = '*****';
$pwd = '**********';        
$local_file = './orderXML/order200.xml';
$ftp_path = 'order200.xml';
$conn_id = ftp_connect($host, 21) or die ("Cannot connect to host");     
ftp_pasv($resource, true);
ftp_login($conn_id, $usr, $pwd) or die("Cannot login");
// perform file upload
ftp_chdir($conn_id, '/public_html/abc/');
$upload = ftp_put($conn_id, $ftp_path, $local_file, FTP_ASCII);
$upload) { $ftpsucc=1; } else { $ftpsucc=0; }
// check upload status:
print (!$upload) ? 'Cannot upload' : 'Upload complete';
// close the FTP stream
error at example dot com
11.12.2010 21:47
It's worth noting that you must make sure to use the correct path when working with this function. I was using it to help with logging in an error handler and sometimes it would work - while other times it wouldn't. In the end it was because sometimes it was called from different paths resulting in a failure to write to the log file.

__DIR__ is your friend.
hilton at allcor dot com dot br
4.11.2010 13:20
NOTE : file_put_contents create files UTF-8

= 'test.txt';
$myContent = 'I love PHP';

file_put_contents($myFile, utf8_encode($myContent));
clement dot delmas at gmail dot com
17.09.2010 15:22
NOTE : file_put_contents doesn't add a valid BOM while creating the file

= 'test.txt';
$myContent = 'I love PHP';

file_put_contents($myFile, "\xEF\xBB\xBF".$myContent);
deqode at felosity dot nl
15.02.2010 21:14
Please note that when saving using an FTP host, an additional stream context must be passed through telling PHP to overwrite the file.

/* set the FTP hostname */
$user = "test";
$pass = "myFTP";
$host = "";
$file = "test.txt";
$hostname = $user . ":" . $pass . "@" . $host . "/" . $file;

/* the file content */
$content = "this is just a test.";
/* create a stream context telling PHP to overwrite the file */
$options = array('ftp' => array('overwrite' => true));
$stream = stream_context_create($options);
/* and finally, put the contents */
file_put_contents($hostname, $content, 0, $stream);
John Galt
29.07.2009 21:14
I use file_put_contents() as a method of very simple hit counters. These are two different examples of extremely simple hit counters, put on one line of code, each.

Keep in mind that they're not all that efficient. You must have a file called counter.txt with the initial value of 0.

For a text hit counter:
= file_get_contents("counter.txt"); $counter++; file_put_contents("counter.txt", $counter); echo $counter;

Or a graphic hit counter:
= file_get_contents("counter.txt"); $counter++; file_put_contents("counter.txt", $counter); for($i = 0; $i < strlen($counter); $i++) echo "<img src=\"counter/".substr($counter, $i, 1).".gif\" alt=\"".substr($counter, $i, 1)."\" />";
wjsams at gmail dot com
25.06.2009 17:57
file_put_contents() strips the last line ending

If you really want an extra line ending at the end of a file when writing with file_put_contents(), you must append an extra PHP_EOL to the end of the line as follows.

= array("these","are","new","lines");
$contents = implode(PHP_EOL, $a_str);
$contents .= PHP_EOL . PHP_EOL;
file_put_contents("newfile.txt", $contents);

You can see that when you print $contents you get two extra line endings, but if you view the file newfile.txt, you only get one.
kola_lola at hotmail dot com
7.11.2008 0:31
I wrote this script implementing the file_put_contents() and file_get_contents() functions to be compatible with both php4.* and php 5.*. It is a PHP Command line interface script which searches and replaces a specific word recursively through all files in the supplied directory hierarchy.

Usage from a Linux command line: ./scriptname specifieddirectory searchString replaceString

= $_SERVER['argc'];
$argv = $_SERVER['argv'];

$argc != 4)
"This command replaces a search string with a replacement string\n for the contents of all files in a directory hierachy\n";
"command usage: $argv[0]  directory searchString replaceString\n";
if (!function_exists('file_put_contents')) {
file_put_contents($filename, $data) {
$f = @fopen($filename, 'w');
        if (!
$f) {
        } else {
$bytes = fwrite($f, $data);


/* Returns the contents of file name passed

      if (!
$fhandle = fopen($filename, "r");
$fcontents = fread($fhandle, filesize($filename));
$fcontents = file_get_contents($filename);

function openFileSearchAndReplace($parentDirectory, $searchFor, $replaceWith)
//echo "debug here- line 1a\n";
//echo "$parentDirectory\n";
//echo "$searchFor\n";
//echo "$replaceWith\n";

if ($handle = opendir("$parentDirectory")) {
    while (
false !== ($file = readdir($handle))) {
        if ((
$file != "." && $file != "..") && !is_dir($file)) {
chdir("$parentDirectory"); //to make sure you are always in right directory
         // echo "$file\n";
$holdcontents = file_get_contents($file);
$holdcontents2 = str_replace($searchFor, $replaceWith, $holdcontents);
file_put_contents($file, $holdcontents2);
// echo "debug here- line 1\n";
         // echo "$file\n";

is_dir($file) && ($file != "." && $file != ".."))
$holdpwd = getcwd();
//echo "holdpwd = $holdpwd \n";
$newdir = "$holdpwd"."/$file";
//echo "newdir = $newdir \n";  //for recursive call
openFileSearchAndReplace($newdir, $searchFor, $replaceWith);
//echo "debug here- line 2\n";
        //echo "$file\n";

$parentDirectory2 = $argv[1];
$searchFor2 = $argv[2];
$replaceWith2 = $argv[3];

//Please do not edit below to keep the rights to this script
//Free license, if contents below this line is not edited
echo "REPLACED\n'$searchFor2' with '$replaceWith2' recursively through directory listed below\nFor all files that current user has write permissions for\nDIRECTORY: '$parentDirectory2'\n";
"command written by Kolapo Akande :) all rights reserved :)\n";

$holdpwd = getcwd();
//echo "$holdpwd\n";
openFileSearchAndReplace($parentDirectory2, $searchFor2, $replaceWith2);
admin at nabito dot net
4.08.2008 10:11
This is example, how to save Error Array into simple log file


[] = 'some error';
$error[] = 'some error 2';

file_put_contents('log.txt',date('c')."\n".implode("\n", $error),FILE_APPEND);

TrentTompkins at gmail dot com
2.07.2008 14:25
File put contents fails if you try to put a file in a directory that doesn't exist. This creates the directory.

function file_force_contents($dir, $contents){
$parts = explode('/', $dir);
$file = array_pop($parts);
$dir = '';
$parts as $part)
is_dir($dir .= "/$part")) mkdir($dir);
file_put_contents("$dir/$file", $contents);
2.05.2008 20:06
file_put_contents() will cause concurrency problems - that is, it doesn't write files atomically (in a single operation), which sometimes means that one php script will be able to, for example, read a file before another script is done writing that file completely.

The following function was derived from a function in Smarty ( which uses rename() to replace the file - rename() is atomic on Linux.

On Windows, rename() is not currently atomic, but should be in the next release. Until then, this function, if used on Windows, will fall back on unlink() and rename(), which is still not atomic...


("FILE_PUT_CONTENTS_ATOMIC_TEMP", dirname(__FILE__)."/cache");

file_put_contents_atomic($filename, $content) {
$temp = tempnam(FILE_PUT_CONTENTS_ATOMIC_TEMP, 'temp');
    if (!(
$f = @fopen($temp, 'wb'))) {
        if (!(
$f = @fopen($temp, 'wb'))) {
trigger_error("file_put_contents_atomic() : error writing temporary file '$temp'", E_USER_WARNING);
fwrite($f, $content);
    if (!@
rename($temp, $filename)) {
rename($temp, $filename);

the geek man at hot mail point com
3.01.2008 12:23
I use the following code to create a rudimentary text editor. It's not fancy, but then it doesn't have to be. You could easily add a parameter to specify a file to edit; I have not done so to avoid the potential security headaches.

There are still obvious security holes here, but for most applications it should be reasonably safe if implemented for brief periods in a counterintuitive spot. (Nobody says you have to make a PHP file for that purpose; you can tack it on anywhere, so long as it is at the beginning of a file.)

= 'randomly_generated_string';
$random2 = 'another_randomly_generated_string';
$target_file = 'file_to_edit.php';
$this_file = 'the_current_file.php';

if (
$_REQUEST[$random1] === $random2) {
    if (isset(
file_put_contents($target_file, get_magic_quotes_qpc() ? stripslashes($_POST['content']) : $_POST['content']);
'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "">
<html xmlns="" xml:lang="en" lang="en">
        <form method="post" action="'
. $this_file . '" />
        <input type="hidden" name="'
. $random1 . '" value="' . $random2 . '" />
        <textarea name="content" rows="50" cols="100">'
. file_get_contents($target_file) . '</textarea><br />
        <input type="submit" value="Save Changes" />

Then simply browse to hxxp://{$this_file}?{$random1}={$random2}, with the appropriate values substituted for each bracketed variable. Please note that this code assumes the target file to be world writable (-rw-rw-rw- or 666) and will fail to save properly without error if it is not.

Once again, this is by no means secure or permanent, but as a quick fix for brief edits to noncritical files it should be sufficient, and its small size is a definite bonus.
egingell at sisna dot com
21.12.2007 4:15
There is a better way.

Since you're not adding anything to the file,

function updateFile($filename) {
    if (!
file_exists($filename)) return;
me at briandichiara dot com
4.10.2007 21:20
I was in need of a function that updated the last modified date in a php file. There may be a better way, but this is how I did it:

function updateFile($modFile){
$fo = fopen($modFile, 'r')){
$source = '';
            while (!
feof($fo)) {
$source .= fgets($fo);
21.12.2006 12:20
As to the previous user note, it would be wise to include that code within a conditional statement, as to prevent re-defining file_put_contents and the FILE_APPEND constant in PHP 5:

if ( !function_exists('file_put_contents') && !defined('FILE_APPEND') ) {

Also, if the file could not be accessed for writing, the function should return boolean false, not 0. An error is different from 0 bytes written, in this case.
egingell at sisna dot com
23.07.2006 13:11
In reply to the previous note:

If you want to emulate this function in PHP4, you need to return the bytes written as well as support for arrays, flags.

I can only figure out the FILE_APPEND flag and array support. If I could figure out "resource context" and the other flags, I would include those too.


file_put_contents($n, $d, $flag = false) {
$mode = ($flag == FILE_APPEND || strtoupper($flag) == 'FILE_APPEND') ? 'a' : 'w';
$f = @fopen($n, $mode);
    if (
$f === false) {
    } else {
        if (
is_array($d)) $d = implode($d);
$bytes_written = fwrite($f, $d);

sendoshin at awswan dot com
6.03.2006 8:01
To clear up what was said by pvenegas+php at gmail dot com on 11-Oct-2005 08:13, file_put_contents() will replace the file by default.  Here's the complete set of rules this function follows when accessing a file:

1.  Was FILE_USE_INCUDE_PATH passed in the call?  If so, check the include path for an existing copy of *filename*.

2.  Does the file already exist?  If not, first create it in the current working directory.  Either way, open the file.

3.  Was LOCK_EX passed in the call?  If so, lock the file.

4.  Was the function called with FILE_APPEND?  If not, clear the file's contents.  Otherwise, move to the end of the file.

5.  Write *data* into the file.

6.  Close the file and release any locks.

If you don't want to completely replace the contents of the file you're writing to, be sure to use FILE_APPEND (same as fopen() with 'a') in the *flags*.  If you don't, whatever used to be there will be gone (fopen() with 'w').

Hope that helps someone (and that it makes sense ^^)!

- Sendoshin
aidan at php dot net
21.05.2004 4:11
This functionality is now implemented in the PEAR package PHP_Compat.

More information about using this function without upgrading your version of PHP can be found on the below link:

PHP Powered Diese Seite bei
The PHP manual text and comments are covered by the Creative Commons Attribution 3.0 License © the PHP Documentation Group - Impressum - mail("TO:Reinhard Neidl",...)