file_get_contentsReads entire file into a string
&reftitle.description;
stringfile_get_contentsstringfilenamebooluse_include_pathfalseresourcecontextintoffset0intmaxlen
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.
If you're opening a URI with special characters, such as spaces, you
need to encode the URI with urlencode.
&reftitle.parameters;
filename
Name of the file to read.
use_include_path
As of PHP 5 the FILE_USE_INCLUDE_PATH constant can be used
to trigger include path
search.
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.
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.
maxlen
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.
&reftitle.returnvalues;
The function returns the read data &return.falseforfailure;.
&return.falseproblem;
&reftitle.errors;
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.
&reftitle.examples;
Get and output the source of the homepage of a website
]]>
Searching within the include_path
PHP 5
$file = file_get_contents('./people.txt', FILE_USE_INCLUDE_PATH);
?>
]]>
Reading a section of a file
]]>
&example.outputs.similar;
Using stream contexts
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);
?>
]]>
&reftitle.changelog;
&Version;&Description;5.1.0
Added the offset and
maxlen parameters.
&reftitle.notes;
¬e.bin-safe;
&tip.fopen-wrapper;
&warn.ssl-non-standard;
&reftitle.seealso;
filefgetsfreadreadfilefile_put_contentsstream_get_contentsstream_context_create$http_response_header