file_get_contents

(PHP 4 >= 4.3.0, PHP 5)

file_get_contents — Reads entire file into a string

說明

string file_get_contents ( string $filename [, bool $use_include_path = false [, resource $context [, int $offset = -1 [, int $maxlen ]]]] )

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.

Note:
If you're opening a URI with special characters, such as spaces, you need to encode the URI with urlencode().

參數

filename

Name of the file to read.

use_include_path

Note:
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.

回傳值

The function returns the read data 或者在失敗時回傳 FALSE.

Warning

本函式可能回傳布林值 FALSE，但也可能回傳一個與 FALSE 等值的非布林值，例如 0 或者 ""。請參閱布林類型章節以獲取更多訊息。應使用 === 運算符來測試本函式的回傳值。

錯誤/例外

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.

範例

Example #1 Get and output the source of the homepage of a website


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

Example #2 Searching within the include_path


<?php
// <= PHP 5
$file = file_get_contents('./people.txt', true);
// > PHP 5
$file = file_get_contents('./people.txt', FILE_USE_INCLUDE_PATH);
?>

Example #3 Reading a section of a file


<?php
// Read 14 characters starting from the 21st character
$section = file_get_contents('./people.txt', NULL, NULL, 20, 14);
var_dump($section);
?>

上例的輸出類似於：

string(14) "lle Bjori Ro"

Example #4 Using stream contexts


<?php
// Create a stream
$opts = array(
  'http'=>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);
?>

更新日誌

版本	說明
5.1.0	Added the `offset` and `maxlen` parameters.

註釋

Note: 本函式可安全用於二進位對象。

Tip

如果「fopen wrappers」已經被啟用，則在本函式中可以把 URL 作為檔案名來使用。請參閱 fopen() 函式來獲取如何指定文件名的詳情以及支援 URL 協定列表：Supported Protocols and Wrappers。

Warning

使用 SSL 時，Microsoft IIS 會違反協議不發送close_notify標記就關閉連線。PHP 會在到資料尾端時報告“SSL: Fatal Protocol Error”。要解決此問題，error_reporting 應設定為將機級別至不包含警告。 PHP 4.3.7 及更高版本可以在使用 https:// 包裝器打該串流時檢測出有問題的 IIS 伺服器軟體並抑制警告。在使用 fsockopen() 建立 ssl:// 端口時, 開發者需檢測並抑制此警告。

參見

file() - Reads entire file into an array
fgets() - Gets line from file pointer
fread() - Binary-safe file read
readfile() - Outputs a file
file_put_contents() - Write a string to a file
stream_get_contents() - Reads remainder of a stream into a string
stream_context_create() - Creates a stream context
$http_response_header

add a note

User Contributed Notes 2 notes

down

Bart Friederichs ¶

12 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

-1

allenmccabe at gmail dot com ¶

2 years ago


I'm not sure why @jlh was downvoted, but I verified what he reported.

>>> file_get_contents($path false, null, 5, null)
=> ""
>>> file_get_contents($path, false, null, 5, 5)
=> "r/bin"

add a note