ob_get_clean

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

ob_get_clean — Получает содержимое активного буфера вывода и выключает его

Описание

ob_get_clean(): string|false

Функция вызывает обработчик вывода (с флагами PHP_OUTPUT_HANDLER_CLEAN и PHP_OUTPUT_HANDLER_FINAL), удаляет возвращённое им значение, возвращает содержимое активного буфера вывода и отключает активный буфер вывода.

Функция ob_get_clean() завершится неудачно, если активный буфер вывода был запущен без флага PHP_OUTPUT_HANDLER_REMOVABLE.

Функция ob_get_clean() удалит содержимое активного буфера вывода, даже если она запущена без флага PHP_OUTPUT_HANDLER_CLEANABLE.

Список параметров

У этой функции нет параметров.

Возвращаемые значения

Возвращает содержимое активного буфера вывода в случае успешного выполнения или false в случае возникновения ошибки.

Предостережение

Функция ob_get_clean() вернёт значение false, но не выдаст ошибку уровня E_NOTICE, если нет активного буфера вывода.

Ошибки

Если функция завершается неудачно, она выдаёт ошибку уровня E_NOTICE.

Примеры

Пример #1 Простой пример использования функции ob_get_clean()

<?php

ob_start();

echo "Привет мир";

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

var_dump($out);
?>

Результат выполнения приведённого примера:


string(11) "привет мир"

Смотрите также

ob_start() - Включает буферизацию вывода
ob_get_contents() - Возвращает содержимое буфера вывода
ob_clean() - Очищает (стирает) содержимое активного буфера вывода
ob_end_clean() - Очищает (стирает) содержимое активного буфера вывода и отключает его
ob_get_flush() - Сбрасывает (отправляет) возвращённое активным обработчиком вывода значение, возвращает содержимое активного буфера вывода и отключает его

add a note

User Contributed Notes 6 notes

down

geo dot artemenko at gmail dot com ¶

10 years ago


The definition should mention that the function also "turns off output buffering", not just cleans it.

down

steven at bielik dot com ¶

13 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 ...

down

paul+phpnet at earth2me dot com ¶

11 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();
?>

down

-1

sergei dot solomonov at gmail dot com ¶

12 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)

down

-4

Peter Smartt ¶

7 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().

down

-44

ludvig dot ericson at gmail dot com ¶

19 years ago


Notice that the function beneath does not catch errors, so throw in an @ before those ob_* calls

add a note