The definition should mention that the function also "turns off output buffering", not just cleans it.
(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
ob_get_clean — Obtiene el contenido del búfer de salida activo y lo desactiva
Esta función llama al gestor de salida
(con los flags PHP_OUTPUT_HANDLER_CLEAN y
PHP_OUTPUT_HANDLER_FINAL),
ignora su valor de retorno,
devuelve el contenido del búfer de salida activo
y lo desactiva.
ob_get_clean() fallará
sin un búfer de salida activo iniciado con el flag
PHP_OUTPUT_HANDLER_REMOVABLE.
ob_get_clean()
eliminará el contenido del búfer de salida activo
incluso si fue iniciado sin el flag
PHP_OUTPUT_HANDLER_CLEANABLE.
Esta función no tiene parámetros.
Devuelve el contenido del búfer de salida activo en caso de éxito
o false en caso de fallo.
ob_get_clean() devolverá false
pero no generará una E_NOTICE
si no hay un búfer de salida activo.
Si la función falla, genera una E_NOTICE.
Ejemplo #1 Ejemplo con ob_get_clean()
<?php
ob_start();
echo "¡Hola mundo!";
$out = ob_get_clean();
$out = strtolower($out);
var_dump($out);
?>El resultado del ejemplo sería:
string(18) "¡hola mundo!"
The definition should mention that the function also "turns off output buffering", not just cleans it.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 ...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();
?>