PHP file_put_contents 文件系统函数
-
定义和用法
file_put_contents - 将一个字符串写入文件 -
版本支持
PHP4 PHP5 PHP7 支持 支持 支持 5.0.0 添加了 context 支持
5.1.0 添加了对 LOCK_EX 的支持和 data 参数处理 stream 资源的功能。
-
语法
file_put_contents ( string $filename , mixed $data [, int $flags = 0 [, resource $context ]] )
和依次调用 fopen(),fwrite() 以及 fclose() 功能一样。 如果 filename 不存在,则创建文件。 否则,除非设置了FILE_APPEND标志,否则现有文件将被覆盖。 -
参数
参数 必需的 描述 filename 是 要被写入数据的文件名。 data 是 要写入的数据。类型可以是 string,array 或者是 stream 资源(如上面所说的那样)。 如果 data 指定为 stream 资源,这里 stream 中所保存的缓存数据将被写入到指定文件中,这种用法就相似于使用 stream_copy_to_stream() 函数。 参数 data 可以是数组(但不能为多维数组),这就相当于 file_put_contents($filename, join('', $array))。 context 否 使用stream_context_create() 创建的有效上下文资源。 如果您不需要自定义context,可以用NULL来忽略。 flags 否 flags 的值可以是 以下 flag 使用 OR (|) 运算符进行的组合。 - FILE_USE_INCLUDE_PATH - 在 include 目录里搜索 filename。 更多信息可参见 include_path。
- FILE_APPEND - 如果文件 filename 已经存在,追加数据而不是覆盖。
- LOCK_EX - 在写入时获得一个独占锁。
context 否 一个 context 资源。 -
返回值
该函数将返回写入到文件内数据的字节数,失败时返回FALSE此函数可能返回布尔值 FALSE,但也可能返回等同于 FALSE 的非布尔值。请阅读 布尔类型章节以获取更多信息。应使用 === 运算符来测试此函数的返回值。
-
示例
<?php $file = 'people.txt'; // 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 file_put_contents($file, $current); ?>
-
相关函数
fopen() - 打开文件或者 URLfwrite() - 写入文件(可安全用于二进制文件)file_get_contents() - 将整个文件读入一个字符串stream_context_create() - 创建资源流上下文