php8.5
Home/ Manual/ outcontrol / functions/ ob_end_clean

ob_end_clean

PHP function Edit on GitHub ✎

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

Clean (erase) the contents of the active output buffer and turn it off

Description

ob_end_clean(): bool

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

ob_end_clean() will fail without an active output buffer started with the PHP_OUTPUT_HANDLER_REMOVABLE flag.

ob_end_clean() will discard the contents of the active output buffer even if it was started without the PHP_OUTPUT_HANDLER_CLEANABLE flag.

Parameters Parameters

Return Values

Success

Errors/Exceptions

If the function fails it generates an E_NOTICE.

Examples

The following example shows an easy way to get rid of the contents of the active output buffer:

ob_end_clean() example

php
<?php
ob_start();
echo 'Text that won\'t get displayed.';
ob_end_clean();
?>

See Also

Source: reference/outcontrol/functions/ob-end-clean.xml · from the official PHP manual (php/doc-en)