ob_end_clean

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

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

説明

ob_end_clean(): bool

出力用バッファの内容を消去し、出力のバッファリングをオフにします。 バッファの内容について更に何らかの処理を行いたい場合には、 バッファの内容は ob_end_clean() がコールされると 破棄されるため、ob_end_clean() の前に ob_get_contents() をコールしなければなりません。

出力バッファを開始するときに、 ob_start()PHP_OUTPUT_HANDLER_CLEANABLE および PHP_OUTPUT_HANDLER_REMOVABLE フラグを指定する必要があります。指定しなければ、ob_end_clean() は動作しません。

パラメータ

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

戻り値

成功した場合に 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_flush() - 出力バッファをフラッシュ(送信)する

関連キーワード:  出力, バッファ, 消去, バッファリング, オフ, end, クリア, 関数, 内容, 失敗