<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Clean (erase) the output buffer and turn off output buffering</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ob-clean.html">ob_clean</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ob-end-flush.html">ob_end_flush</a></div>
<div class="up"><a href="ref.outcontrol.html">Output Control Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ob-end-clean" class="refentry">
<div class="refnamediv">
<h1 class="refname">ob_end_clean</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ob_end_clean</span> — <span class="dc-title">Clean (erase) the output buffer and turn off output buffering</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ob-end-clean-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ob_end_clean</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
This function discards the contents of the topmost output buffer and turns
off this output buffering. If you want to further process the buffer's
contents you have to call <span class="function"><a href="function.ob-get-contents.html" class="function">ob_get_contents()</a></span> before
<span class="function"><strong>ob_end_clean()</strong></span> as the buffer contents are discarded
when <span class="function"><strong>ob_end_clean()</strong></span> is called.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ob-end-clean-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. Reasons for failure are first that you called the
function without an active buffer or that for some reason a buffer could
not be deleted (possible for special buffer).
</p>
</div>
<div class="refsect1 errors" id="refsect1-function.ob-end-clean-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
If the function fails it generates an <strong><code>E_NOTICE</code></strong>.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.ob-end-clean-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>4.2.0</td>
<td>
The boolean return value was added.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ob-end-clean-examples">
<h3 class="title">Examples</h3>
<p class="para">
The following example shows an easy way to get rid of all output buffers:
</p>
<p class="para">
<div class="example" id="example-465">
<p><strong>Example #1 <span class="function"><strong>ob_end_clean()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />ob_start</span><span style="color: #007700">();<br />echo </span><span style="color: #DD0000">'Text that won\'t get displayed.'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">ob_end_clean</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ob-end-clean-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ob-start.html" class="function" rel="rdfs-seeAlso">ob_start()</a> - Turn on output buffering</span></li>
<li class="member"> <span class="function"><a href="function.ob-get-contents.html" class="function" rel="rdfs-seeAlso">ob_get_contents()</a> - Return the contents of the output buffer</span></li>
<li class="member"> <span class="function"><a href="function.ob-flush.html" class="function" rel="rdfs-seeAlso">ob_flush()</a> - Flush (send) the output buffer</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ob-clean.html">ob_clean</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ob-end-flush.html">ob_end_flush</a></div>
<div class="up"><a href="ref.outcontrol.html">Output Control Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
