file_get_contents

Reads entire file into a string.

file_get_contents Function synopsis

file_get_contents(
    string $filename,
    bool $use_include_path = false,
    $context = null,
    int $offset = 0,
    ?int $length = null
  ): string|false

Parameters

$filename

Typestring

Name of the file to read.

$use_include_path

OptionalTypeboolDefault valuefalse

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

$context

OptionalDefault valuenull

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

OptionalTypeintDefault value0

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

$length

OptionalType?intDefault valuenull

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 value

Typestring|false

The function returns the read data or false on failure.