(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
file_get_contents — Lê todo o conteúdo de um arquivo para uma string
$filename,$use_include_path = false,$context = null,$offset = 0,$length = null
Esta função é semelhante à file(), exceto que
file_get_contents() retorna o arquivo em uma
string, começando a partir de offset
até length bytes. Em caso de falha,
file_get_contents() retornará false.
file_get_contents() é o método preferível para ler o conteúdo de um arquivo em uma string. Ela usa técnicas de mapeamento de memória suportadas pelo sistema operacional para melhorar o desempenho.
Nota:
Se for aberta uma URI com caracteres especiais, como espaços, é necessário codificar a URI com urlencode().
filenameNome do arquivo para ler.
use_include_pathNota:
A constante
FILE_USE_INCLUDE_PATHpode ser usada para acionar a busca no include path. Isto não é possível se a tipagem estrita estiver habilitada, já queFILE_USE_INCLUDE_PATHé um int. Em vez disso, usetrue.
context
Um recurso de contexto válido, criado com
stream_context_create(). Se você não precisa usar um
contexto personalizado, você pode ignorar este parâmetro passando null.
offsetO ponto onde a leitura deve começar no fluxo original. Offsets negativos contam a partir do final do fluxo.
offset não é suportado em arquivos remotos.
Tentar fazer busca em arquivos não locais pode funcionar com offsets
pequenos, mas isso é imprevisível pois só funciona no fluxo com buffer.
lengthComprimento máximo dos dados lidos. O padrão é ler até que o fim do arquivo seja alcançado. Note que este parâmetro é aplicado para o fluxo processado pelos filtros.
A função retorna os dados lidos ou false em caso de falha.
Esta função pode
retornar o valor booleano false, mas também pode retornar um valor não booleano que pode ser
avaliado como false. Leia a seção sobre Booleanos para mais
informações. Use o operador
=== para testar o valor retornado por esta
função.
Um erro de nível E_WARNING é gerado se filename não puder ser encontrado,
length é menor que zero, ou se a busca no fluxo pelo offset especificado falhar.
Quando file_get_contents() é chamada em um diretório, um
erro nível E_WARNING é gerado no Windows, e a partir
do PHP 7.4 em outros sistemas operacionais também.
| Versão | Descrição |
|---|---|
| 8.0.0 |
length agora é anulável.
|
| 7.1.0 |
Suporte para offsets negativos foi adicionado.
|
Exemplo #1 Obtém e exibe o código-fonte da página inicial de um website
<?php
$homepage = file_get_contents('http://www.example.com/');
echo $homepage;
?>Exemplo #2 Buscando no include_path
<?php
// Se strict types estiver ativado com declare(strict_types=1);
$file = file_get_contents('./people.txt', true);
// Se não
$file = file_get_contents('./people.txt', FILE_USE_INCLUDE_PATH);
?>Exemplo #3 Lendo uma sessão de um arquivo
<?php
// Le 14 letras começando da letra 21
$section = file_get_contents('./people.txt', FALSE, NULL, 20, 14);
var_dump($section);
?>O exemplo acima produzirá algo semelhante a:
string(14) "lle Bjori Ro"
Exemplo #4 Usando contextos de fluxo
<?php
// Criam um fluxo
$opts = [
'http' => [
'method' => "GET",
'header' => "Accept-language: en\r\n" .
"Cookie: foo=bar\r\n"
]
];
$context = stream_context_create($opts);
// Abre o arquivo utilizando os headers HTTP craidos acima
$file = file_get_contents('http://www.example.com/', false, $context);
?>Nota: Esta função é compatível com dados binários.
Uma URL pode ser usada como um nome de arquivo com esta função se os empacotadores fopen estiverem habilitados. Consulte a função fopen() para mais detalhes sobre como especificar o nome do arquivo. Consulte os Protocolos e empacotadores suportados para obter links para informações sobre as capacidades de cada empacotador, notas de uso e informações sobre quaisquer variáveis predefinidas que eles possam fornecer.
Ao usar SSL, o Microsoft IIS
violará o protocolo fechando a conexão sem enviar uma notificação
close_notify. O PHP reportará isso como "SSL: Fatal
Protocol Error" quando chegar ao final dos dados. Para contornar isso, o
valor de error_reporting deve ser
reduzido a um nível que não inclua avisos.
O PHP pode detectar servidores IIS defeituosos quando o fluxo
é aberto usando o empacotador https:// e suprimirá o aviso.
Ao usar fsockopen() para criar um soquete
ssl://, o desenvolvedor é responsável por detectar
e suprimir este aviso.
file_get_contents can do a POST, create a context for that first:
<?php
$opts = array('http' =>
array(
'method' => 'POST',
'header' => "Content-Type: text/xml\r\n".
"Authorization: Basic ".base64_encode("$https_user:$https_password")."\r\n",
'content' => $body,
'timeout' => 60
)
);
$context = stream_context_create($opts);
$url = 'https://'.$https_server;
$result = file_get_contents($url, false, $context, -1, 40000);
?>To prevent mixed content most browsers/functions will use the protocol already used if you specify only // instead of http:// or https://. This is not the case with file_get_contents. You must specify the protocol.
This does not work:
<?php
$jsonData = file_get_contents('//example.com/file.json');
print $jsonData;
?>
Specifying only 'example.com/file.json' without the double slash does not work either.
When running on Apache 2.4 , using $_SERVER['REQUEST_SCHEME'] is a better way to be protocol agnostic.
<?php
$jsonData = file_get_contents($_SERVER['REQUEST_SCHEME'].'://example.com/file.json');
print $jsonData;
?>
If using another web server, you may have to get the protocol another way or hard code it.If doing a negative offset to grab the end of a file and the file is shorter than the offset, then file_get_contents( ) will return false.
If you want it to just return what is available when the file is shorter than the negative offset, you could try again.
For example...
$contents = file_get_contents( $log_file, false, null, -4096 ); // Get last 4KB
if ( false === $contents ) {
// Maybe error, or maybe file less than 4KB in size.
$contents = file_get_contents( $log_file, false, null );
if ( false === $contents ) {
// Handle real error.
}
}