fpassthru()
fpassthru() — Output all remaining data on a file pointer.
Built-in function of PHP 8.5. The manual lists it as available in PHP 4, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.
What it does
Reads to EOF on the given file pointer from the current position and writes the results to the output buffer.
Signature
fpassthru(resource $stream): int
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $stream | resource | The file pointer must be valid, and must point to a file successfully opened by fopen() or fsockopen() (and not yet closed by fclose()). |
Return value
Returns the number of characters read from stream and passed through to the output.
Example
A runnable snippet:
// open the file in a binary mode $name = './img/ok.png'; $fp = fopen($name, 'rb'); // send the right headers header("Content-Type: image/png"); header("Content-Length: " . filesize($name)); // dump the picture and stop the script fpassthru($fp); exit;
See also
readfile(), fopen(), popen(), fsockopen()
All PHP 8.5 built-in functions
Reference card built from the PHP manual page fpassthru() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.