gzrewind()
gzrewind() — Rewind the position of 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
Sets the file position indicator of the given gz-file pointer to the beginning of the file stream.
Signature
gzrewind(resource $stream): bool
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $stream | resource | The gz-file pointer. It must be valid, and must point to a file successfully opened by gzopen(). |
Return value
Returns true on success or false on failure.
Example
The PHP manual ships no example for gzrewind(); the signature and the parameter table above are the contract.
See also
All PHP 8.5 built-in functions
Reference card built from the PHP manual page gzrewind() (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.