gzputs()

gzputs() — Alias of gzwrite().

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.

gzputs() is an alias of gzwrite(): same parameters, same return value.

Signature

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

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().
$data	string	The string to write.
$length	?int	The 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);

All PHP 8.5 built-in functions

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