gzpassthru()

gzpassthru() — Output all remaining data on a gz-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 gz-file pointer from the current position and writes the (uncompressed) results to standard output.

Signature

gzpassthru(resource $stream): int

Parameters

ParameterTypeWhat it takes
$streamresourceThe gz-file pointer. It must be valid, and must point to a file successfully opened by gzopen().

Return value

The number of uncompressed characters read from gz and passed through to the input.

Example

A runnable snippet:

$fp = gzopen('file.gz', 'r'); gzpassthru($fp); gzclose($fp);

All PHP 8.5 built-in functions

Reference card built from the PHP manual page gzpassthru() (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.