file_put_contents
(PHP 5, PHP 7, PHP 8)
file_put_contents — Escreve uma string para um arquivo
Descrição
file_put_contents
(
string $filename
,
mixed $data
,
int $flags
= ?
,
resource $context
= ?
) :
int
Se filename
não existir, o arquivo é criado.
Do contrário, o arquivo existente é sobrescrito, a não ser que
a flag FILE_APPEND
seja definida.
Parâmetros
-
filename
-
O caminho para o arquivo onde escrever os dados.
-
data
-
Os dados a serem escritos. Pode ser uma string, um
array ou um recurso stream (explicado abaixo).
Se data
for um recurso stream, o
buffer restante desse stream será copiado para o arquivo especificado,
semelhante à utilização da stream_copy_to_stream().
Você também pode especificar o parâmetro data
como um
array unidimensional. Isso é equivalente a
file_put_contents($filename, implode('', $array))
.
-
flags
-
O valor de flags
pode ser qualquer combinação das
seguintes flags (com algumas restrições), unidas com o operador binário OR
(|
).
Flags disponíveis
Flag |
Descrição |
FILE_USE_INCLUDE_PATH
|
Procura o arquivo filename nos diretórios de include.
Veja include_path para mais
informações.
|
FILE_APPEND
|
Se o arquivo filename já existir, acrescenta
os dados ao arquivo ao invés de sobrescrevê-lo.
|
LOCK_EX
|
Adquire um bloqueio exclusivo enquanto estiver escrevendo.
|
FILE_TEXT
|
Os dados de data são escritos em modo texto.
Se a semântica unicode estiver habilitada, o encoding padrão é UTF-8.
Você pode especificar um encoding diferente criando um
contexto personalizado ou alterando o encoding padrão utilizando
stream_default_encoding(). Esta flag não pode ser
usada com FILE_BINARY e está disponível apenas
a partir do PHP 6.
|
FILE_BINARY
|
Os dados de data serão escritos em modo binário.
Esta é a opção padrão e não pode ser utilizada com
FILE_TEXT . Esta flag está disponível apenas a partir
do PHP 6.
|
-
context
-
Um recurso de contexto válido criado com
stream_context_create().
Valor Retornado
A função retorna a quantidade de bytes que foi escrita no arquivo ou
false
em caso de falha.
Notas
Nota: Esta função é
binary-safe.
DicaUma URL pode ser utilizada como
um nome de arquivo se fopen wrappers estiver ativo.
Veja fopen() para mais detalhes em como especificar
o filename. Veja também the Protocolos e Wrappers suportados para informações sobre
que capacidades cada wrapper tem, notas de uso e
informações sobre variáveis predefinidas
fornecidas.