PHPのob_startでまとめて結果出力!シンプル解説で最短理解

2024年3月1日

つぶらや

こんにちは！独学プログラマー＆ライターのつぶらやです。

ob_startというPHPの関数があります。

公式サイトの説明によると、

【出力のバッファリングを有効にする】とありますが、何の事でしょうか。

バッファリングとは、バッファという場所にデータをためておくことです。

ob_startは、計算した結果をすぐに表示せずに、一旦別の場所に置いておこうという関数なのです。

本日はこのob_startについて、以下の内容でお話したいと思います。

【基本】結果をすぐ出力しない時って？
【実践編】ob_startでまとめて出力
【応用編】ob_startで同じ処理をまとめる

【基本】結果をすぐ出力しない時って？

プログラム内では様々なデータを取得して整形したり、計算したりします。

そのデータを画面などに出力する場合に、echo等を使用してPHPファイル内に記述します。

echoを記述すると、その時点で出力は実行されてしまいます。

でも、すぐに出したくない場合もあると思います。

まとめて出したい時

例えば以下のように、データとhtmlのタグを別の関数で取得処理している場合などがあります。

summarize.php
<?php
function getTitle(){ // タイトルデータ取得の関数
    return "<h2>侍エンジニア</h2>"; 
}

function getNote(){ // 文言データ取得の関数
    return "<p>未経験からエンジニアに！</p>";
}
function makeHtml(){ // htmlの整形関数
    $data = "";
    $data .= '<div class="samurai_title">';
    $data .= getTitle(); // タイトルデータ取得の関数呼び出し
    $data .= getNote(); // 文言データ取得の関数呼び出し
    $data .= '</div>';

    return $data;
}

$html_code = makeHtml();

echo $html_code;
?>

[su_spacer size=”20″]

結果
侍エンジニア
未経験からエンジニアに！

[su_spacer size=”20″]

<?php ?> で囲まない部分はそのまま画面に表示されてしまうので、変数にタグも入れていく必要があります。

また、コードが読みにくいですので、htmlタグとデータ取得は分けて書かれているといいですよね。

同じ処理をまとめたい時

プログラムを書く上で、同じ処理を何度も繰り返すのはよくありません。

same.php
<div class="disp_html">
    <?php include("disp_html.php"); ?>
</div>

<div class="disp_html">
    <?php include("disp_html.php"); ?>
</div>

[su_spacer size=”20″]

上記の例では、disp_html.phpを二度呼び出してしまっています。

呼び出した結果をどこかに保存しておいて呼び出せる方が良いです。
[su_spacer size=”20″]
それでは問題点を解決するために、次章からob_startを使う方法を説明していきます。

【実践編】ob_startで同じ処理をまとめる

それでは実践編です。

前章で例に出したsummarize.phpを元にして、ob_startを使ってまとめて出力してみましょう。

ob_start_summarize.php
<?php
function getTitle(){ // タイトルデータ取得の関数
    return "<h2>侍エンジニア</h2>"; 
}

function getNote(){ // 文言データ取得の関数
    return "<p>未経験からエンジニアに！</p>";
}

function makeHtml(){
    ob_start(); // 記録開始
    ?>

    <div class="samurai_title">
        <?php echo getTitle(); ?>
        <?php echo getNote(); ?>
    </div>

    <?php
    $data = ob_get_contents(); // 記録結果を変数に代入
    ob_end_clean(); // 記録終了

    return $data;
}

$html_code = makeHtml();

echo $html_code;
?>

[su_spacer size=”20″]

結果
侍エンジニア
未経験からエンジニアに！

[su_spacer size=”20″]

結果は、summarize.phpと変わりませんが、htmlタグは変数にいれずそのまま記述出来たので、コードがすっきりしました。

ob_start();

[su_spacer size=”20″]
から、

ob_end_clean();

[su_spacer size=”20″]
までの間は、画面やコンソールに表示はされません。

$data = ob_get_contents();

[su_spacer size=”20″]
$dataの中にはhtmlのタグも、関数で取得したデータもすべて入っています。

画面に表示されるものが、画面に表示されずに別の場所(バッファ領域)に保存されているのです。

【応用編】ob_startの色々な使い方

ob_startの使い方は大体お分かりいただけたでしょうか。

では、前章で例に出したsame.phpを元にして、ob_startを使ってまとめて出力してみましょう

ob_start_same.php
<?php
    ob_start();
    include("disp_html.php");
    $disp_html = ob_get_contents();
    ob_end_clean();
?>

<div class="disp_html">
    <?php echo $disp_html; ?>
</div>

<div class="disp_html">
    <?php echo $disp_html; ?>
</div>

[su_spacer size=”20″]

修正前のコードでは