ob_gzhandler()

ob_gzhandler() — ob_start callback function to gzip output buffer.

Built-in function of PHP 8.5. The manual lists it as available in PHP 4 >= 4.0.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

ob_gzhandler() is intended to be used as a callback function for ob_start() to help facilitate sending gz-encoded data to web browsers that support compressed web pages. Before ob_gzhandler() actually sends compressed data, it determines what type of content encoding the browser will accept ("gzip", "deflate" or none at all) and will return its output accordingly. All browsers are supported since it's up to the browser to send the correct header saying that it accepts compressed web pages. If a browser doesn't support compressed pages this function returns false.

Signature

ob_gzhandler(string $data, int $flags): string|false

Parameters

Return value

See the PHP manual for the return value.

Example

A runnable snippet:

ob_start("ob_gzhandler"); ?> <html> <body> <p>This should be a compressed page.</p> </body> </html>

See also

ob_start(), ob_end_flush()

All PHP 8.5 built-in functions

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