無料CGI、PHPサイト(確認画面付きメールフォーム・メーリングリスト・メルマガ設置、逆アクセスランキング、画像カウンター等)PHPマニュアル by k-sky

ob_end_clean

(PHP 4, PHP 5)

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

説明

bool ob_end_clean ( void )

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

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。 失敗する原因は、まず、アクティブなバッファ以外に対して この関数をコールしたか、あるいは何らかの理由により バッファを消去することができなかった場合です(特殊なバッファ等)。

エラー / 例外

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

変更履歴

バージョン 説明
4.2.0 boolean 型の戻り値が追加されました。

以下は全ての出力バッファを消去する簡単な方法の例です。

例1 ob_end_clean() の例

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