gzwrite()

gzwrite() — Binary-safe gz-file write.

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

gzwrite() writes the contents of data to the given gz-file.

Signature

gzwrite(resource $stream, string $data, ?int $length = null): int|false

Parameters

ParameterTypeWhat it takes
$streamresourceThe gz-file pointer. It must be valid, and must point to a file successfully opened by gzopen().
$datastringThe string to write.
$length?intThe number of uncompressed bytes to write. If supplied, writing will stop after length (uncompressed) bytes have been written or the end of data is reached, whichever comes first.

Return value

Returns the number of (uncompressed) bytes written to the given gz-file stream, or false on failure.

Example

A runnable snippet:

$string = 'Some information to compress'; $gz = gzopen('somefile.gz','w9'); gzwrite($gz, $string); gzclose($gz);

Changelog

VersionChange
8.0.0length is nullable now; previously, the default was 0.
7.4.0This functions returns false on failure now; previously 0 was returned.

See also

gzread(), gzopen()

All PHP 8.5 built-in functions

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