PHP 8.3.0 RC 6 available for testing

ob_get_clean

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

ob_get_clean得到当前缓冲区的内容并删除当前输出缓冲区

说明

ob_get_clean(): string|false

得到当前缓冲区的内容并删除当前输出缓冲区。

ob_get_clean() 实质上是一起执行了 ob_get_contents()ob_end_clean()

输出缓冲区必须由带有 PHP_OUTPUT_HANDLER_CLEANABLEPHP_OUTPUT_HANDLER_REMOVABLE flag 的 ob_start() 启动。否则 ob_get_clean() 将不起作用。

参数

此函数没有参数。

返回值

返回输出缓冲区的内容,并结束输出缓冲区。如果输出缓冲区不是活跃的,即返回 false

示例

示例 #1 ob_get_clean() 的简单示例

<?php

ob_start
();

echo
"Hello World";

$out = ob_get_clean();
$out = strtolower($out);

var_dump($out);
?>

以上示例会输出:

 

string(11) "hello world"

参见

add a note

User Contributed Notes 6 notes

up
68
geo dot artemenko at gmail dot com
9 years ago
The definition should mention that the function also "turns off output buffering", not just cleans it.
up
26
steven at bielik dot com
12 years ago
Also, don't forget that you will need to ob_start() again for any successive calls:

<?php
ob_start
();
echo
"1";
$content = ob_get_clean();

ob_start(); // This is NECESSARY for the next ob_get_clean() to work as intended.
echo "2";
$content .= ob_get_clean();

echo
$content;
?>

Output: 12

Without the second ob_start(), the output is 21 ...
up
7
paul+phpnet at earth2me dot com
10 years ago
Keep in mind that output may be buffered by default, depending on how you are running PHP (CGI, CLI, etc.). You can use ob_get_level() to determine if an output buffer has already been started. On most web servers I've used, output buffering is already one level deep before my scripts start running.

You should only end as many output buffers as you start. Assuming that your buffer is always the first buffer, or otherwise closing pre-existing buffers, could lead to problems. In PHP 5.5, you can ensure that output buffers are ended properly using a try-finally block.

Something like this is almost guaranteed to break stuff:

<?php
// Don't ever do this!
while (ob_get_level() > 1)
{
ob_end_flush();
}

$content = ob_get_clean();
?>

The problem is that number, "1". Using a fixed number there is asking for trouble. Instead, use ob_get_level() to get the number of output buffers applied when your code starts, and return to that number, if you really must use an unknown number of output buffers:

<?php
ob_start
();
$saved_ob_level = ob_get_level();

// Do stuff here:
run_something();

// If you really must close all of your output buffers except one, this'll do it:
while (ob_get_level() > $start_ob_level)
{
ob_end_flush();
}

// And now, the final output buffer that belongs to us:
$content = ob_get_clean();
?>
up
0
sergei dot solomonov at gmail dot com
11 years ago
<?php
ob_start
();
echo
"1";
$content = ob_get_clean();

echo
"2";
$content .= ob_get_clean();

echo
$content;
?>

This script outputs 21 in CLI mode and 12 otherwise (under my apache and nginx)
up
-3
Peter Smartt
6 years ago
I was trying to debug my code using error_log() and I discovered that ob_get_clean() also truncates the error_log() buffer right in the middle of its output, and well as the output buffer which it is supposed to truncate. If you are using error_log(), use ob_get_contents() and ob_end_clean() instead of ob_get_clean().
up
-42
ludvig dot ericson at gmail dot com
18 years ago
Notice that the function beneath does not catch errors, so throw in an @ before those ob_* calls
To Top