PHPCon Poland 2024


(PHP 5, PHP 7, PHP 8)



stream_get_contents(resource $stream, ?int $length = null, int $offset = -1): string|false

file_get_contents() と似ていますが、 stream_get_contents() は既にオープンしている ストリームリソースに対して操作を行います。そして、指定した offset から始まる最大 length バイトのデータを取得して文字列に 保存します。


stream (resource)

ストリームリソース(例: fopen() の返す値)。

length (int)

読み込む最大バイト数。デフォルトは null (バッファの残りのデータをすべて読み込む)。

offset (int)

読み込みを開始する前に移動する位置。負の数を指定した場合は移動が発生せず、 現在位置から読み込みを開始します。


文字列を返します。失敗した場合に false を返します。


バージョン 説明
8.0.0 length は、nullable になりました。

例1 stream_get_contents() の例


if ($stream = fopen('', 'r')) {
// オフセット 10 から開始して、残りのすべてのページを表示します
echo stream_get_contents($stream, -1, 10);


if (
$stream = fopen('', 'r')) {
// 最初の 5 バイトを表示します
echo stream_get_contents($stream, 5);




注意: この関数はバイナリデータに対応しています。


length の値に null 以外を指定した場合、 この関数はすぐにその指定したサイズの内部バッファを確保します。 たとえ、実際に扱うコンテンツが十分小さかったとしても同じです。


  • fgets() - ファイルポインタから 1 行取得する
  • fread() - バイナリセーフなファイルの読み込み
  • fpassthru() - ファイルポインタ上に残っているすべてのデータを出力する

add a note

User Contributed Notes 4 notes

vasiliy at hotger dot com
12 years ago
It is important to know that stream_get_contents behaves differently with different versions of PHP. Consider the following


= fopen('file', 'w+'); // truncate + attempt to create
fwrite($handle, '12345'); // file position > 0
rewind($handle); // position = 0
$content = stream_get_contents($handle); // file position = 0 in PHP 5.1.6, file position > 0 in PHP 5.2.17!
fwrite($handle, '6789');

* 'file' content
* PHP 5.1.6:
* 67895
* PHP 5.2.17:
* 123456789

As a result, stream_get_contents() affects file position in 5.1, and do not affect file position in 5.2 or better.
clarck dot smith at gmail dot com
12 years ago
In that case when stream_get_contents/fread/fgets or other stream reading functions block indefinitely your script because they don't reached the limit of bytes to read use the socket_get_meta_data function to figure out the number of the bytes to read. It returns an array that contains a key named 'unread_bytes' and then pass that number to your favourite stream reading functions second parameter to read from the stream.

Maybe a good workaround to use the stream_select function, and set the socket to non-blocking mode with the use of stream_set_blocking($stream, 0). In this case the socket reading functions work properly.

Cheers, Ervin
m rahman
13 years ago
When omitting the parameter $maxlength, any received bytes are stacked up until the underlying stream is not readable anymore, the the function returns that stack in one piece.
fearpro13 at gmail dot com
6 months ago
It states that $length parameter which value is null is intended to read all remaining contents from $stream
However, example listed under docs uses -1 as $length parameter to achieve such behavior

Recently i had to start few commands from php7.4 and read content from them, proc_open was used to create processes.
Both output[1] and error[2] pipes were set to non-blocking mode. For some unknown reason sometimes process error[2] channel was available, sometimes not(it was empty string).

After some investigation it was found that stream_get_contents works just great with -1 as a $length value instead of null if you are trying to get all remaining buffer.
To Top