PHP: Hypertext Preprocessor (original) (raw)

stream_get_contents

(PHP 5, PHP 7, PHP 8)

stream_get_contents — Reads remainder of a stream into a string

Description

Parameters

stream (resource)

A stream resource (e.g. returned from fopen())

length (int)

The maximum bytes to read. Defaults to [null](reserved.constants.php#constant.null) (read all the remaining buffer).

offset (int)

Seek to the specified offset before reading. If this number is negative, no seeking will occur and reading will start from the current position.

Return Values

Returns a string or [false](reserved.constants.php#constant.false) on failure.

Changelog

Examples

Example #1 stream_get_contents() example

`<?phpif ($stream = fopen('http://www.example.com', 'r')) {
// print all the page starting at the offset 10
echo stream_get_contents($stream, -1, 10);fclose($stream);
}

if (

$stream = fopen('http://www.example.net', 'r')) {
// print the first 5 bytes
echo stream_get_contents($stream, 5);fclose($stream);
}?>`

Notes

Note: This function is binary-safe.

Note:

When specifying a length value other than [null](reserved.constants.php#constant.null), this function will immediately allocate an internal buffer of that size even if the actual contents are significantly shorter.

See Also

• fgets() - Gets line from file pointer
• fread() - Binary-safe file read
• fpassthru() - Output all remaining data on a file pointer