file_put_contents
(PHP 5, PHP 7, PHP 8)
file_put_contents — 将一个字符串写入文件
说明
file_put_contents(
string $filename
,
mixed $data
,
int $flags
= 0,
resource $context
= ?):
int
If filename
does not exist, the file is created.
Otherwise, the existing file is overwritten, unless the
FILE_APPEND
flag is set.
参数
-
filename
-
要被写入数据的文件名。
-
data
-
要写入的数据。类型可以是 string,array
或者是 stream 资源(如上面所说的那样)。
如果 data
指定为 stream 资源,这里 stream
中所保存的缓存数据将被写入到指定文件中,这种用法就相似于使用
stream_copy_to_stream() 函数。
参数 data
可以是数组(但不能为多维数组),这就相当于
file_put_contents($filename, join('', $array))
。
-
flags
-
flags
的值可以是
以下 flag 使用 OR (|
) 运算符进行的组合。
Available flags
Flag |
描述 |
---|
FILE_USE_INCLUDE_PATH
|
在 include 目录里搜索 filename 。
更多信息可参见 include_path。
|
FILE_APPEND
|
如果文件 filename 已经存在,追加数据而不是覆盖。
|
LOCK_EX
|
在写入时获得一个独占锁。
|
-
context
-
一个 context 资源。
返回值
该函数将返回写入到文件内数据的字节数,失败时返回false
警告此函数可能返回布尔值
false
,但也可能返回等同于 false
的非布尔值。请阅读 布尔类型章节以获取更多信息。应使用
===
运算符来测试此函数的返回值。
范例
示例 #1 Simple usage example
<?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);
?>
示例 #2 Using flags
<?php
$file = 'people.txt';
// 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, $person, FILE_APPEND | LOCK_EX);
?>