Overview
KB
Technical FAQ
PHP Manual
CSS2 Manual
HTML Manual
JS Guide
JS Reference
PhpDock Manual
Nu-Coder Manual
PhpExpress Manual
PHP Joomla
Development
Learn PHP
 
<ob_gzhandlerzlib_decode>
^Zlib FunctionsLast updated: Mon, 26 Oct 2026

readgzfile

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

readgzfile — Output a gz-file

Description

function readgzfile(string $filename, bool $use_include_path = false): int|false

Reads a file, decompresses it and writes it to standard output.

readgzfile() can be used to read a file which is not in gzip format; in this case readgzfile() will directly read from the file without decompression.

Parameters

filename

The file name. This file will be opened from the filesystem and its contents written to standard output.

use_include_path

When set to true the include_path will be used to determine which file to open.

Return Values

Returns the number of (uncompressed) bytes read from the file on success, or false on failure

Errors/Exceptions

Upon failure, an E_WARNING is emitted.

Changelog

Version Description
8.5.0 use_include_path is now of type bool. Previously, it was of type int.

See Also


<ob_gzhandlerzlib_decode>
^Zlib FunctionsLast updated: Mon, 26 Oct 2026