file_put_contents
(PHP 5, PHP 7)
file_put_contents — Escreve uma string para um arquivo
Descrição
Esta função é idêntica à chamar fopen(), fwrite() e fclose() sucessivamente para escrever dados em um arquivo.
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
datafor 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
datacomo um array unidimensional. Isso é equivalente a file_put_contents($filename, implode('', $array)). -
flags -
O valor de
flagspode 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_PATHProcura o arquivo filenamenos diretórios de include. Veja include_path para mais informações.FILE_APPENDSe o arquivo filenamejá existir, acrescenta os dados ao arquivo ao invés de sobrescrevê-lo.LOCK_EXAdquire um bloqueio exclusivo enquanto estiver escrevendo. FILE_TEXTOs dados de datasã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 comFILE_BINARYe está disponível apenas a partir do PHP 6.FILE_BINARYOs dados de dataserão escritos em modo binário. Esta é a opção padrão e não pode ser utilizada comFILE_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.
Changelog
| Versão | Descrição |
|---|---|
| 5.0.0 | Adicionado suporte a contexto |
| 5.1.0 |
Adicionado suporte a LOCK_EX e a possibilidade de passar
um recurso de stream para o parâmetro data
|
| 6.0.0 |
Adicionado suporte às flags FILE_TEXT e
FILE_BINARY
|
Notas
Nota: Esta função é binary-safe.
Uma URL pode ser utilizada como um nome de arquivo se fopen wrappers estiver ativo. Veja fopen() para mais detalhes em como especificar URLs como nome de arquivo. 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.
Veja Também
- fopen() - Abre um arquivo ou URL
- fwrite() - Escrita binary-safe em arquivos
- file_get_contents() - Lê todo o conteúdo de um arquivo para uma string
- stream_context_create() - Creates a stream context
add a note
