php-doc-en/reference/outcontrol/functions/ob-clean.xml
2021-06-09 12:10:39 +03:00

73 lines
1.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ob-clean" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ob_clean</refname>
<refpurpose>Clean (erase) the output buffer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ob_clean</methodname>
<void/>
</methodsynopsis>
<para>
This function discards the contents of the output buffer.
</para>
<para>
This function does not destroy the output buffer like
<function>ob_end_clean</function> does.
</para>
<para>
The output buffer must be started by
<function>ob_start</function> with <link
linkend="constant.php-output-handler-cleanable">PHP_OUTPUT_HANDLER_CLEANABLE</link>
flag. Otherwise <function>ob_clean</function> will not work.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ob_flush</function></member>
<member><function>ob_end_flush</function></member>
<member><function>ob_end_clean</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->