file_get_contents

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

file_get_contents — Считывает содержимое файла в строку

Описание

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

Функция похожа на функцию file(), за исключением того, что функция file_get_contents() возвращает содержимое файла в строке длиной length байтов со смещения offset. Функция file_get_contents() вернёт false, если возникнет ошибка.

Вызов функции file_get_contents() наиболее предпочтителен, когда требуется получить содержимое файла целиком, поскольку для улучшения производительности функция использует технику отображения файла в памяти (memory mapping), если операционная система её поддерживает.

Замечание:
При открытии URI, который содержит спецсимволы наподобие пробела, URI-идентификатор кодируют функцией urlencode().

Список параметров

filename

Имя читаемого файла.

use_include_path

Замечание:
Для поиска файла в списке путей директивы include path в параметр перадают константу FILE_USE_INCLUDE_PATH. Обратите внимание, в коде со строгой типизацией так сделать не получится, потому что значение константы FILE_USE_INCLUDE_PATH принадлежит типу int. В строгом режиме лучше установить значение true.

context

Корректный ресурс контекста, который возвращает функция stream_context_create(). В параметр передают значение null, если специфичный контекст не требуется.

offset

Смещение, с которого начнётся чтение оригинального потока. Отрицательное значение смещения отсчитывается с конца потока.

Поиск смещения offset не поддерживается при работе с удалёнными файлами. Попытка поиска смещения на нелокальных файлах иногда работает при небольших смещениях, но результат будет непредсказуемым, поскольку функция работает на буферизованном потоке.

length

Максимальный размер читаемых данных. По умолчанию чтение осуществляется пока не будет достигнут конец файла. Учтите, что этот параметр применяется и к потоку с фильтрами.

Возвращаемые значения

Функция возвращает данные, которые считала, или false, если возникла ошибка.

Внимание

Функция возвращает как логическое значение false, так и нелогическое значение, которое приводится к false. Прочитайте раздел «Логический тип», чтобы получить дополнительную информацию. Используйте оператор === для проверки значения, которое возвращает функция.

Ошибки

Функция выдаст ошибку уровня E_WARNING, если не найдёт файл filename, для параметра length установили значение меньше нуля или поиск по смещению offset в потоке завершится неудачно.

При вызове функции file_get_contents() на каталоге в ОС Windows генерируется ошибка уровня E_WARNING, а с PHP 7.4 и в других операционных системах.

Список изменений

Версия	Описание
8.0.0	Параметр `length` теперь принимает значение `null`.
7.1.0	Добавили поддержку отрицательных значений для смещения `offset`.

Примеры

Пример #1 Пример получения и вывода исходного кода домашней страницы сайта

<?php

$homepage = file_get_contents('http://www.example.com/');
echo $homepage;

?>

Пример #2 Поиск файлов в include_path

<?php

// Если включили строгую типизацию, то есть объявили (strict_types=1);
$file = file_get_contents('./people.txt', true);

// Иначе
$file = file_get_contents('./people.txt', FILE_USE_INCLUDE_PATH);

?>

Пример #3 Чтение секции файла

<?php

// Читаем 14 символов, начиная с 21 символа
$section = file_get_contents('./people.txt', FALSE, NULL, 20, 14);

var_dump($section);

?>

Вывод приведённого примера будет похож на:

string(14) "lle Bjori Ro"

Пример #4 Работа функции с потоковыми контекстами

<?php

// Создаём поток
$opts = [
  'http' => [
    'method' => "GET",
    'header' => "Accept-language: en\r\n" .
                "Cookie: foo=bar",
  ]
];

$context = stream_context_create($opts);

// Открываем файл с установленными HTTP-заголовками
$file = file_get_contents('http://www.example.com/', false, $context);

?>

Примечания

Замечание: Функция безопасна для обработки данных в двоичной форме.

Подсказка

Вместо названий файлов функция принимает URL-адреса, если включили директиву fopen wrappers. Подробнее об определении названия файла рассказывает описание функции fopen(). Раздел «Протоколы и обёртки» также даёт ссылки на информацию о поддерживаемых обёртках, содержит замечания по работе с обёртками и приводит список предопределённых переменных, которые они дают.

Внимание

При работе с сервером Microsoft IIS по SSL-протоколу разработчик сталкивается с тем, что IIS-сервер нарушает протокол путём закрытия соединения без отправки индикатора close_notify. PHP выдаст ошибку в виде сообщения «SSL: Fatal Protocol Error» при достижении конца данных. Чтобы избежать такого поведения, значение директивы error_reporting снижают до уровня, который не включает предупреждений уровня E_WARNING. PHP умеет обнаруживать ошибочное программное обеспечение IIS-сервера при открытии потока через обёртку https://, и подавляет предупреждение. За обнаружение и подавление предупреждения отвечает разработчик, который вызывает функцию fsockopen(), чтобы создать сокет ssl://.

Смотрите также

file() - Читает содержимое файла и помещает его в массив
fgets() - Получает строку из указателя на файл
fread() - Читает файл в бинарно-безопасном режиме: как последовательность байтов
readfile() - Выводит файл
file_put_contents() - Записывает данные в файл
stream_get_contents() - Читает оставшуюся часть потока в строку
stream_context_create() - Создаёт контекст потока
$http_response_header

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей 3 notes

down

Bart Friederichs ¶

13 years ago

file_get_contents can do a POST, create a context for that first:



<?php



$opts = array('http' =>

  array(

    'method'  => 'POST',

    'header'  => "Content-Type: text/xml\r\n".

      "Authorization: Basic ".base64_encode("$https_user:$https_password")."\r\n",

    'content' => $body,

    'timeout' => 60

  )

);

                        

$context  = stream_context_create($opts);

$url = 'https://'.$https_server;

$result = file_get_contents($url, false, $context, -1, 40000);



?>

down

brentcontact at daha dot us ¶

2 years ago

To prevent mixed content most browsers/functions will use the protocol already used if you specify only // instead of http:// or https://. This is not the case with file_get_contents. You must specify the protocol. 

This does not work:
<?php
$jsonData = file_get_contents('//example.com/file.json');
print $jsonData;
?>

Specifying only 'example.com/file.json' without the double slash does not work either.

When running on Apache 2.4 , using $_SERVER['REQUEST_SCHEME'] is a better way to be protocol agnostic.
<?php
$jsonData = file_get_contents($_SERVER['REQUEST_SCHEME'].'://example.com/file.json');
print $jsonData;
?>

If using another web server, you may have to get the protocol another way or hard code it.

down

KC ¶

1 year ago

If doing a negative offset to grab the end of a file and the file is shorter than the offset, then file_get_contents( ) will return false.

If you want it to just return what is available when the file is shorter than the negative offset, you could try again.

For example...

$contents = file_get_contents( $log_file, false, null, -4096 ); // Get last 4KB

if ( false === $contents ) {
    // Maybe error, or maybe file less than 4KB in size.

    $contents = file_get_contents( $log_file, false, null );

    if ( false === $contents ) {
        // Handle real error.
    }
}

＋Добавить