ob_clean()

ob_clean() — Clean (erase) the contents of the active output buffer.

Built-in function of PHP 8.5. The manual lists it as available in PHP 4 >= 4.2.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 flag), discards it's return value and cleans (erases) the contents of the active output buffer.

Signature

ob_clean(): bool

Parameters

This function takes no parameters.

Return value

Returns true on success or false on failure.

Example

The PHP manual ships no example for ob_clean(); the signature and the parameter table above are the contract.

See also

ob_start(), ob_get_contents(), ob_end_clean(), ob_get_clean(), ob_flush()

All PHP 8.5 built-in functions

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