file_put_contents()

❮ PHP 文件系统参考手册

实例

将数据写入文件:

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

上述代码的输出为:

21

---

定义和用法

file_put_contents() 函数把数据写入文件中。

与依次调用 fopen()，fwrite() 以及 fclose() 功能一样。

此函数在访问文件时遵循以下规则:

1. 如果设置了 FILE_USE_INCLUDE_PATH，请检查 文件名的副本的包含路径
2. 如果文件不存在则创建文件
3. 打开文件
4. 如果设置了 LOCK_EX，则锁定文件
5. 如果设置了 FILE_APPEND，则移至文件末尾。 否则，清除文件内容
6. 将数据写入文件
7. 关闭文件并释放所有锁

注释:使用 FILE_APPEND 避免删除文件的现有内容。

语法

file_put_contents(filename, data, mode, context)

参数值

参数	描述
filename	必需。规定要写入数据的文件。如果文件不存在，则创建一个新文件。
data	可选。规定要写入文件的数据。可以是字符串、数组或数据流。
mode	可选。规定如何打开/写入文件。可能的值: FILE_USE_INCLUDE_PATH - 在包含目录中搜索文件名 FILE_APPEND - 如果文件已存在，则将数据附加到其中 - 而不是覆盖它 LOCK_EX - 在写入文件时对文件设置排他锁
context	可选。规定文件句柄的环境。 context 是一套可以修改流的行为的选项。若使用 null，则忽略。

说明

参数 data 可以是数组（但不能是多维数组）。

自 PHP 5.1.0 起，data 参数也可以被指定为 stream 资源，stream 中所保存的缓存数据将被写入到指定文件中，这种用法就相似于使用 stream_copy_to_stream() 函数。

对 context 参数的支持是 PHP 5.0.0 添加的。

返回值

该函数将返回写入到文件内数据的字节数。

---

提示和注释

提示:使用 FILE_APPEND 可避免删除文件中已有的内容。

注释:本函数可安全用于二进制对象。

---

---

技术细节

返回值:	成功时写入文件的字节数，失败时为 FALSE
PHP 版本:	5.0+
Binary Safe:	Yes
PHP 更新日志:	PHP 5.1 - 添加了对 LOCK_EX 的支持以及将流资源传递给数据参数的能力

---

❮ PHP 文件系统参考手册