ob_get_clean()

ob_get_clean() — Get the contents of the active output buffer and turn it off.

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

This function calls the output handler (with the PHP_OUTPUT_HANDLER_CLEAN and PHP_OUTPUT_HANDLER_FINAL flags), discards it's return value, returns the contents of the active output buffer and turns off the active output buffer.

Signature

ob_get_clean(): string|false

Parameters

This function takes no parameters.

Return value

Returns the contents of the active output buffer on success or false on failure. ob_get_clean() will return false but will not generate an E_NOTICE if there is no active output buffer.

Example

A runnable snippet:

ob_start(); echo "Hello World"; $out = ob_get_clean(); $out = strtolower($out); var_dump($out);

Output:

string(11) "hello world"

See also

ob_start(), ob_get_contents(), ob_clean(), ob_end_clean(), ob_get_flush()

All PHP 8.5 built-in functions

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