This function is similar to file(), except that file_get_contents() returns the file in a string, starting at the specified offset
up to maxlen
bytes. On failure, file_get_contents() will return FALSE
.
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().
Name of the file to read.
Note:
As of PHP 5 the
FILE_USE_INCLUDE_PATH
constant can be used to trigger include path search.
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
.
The offset where the reading starts on the original 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.
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.
The function returns the read data or FALSE
on failure.
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.
An E_WARNING
level error is generated if filename
cannot be found, maxlength
is less than zero, or if seeking to the specified offset
in the stream fails.
Added the offset
and maxlen
parameters.
<?php $homepage = file_get_contents('http://www.example.com/'); echo $homepage; ?>
<?php // <= PHP 5 $file = file_get_contents('./people.txt', true); // > PHP 5 $file = file_get_contents('./people.txt', FILE_USE_INCLUDE_PATH); ?>
<?php // Read 14 characters starting from the 21st character $section = file_get_contents('./people.txt', NULL, NULL, 20, 14); var_dump($section); ?>
The above example will output something similar to:
string(14) "lle Bjori Ro"
<?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); ?>
file() -
fgets() -
fread() -
Please login to continue.