ob_clean

Clean (erase) the contents of the active output buffer

Description

bool ob_clean()

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.

This function does not turn off the active output buffer like ob_end_clean or ob_get_clean does.

ob_clean will fail without an active output buffer started with the PHP_OUTPUT_HANDLER_CLEANABLE flag.

Parameters

This function has no parameters.

Return Values

Returns true on success or false on failure.

Errors/Exceptions

If the function fails it generates an E_NOTICE.

See Also

  • ob_start
  • ob_get_contents
  • ob_end_clean
  • ob_get_clean
  • ob_flush