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.
&reftitle.parameters;
filename
Name of the file to read.
flags
For all versions prior to PHP 6, this parameter is called
use_include_path and is a bool.
The flags parameter is only available since
PHP 6. If you use an older version and want to search for
filename in the
include path, this
parameter must be &true;. Since PHP 6, you have to use the
FILE_USE_INCLUDE_PATH flag instead.
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
If unicode semantics are enabled, 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.
maxlen
Maximum length of data read.
&reftitle.returnvalues;
The function returns the read data or &false; on failure.
&reftitle.changelog;
&Version;&Description;5.0.0
Added context support.
5.1.0
Added the offset and
maxlen parameters.
6.0.0
The use_include_path parameter was replaced by
the flags parameter.
&reftitle.notes;
¬e.bin-safe;
&tip.fopen-wrapper;
&warn.ssl-non-standard;
&reftitle.seealso;
filefgetsfreadreadfilefile_put_contentsstream_get_contentsstream_context_create