ob_end_clean

(PHP 4, PHP 5, PHP 7, PHP 8)

ob_end_cleanアクティブな出力用バッファをクリア(消去)し、出力のバッファリングをオフにする

説明

ob_end_clean(): bool

この関数は、 (PHP_OUTPUT_HANDLER_CLEANPHP_OUTPUT_HANDLER_FINAL フラグを指定して) 出力ハンドラをコールし、その戻り値を破棄するとともに、 アクティブな出力バッファの内容をクリア(消去)し、 かつそれをオフにします。

PHP_OUTPUT_HANDLER_REMOVABLE を指定して アクティブな出力バッファを開始しないと、 ob_clean() は失敗します。

ob_end_clean() は、PHP_OUTPUT_HANDLER_CLEANABLE を指定せずにアクティブな出力バッファを開始したとしても、 そのバッファの内容をクリアします。

パラメータ

この関数にはパラメータはありません。

戻り値

成功した場合に true を、失敗した場合に false を返します。

エラー / 例外

この関数は失敗すると E_NOTICE レベルのエラーを発行します。

以下は、アクティブな全ての出力バッファの内容を消去する簡単な方法の例です。

例1 ob_end_clean() の例

<?php
ob_start
();
echo
'Text that won\'t get displayed.';
ob_end_clean();
?>

参考

  • ob_start() - 出力のバッファリングを有効にする
  • ob_get_contents() - 出力用バッファの内容を返す
  • ob_clean() - アクティブな出力バッファの内容をクリア(消去)する
  • ob_get_clean() - アクティブな出力バッファの内容を取得し、そのバッファをオフにする
  • ob_end_flush() - アクティブな出力用バッファをフラッシュ(送信)し、アクティブな出力バッファをオフにする
To Top