Source of: /manual/en/function.ob-get-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-get-clean.php',
1 => 'ob_get_clean',
),
'up' =>
array (
0 => 'ref.outcontrol.php',
1 => 'Output Control Functions',
),
'prev' =>
array (
0 => 'function.ob-flush.php',
1 => 'ob_flush',
),
'next' =>
array (
0 => 'function.ob-get-contents.php',
1 => 'ob_get_contents',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.ob-get-clean" class="refentry">
<div class="refnamediv">
<h1 class="refname">ob_get_clean</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">ob_get_clean</span> — <span class="dc-title">Get current buffer contents and delete current output buffer</span></p>
</div>
<a name="function.ob-get-clean.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>ob_get_clean</b></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Gets the current buffer contents and delete current output buffer.
</p>
<p class="para">
<b>ob_get_clean()</b> essentially executes both
<a href="function.ob-get-contents.php" class="function">ob_get_contents()</a> and
<a href="function.ob-end-clean.php" class="function">ob_end_clean()</a>.
</p>
</div>
<a name="function.ob-get-clean.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the contents of the output buffer and end output buffering.
If output buffering isn't active then <b><tt class="constant">FALSE</tt></b> is returned.
</p>
</div>
<a name="function.ob-get-clean.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 A simple <b>ob_get_clean()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />ob_start</span><span style="color: #007700">();<br /><br />echo </span><span style="color: #DD0000">"Hello World"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$out </span><span style="color: #007700">= </span><span style="color: #0000BB">ob_get_clean</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$out </span><span style="color: #007700">= </span><span style="color: #0000BB">strtolower</span><span style="color: #007700">(</span><span style="color: #0000BB">$out</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$out</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
string(11) "hello world"
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.ob-get-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-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-start.php" class="function" rel="rdfs-seeAlso">ob_start()</a> - Turn on output buffering</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
