- Document return value and the linked version note. (Bug #24346)

#- The callback stuff should still be documented, so I'm not closing the bug
#  yet


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@133485 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Derick Rethans 2003-06-28 07:24:36 +00:00
parent 32c5c5832a
commit b72c4ddeaa

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/outcontrol.xml, last change in rev 1.1 -->
<refentry id="function.ob-start">
<refnamediv>
@ -9,7 +9,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>ob_start</methodname>
<type>bool</type><methodname>ob_start</methodname>
<methodparam choice="opt"><type>callback</type><parameter>
output_callback
</parameter></methodparam>
@ -36,7 +36,8 @@
<parameter>output_callback</parameter> is called, it will receive
the contents of the output buffer as its parameter and is
expected to return a new output buffer as a result, which will be
sent to the browser.
sent to the browser. If the <parameter>output_callback</parameter> is not
a callable function, thos function will return &false;.
</para>
<note>
<para>
@ -47,6 +48,12 @@
and will return it's output accordingly.
</para>
</note>
<note>
<para>
Before PHP 4.3.2 this function did not return &false; in case the passed
<parameter>output_callback</parameter> can not be executed.
</para>
</note>
<para>
Output buffers are stackable, that is, you may call
<function>ob_start</function> while another