Source of: /manual/en/function.ob-end-clean.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.outcontrol.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.ob-end-clean.php',
1 => 'ob_end_clean',
),
'up' =>
array (
0 => 'ref.outcontrol.php',
1 => 'Output Control Functions',
),
'prev' =>
array (
0 => 'function.ob-clean.php',
1 => 'ob_clean',
),
'next' =>
array (
0 => 'function.ob-end-flush.php',
1 => 'ob_end_flush',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<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>
<a name="function.ob-end-clean.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>ob_end_clean</b></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 <a href="function.ob-get-contents.php" class="function">ob_get_contents()</a> before
<b>ob_end_clean()</b> as the buffer contents are discarded
when <b>ob_end_clean()</b> is called.
</p>
</div>
<a name="function.ob-end-clean.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> 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>
<a name="function.ob-end-clean.errors"></a><div class="refsect1 errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
If the function fails it generates an <b><tt class="constant">E_NOTICE</tt></b>.
</p>
</div>
<a name="function.ob-end-clean.changelog"></a><div class="refsect1 changelog">
<h3 class="title">Changelog</h3>
<p class="para">
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">4.2.0</td>
<td align="left">
The boolean return value was added.
</td>
</tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.ob-end-clean.examples"></a><div class="refsect1 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">
</p><div class="example">
<p><b>Example #1 <b>ob_end_clean()</b> example</b></p>
<div class="example-contents programlisting">
<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>
</p>
</div>
<a name="function.ob-end-clean.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.ob-start.php" class="function" rel="rdfs-seeAlso">ob_start()</a> - Turn on output buffering</li>
<li class="member"><a href="function.ob-get-contents.php" class="function" rel="rdfs-seeAlso">ob_get_contents()</a> - Return the contents of the output buffer</li>
<li class="member"><a href="function.ob-flush.php" class="function" rel="rdfs-seeAlso">ob_flush()</a> - Flush (send) the output buffer</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
