PHP Manual: file_put_contents


Enter the keyword for better results

file_put_contents

(PHP 5)

file_put_contents -- Write a string to a file

Description

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

Identical to calling fopen(), fwrite(), and fclose() successively.

You can also specify the data parameter as an array (not multi-dimension arrays). This is equivalent to file_put_contents($filename, implode('', $array)).

Parameters

filename

The file name where to write the data

data

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

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().

flags

flags can take FILE_USE_INCLUDE_PATH, FILE_APPEND and/or LOCK_EX (acquire an exclusive lock), however the FILE_USE_INCLUDE_PATH option should be used with caution. As of PHP 6, it can also take one of FILE_TEXT or FILE_BINARY to specify how newlines should be handled when outputting the file. See fopen()'s "t" and "b" modes for more information.

context

A context resource

Return Values

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

ChangeLog

VersionDescription
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
6.0.0 Added support for FILE_TEXT and FILE_BINARY

Notes

Note: This function is binary-safe.

Note: Context support was added with PHP 5.0.0. For a description of contexts, refer to Reference CLX, Stream Functions.

Tip: You can use a URL as a filename with this function if the fopen wrappers have been enabled. See fopen() for more details on how to specify the filename and Appendix O for a list of supported URL protocols.