file_get_contentsReads entire file into a string
&reftitle.description;
stringfile_get_contentsstringfilenameintflags0resourcecontextintoffset-1intmaxlen-1
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.
The default value of maxlen is not
actually -1; rather, it is an internal PHP
value which means to copy the entire stream until end-of-file is
reached. The only way to specify this default value is to leave it
out of the parameter list.
&reftitle.parameters;
filename
Name of the file to read.
flags
Prior to PHP 6, this parameter is called
use_include_path and is a bool.
As of PHP 5 the FILE_USE_INCLUDE_PATH can be used
to trigger include path
search.
The value of flags can be any combination of
the following flags (with some restrictions), joined with the
binary OR (|)
operator.
Available flagsFlagDescriptionFILE_USE_INCLUDE_PATH
Search for filename in the include directory.
See include_path for more
information.
FILE_TEXT
As of PHP 6, the default encoding of the read
data is UTF-8. You can specify a different encoding by creating a
custom context or by changing the default using
stream_default_encoding. This flag cannot be
used with FILE_BINARY.
FILE_BINARY
With this flag, the file is read in binary mode. This is the default
setting and cannot be used with FILE_TEXT.
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.
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;.
&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;6.0.0
The use_include_path parameter was replaced by
the flags parameter.
5.1.0
Added the offset and
maxlen parameters.
5.0.0
Added context support.
&reftitle.notes;
¬e.bin-safe;
&tip.fopen-wrapper;
&warn.ssl-non-standard;
&reftitle.seealso;
filefgetsfreadreadfilefile_put_contentsstream_get_contentsstream_context_create