PHP: Hypertext Preprocessor (original) (raw)

ob_end_clean

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

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

Parameters

This function has no parameters.

Return Values

Returns [true](reserved.constants.php#constant.true) on success or [false](reserved.constants.php#constant.false) on failure.

Errors/Exceptions

If the function fails it generates an [E_NOTICE](errorfunc.constants.php#constant.e-notice).

Examples

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

Example #1 ob_end_clean() example

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

See Also

Found A Problem?

Sam Yong - hellclanner at live dot com

14 years ago

`Take note that if you change zlib output compression setting in between ob_start and ob_end_clean or ob_end_flush, you will get an error: ob_end_flush() failed to delete buffer zlib output compression

Example:

ob_end_clean(); in this example will throw the error.

`

John Smith

20 years ago

`Note that if you started called ob_start with a callback, that callback will still be called even if you discard the OB with ob_end_clean.

Because there is no way of removing the callback from the OB once you've set it, the only way to stop the callback function from having any effect is to do something like:

`