Home/ Manual/ zlib / functions/ gzwrite

gzwrite

PHP function Edit on GitHub ✎

(PHP 4, PHP 5, PHP 7, PHP 8)

Binary-safe gz-file write

Description

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

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

stream: The gz-file pointer. It must be valid, and must point to a file successfully opened by gzopen().
data: The string to write.
length: 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.

Returns the number of (uncompressed) bytes written to the given gz-file stream, Falseforfailure.

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

gzwrite() example

php

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