gzwrite

Function • Params and return types changed in PHP 8.0

Binary-safe gz-file write.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

gzwrite Function synopsis

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

Parameters

$stream

The gz-file pointer. It must be valid, and must point to a file successfully opened by gzopen.

$data

Typestring

The string to write.

$length

OptionalType?intDefault valuenull

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

Typeint|false

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

Changes to the gzwrite Function

PHP 8.0

  • Return type added: int|false
  • Parameter name of parameter #1 changed: $fp to $stream
  • Parameter name of parameter #2 changed: $str to $data
  • Parameter type added for parameter #2 ($data): string
  • Parameter type added for parameter #3 ($length): ?int
  • Parameter default value added for position #3 ($length): null
  gzwrite(
-     $fp,
+     $stream,
-     $str,
+     string $data,
-     $length
+     ?int $length = null
-   )
+   ): int|false

gzwrite Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes