【PHP8.x】ob_get_clean関数の使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 出力バッファリングを利用して、動的なHTMLコンテンツを生成し、
7 * 文字列として取得するサンプル関数です。
8 *
9 * この例では、ユーザーリストからHTMLの<ul><li>リストを生成します。
10 *
11 * @param array $items リストに表示する項目の配列
12 * @return string 生成されたHTMLコンテンツ
13 */
14function createHtmlList(array $items): string
15{
16    // 出力バッファリングを開始します。
17    // これ以降の echo による出力は、直接ブラウザに送信されず、
18    // 内部のメモリバッファに蓄えられます。
19    ob_start();
20
21    // HTMLのリストをバッファに出力します。
22    echo '<h2>ユーザーリスト</h2>' . PHP_EOL;
23    echo '<ul>' . PHP_EOL;
24    foreach ($items as $item) {
25        // 安全のため、HTMLに出力する内容はエスケープします。
26        echo '    <li>' . htmlspecialchars($item, ENT_QUOTES, 'UTF-8') . '</li>' . PHP_EOL;
27    }
28    echo '</ul>' . PHP_EOL;
29
30    // ob_get_clean() は、バッファに蓄えられた内容をすべて文字列として取得し、
31    // 同時に出力バッファを空にして、バッファリングを終了します。
32    // 取得した文字列は、この関数の戻り値として返されます。
33    return ob_get_clean();
34}
35
36// 表示するユーザー名のデータ
37$users = ['Alice', 'Bob', 'Charlie'];
38
39// 関数を呼び出して、HTMLコンテンツを文字列として変数に格納します。
40// この時点では、まだ何も画面に出力されません。
41$htmlOutput = createHtmlList($users);
42
43// 別の処理を挟むことができます。
44$logMessage = 'HTMLリストを生成しました。文字数: ' . mb_strlen($htmlOutput);
45// file_put_contents('app.log', $logMessage . PHP_EOL, FILE_APPEND);
46
47// 準備が整ったら、変数に格納しておいたHTMLコンテンツをまとめて出力します。
48header('Content-Type: text/plain; charset=utf-8');
49echo "--- ここから生成されたコンテンツ ---" . PHP_EOL;
50echo $htmlOutput;
51echo "--- ここまで ---" . PHP_EOL;
52
53?>

ob_get_clean関数は、出力バッファの内容を文字列として取得し、そのバッファを削除して出力バッファリングを終了します。この関数は、ob_start関数とセットで使います。ob_startを呼び出すと、それ以降のechoなどによる出力はWebサーバーへ直接送信されず、PHPの内部メモリ（バッファ）に一時的に蓄えられます。

サンプルコードのcreateHtmlList関数では、まずob_startでバッファリングを開始します。次に、echoを使ってHTMLのリストを組み立てていますが、この時点ではまだ何も出力されません。生成されるHTMLは全てバッファに蓄積されていきます。関数の最後でob_get_cleanを呼び出すと、それまでバッファに蓄積された全てのHTMLコンテンツが、一つの文字列として取得され、関数の戻り値となります。同時に、バッファは空になり、バッファリングも終了します。

この関数に引数はありません。戻り値は、バッファの内容である文字列、またはアクティブなバッファが存在しない場合にfalseを返します。この機能により、プログラムが生成する出力を一度変数に格納し、後からファイルに保存したり、まとめて送信したりといった柔軟な処理が可能になります。