PHP: Hypertext Preprocessor

file_get_contents

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

file_get_contents — Reads entire file into a string

Description

file_get_contents() is the preferred way to read the
contents of a file into a string. It will use memory mapping techniques if
supported by your OS to enhance performance.

Note:

If you’re opening a URI with special characters, such as spaces, you
need to encode the URI with urlencode().

Parameters

filename

Name of the file to read.

use_include_path

Note:

The FILE_USE_INCLUDE_PATH constant can be used
to trigger include path
search.
This is not possible if strict typing
is enabled, since FILE_USE_INCLUDE_PATH is an
int. Use true instead.

context

A valid context resource created with
stream_context_create(). If you don’t need to use a
custom context, you can skip this parameter by null.

offset

The offset where the reading starts on the original stream.
Negative offsets count from the end of the stream.

Seeking (offset) is not supported with remote files.
Attempting to seek on non-local files may work with small offsets, but this
is unpredictable because it works on the buffered stream.

length

Maximum length of data read. The default is to read until end
of file is reached. Note that this parameter is applied to the
stream processed by the filters.

Return Values

The function returns the read data or false on failure.

Warning

This function may
return Boolean false, but may also return a non-Boolean value which
evaluates to false. Please read the section on Booleans for more
information. Use the ===
operator for testing the return value of this
function.

Errors/Exceptions

An E_WARNING level error is generated if filename cannot be found, length
is less than zero, or if seeking to the specified offset in the stream fails.

When file_get_contents() is called on a directory,
an E_WARNING level error is generated on Windows,
and as of PHP 7.4 on other operating systems as well.

Changelog

Version	Description
8.0.0	`length` is nullable now.
7.1.0	Support for negative `offset`s has been added.

Examples

Example #1 Get and output the source of the homepage of a website

<?php $homepage = file_get_contents('http://www.example.com/'); echo $homepage; ?>

Example #2 Searching within the include_path

<?php // If strict types are enabled i.e. declare(strict_types=1); $file = file_get_contents('./people.txt', true); // Otherwise $file = file_get_contents('./people.txt', FILE_USE_INCLUDE_PATH); ?>

Example #3 Reading a section of a file

<?php // Read 14 characters starting from the 21st character $section = file_get_contents('./people.txt', FALSE, NULL, 20, 14); var_dump($section); ?>

The above example will output
something similar to:

string(14) "lle Bjori Ro"

Example #4 Using stream contexts

<?php // Create a stream $opts = array( 'http'=>array( 'method'=>"GET", 'header'=>"Accept-language: en\r\n" . "Cookie: foo=bar\r\n" ) );$context = stream_context_create($opts);// Open the file using the HTTP headers set above $file = file_get_contents('http://www.example.com/', false, $context); ?>

Notes

Note: This function is
binary-safe.

Tip

A URL can be used as a
filename with this function if the fopen wrappers have been enabled.
See fopen() for more details on how to specify the
filename. See the Supported Protocols and Wrappers for links to information
about what abilities the various wrappers have, notes on their usage,
and information on any predefined variables they may
provide.

Warning

When using SSL, Microsoft IIS
will violate the protocol by closing the connection without sending a
close_notify indicator. PHP will report this as “SSL: Fatal
Protocol Error” when you reach the end of the data. To work around this, the
value of error_reporting should be
lowered to a level that does not include warnings.
PHP can detect buggy IIS server software when you open
the stream using the https:// wrapper and will suppress the
warning. When using fsockopen() to create an
ssl:// socket, the developer is responsible for detecting
and suppressing this warning.

Improve This Page

Bart Friederichs ¶

12 years ago

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);

?>

KC ¶

10 months ago

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.
    }
}

brentcontact at daha dot us ¶

1 year ago

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.

daniel at dangarbri dot tech ¶

1 year ago

Note that if an HTTP request fails but still has a response body, the result is still false, Not the response body which may have more details on why the request failed.

soger ¶

2 years ago

There's barely a mention on this page but the $http_response_header will be populated with the HTTP headers if your file was a link. For example if you're expecting an image you can do this:


<?php
$data = file_get_contents('https://example.net/some-link');$mimetype = null;
foreach ($http_response_header as $v) {
    if (preg_match('/^content\-type:\s*(image\/[^;\s\n\r]+)/i', $v, $m)) {
        $mimetype = $m[1];
    }
}
if (!
$mimetype) {
    // not an image
}