Sistema de archivos
PHP Manual

file_put_contents

(PHP 5)

file_put_contents — Escribir una cadena sobre un archivo

Descripción

int file_put_contents ( string $nombre_archivo , mixed $datos [, int $banderas [, resource $contexto ]] )

Esta función es idéntica a llamar fopen(), fwrite(), y fclose() sucesivamente para escribir datos en un archivo.

Si nombre_archivo no existe, el archivo es creado. De lo contrario, el archivo existente el sobrescrito, a menos que la bandera FILE_APPEND sea definida.

Lista de parámetros

nombre_archivo

Ruta al archivo en donde escribir los datos

datos

Los datos a escribir. Puede ser un valor tipo string, array o un recurso stream (explicado anteriormente).

Si datos es un recurso de tipo stream, el resto del búfer de esa secuencia será copiado al archivo especificado. Esto es similar al uso de stream_copy_to_stream().

También es posible especificar el parámetro datos como una matriz uni-dimensional. Esto es equivalente a file_put_contents($nombre_archive, implode('', $matriz)).

banderas

El valor de banderas puede ser cualquier combinación de las siguientes banderas (con algunas restricciones), unidas con el operador binario OR (|).

Banderas disponibles
Bandera Descripción
FILE_USE_INCLUDE_PATH Buscar por nombre_archivo en el directorio de inclusiones. Vea include_path para más información.
FILE_APPEND Si el archivo nombre_archivo ya existe, anexar los datos al archivo en lugar de sobrescribirlo.
LOCK_EX Adquirir un bloqueo exclusivo sobre el archivo mientras se procede con la escritura.
FILE_TEXT datos es escrito en modo de texto. Si la semántica unicode está habilitada, la codificación predeterminada es UTF-8. Es posible especificar una codificación diferente creando un contexto personalizado o modificando el predeterminado mediante stream_default_encoding(). Esta bandera no puede ser usada junto con FILE_BINARY. Esta bandera está disponible únicamente a partir de PHP 6.
FILE_BINARY datos será escrito en modo binario. Este es el comportamiento predeterminado y la bandera no pude ser usada junto con FILE_TEXT. Esta bandera está disponible únicamente desde PHP 6.

contexto

Un recurso de contexto creado con stream_context_create().

Valores retornados

La función devuelve la cantidad de bytes escritos al archivo, o FALSE en caso de fallo.

Registro de cambios

Versión Descripción
5.0.0 Se agregó el soporte para contextos
5.1.0 Se agregó soporte para LOCK_EX y la habilidad de pasar un recurso de secuencia al parámetro datos
6.0.0 Se agregó el soporte para las banderas FILE_TEXT y FILE_BINARY

Notes

Note: Esta función es segura binariamente.

Tip

Puede usar una URL como nombre de archivo con esta función si los fopen wrappers han sido activados. Consulte fopen() para más detalles sobre cómo especificar el nombre de fichero y Lista de Protocolos/Envolturas Soportadas una lista de protocolos URL soportados

Ver también


Sistema de archivos
PHP Manual