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

作成日: 2025年09月11日更新日: 2025年09月29日

ob_flush関数は、PHPの出力バッファリング機能に関連する関数です。PHPスクリプトは通常、echoなどで生成された出力を、すぐにウェブブラウザなどのクライアントに送らず、一時的なメモリ領域である「出力バッファ」に溜め込みます。このバッファリングは、通常ob_start()関数で開始されます。

ob_flush関数は、現在の出力バッファに溜まっている内容を、その一つ外側のバッファ、または最終的な出力先（クライアント）へと送る役割を果たします。しかし、この関数が呼び出されても、現在の出力バッファリング自体は終了しません。バッファはクリアされ、引き続き新しい出力が溜め込まれます。

この機能により、時間のかかる処理の途中で部分的な出力を段階的にクライアントに送信することが可能になります。例えば、処理の進捗状況をリアルタイムでユーザーに表示したい場合や、大きなデータセットを少しずつ転送して体感的な応答性を向上させたい場合などに利用されます。ob_flush関数を効果的に使用するためには、事前にob_start()関数で出力バッファリングが有効になっている必要があります。これにより、プログラムの柔軟な出力制御が可能になります。

基本的な使い方

構文(syntax)

<?php
ob_start();
echo "Hello, world!";
ob_flush();
?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP ob_flush() の挙動と flush() での表示

<?php

/**
 * PHPの出力バッファリングと ob_flush, flush 関数の連携をデモンストレーションします。
 * ob_flush() 単体ではブラウザに即座に出力されない（"not working"と感じる）理由を理解し、
 * flush() と組み合わせて利用する方法を示します。
 *
 * このスクリプトをWebサーバー経由で実行し、ブラウザで挙動を確認してください。
 * 数秒ごとに内容が順次表示されるはずです。
 */
function demonstrateObFlushBehavior(): void
{
    // 出力バッファリングを開始します。
    // これ以降の echo 等の出力は、直接クライアント（ブラウザ）には送られず、
    // PHPの内部バッファに一時的に保持されます。
    ob_start();

    echo "<h1>PHP 出力バッファリングのデモンストレーション</h1>\n";
    echo "<p>これは最初のメッセージです。</p>\n";
    echo "<p>ob_flush() を呼び出します...</p>\n";

    // ob_flush() は、現在の出力バッファの内容をPHPの内部出力メカニズムに転送します。
    // しかし、この時点ではWebサーバーやブラウザのバッファリングにより、
    // まだクライアント（ブラウザ）にはデータが送信されないことがほとんどです。
    ob_flush();
    // HTMLコメントとして、この時点での状況を説明します。
    echo "<!-- ob_flush() は実行されましたが、まだブラウザには何も表示されないはずです。 -->\n";

    // 処理を一時停止し、時間差がどのように見えるかを確認しやすくします。
    sleep(2);

    echo "<p>flush() を呼び出します...</p>\n";
    // flush() は、PHPの内部出力メカニズムに転送された内容を、
    // 実際にクライアント（ブラウザ）へ送信するよう指示します。
    // ここで初めて、ob_flush() で転送された内容がブラウザに表示される可能性が高まります。
    flush();
    echo "<!-- flush() が実行され、最初のメッセージがブラウザに表示されたはずです。 -->\n";

    // さらに処理を一時停止します。
    sleep(2);

    echo "<p>これは2番目のメッセージです。</p>\n";
    echo "<p>再度 ob_flush() を呼び出します...</p>\n";
    ob_flush();
    echo "<!-- 再度 ob_flush() は実行されましたが、まだブラウザには何も表示されないはずです。 -->\n";

    sleep(2);

    echo "<p>再度 flush() を呼び出します...</p>\n";
    flush();
    echo "<!-- 再度 flush() が実行され、2番目のメッセージがブラウザに表示されたはずです。 -->\n";

    // 出力バッファリングを終了します。
    // ob_end_flush() は、残りのバッファ内容があればそれを転送し、バッファを閉じます。
    // （この例では、すでに flush() されているため、残りの内容はほとんどないはずです。）
    ob_end_flush();

    echo "<p>全ての処理が完了しました。</p>\n";
}

// デモンストレーション関数を実行します。
demonstrateObFlushBehavior();

?>

PHPのob_flush関数は、PHPの出力バッファリングを制御する機能の一つです。この関数は、現在アクティブな出力バッファに蓄積された内容を、PHPの内部出力メカニズムへと転送します。引数はなく、戻り値もありません。

多くのWebサーバーやブラウザは、PHPから送られてきたデータをさらに内部でバッファリングするため、ob_flush()を実行しただけでは、その内容がすぐにブラウザに表示されないことがよくあります。これが「ob_flush()が機能しない」と感じられる主な理由です。

ob_flush()でPHPの内部メカニズムに転送された内容を、実際にクライアント（ブラウザ）へ送信させたい場合は、flush()関数と組み合わせて使用します。flush()は、PHPの内部出力メカニズムに転送された内容を、OSやWebサーバーを通じてブラウザに送信するよう指示する役割を担います。このように、ob_flush()とflush()を組み合わせることで、長い処理の途中でも段階的に情報をユーザーに表示することが可能になります。

ob_flush()は、PHPの出力バッファにある内容を、その次の層のバッファ（Webサーバーなど）に転送するだけの機能です。そのため、ob_flush()を呼び出しただけでは、ブラウザに即座に表示されないことが多く、「ob_flushが動かない」と誤解しやすい点に注意が必要です。ブラウザに内容を表示させるには、通常flush()関数も組み合わせて使用し、Webサーバーなどのバッファも解放するよう指示する必要があります。この二段階の出力メカニズムを理解することが重要です。ただし、Webサーバーやプロキシ、あるいはブラウザ自体のバッファリング設定によっては、flush()を呼び出しても即座に表示されない場合があることも覚えておいてください。出力バッファリングは必ずob_start()で開始し、処理の最後にはob_end_flush()などで終了させるようにしてください。