ob_start、ob_get_contents関数でPHPの標準出力をバッファリング・変数に代入

2015/08/04 2017/05/23

標準出力をバッファリングする関数 ob_start()

バッファリング関数 ob_start()とは？

　
PHPの出力関数である echoを実行すると、記述してあるそのタイミングで HTMLに標準出力します。
　
echo "出力";
　
HTMLのソースの中に、PHPの記述を書くと、その書いてあるところで処理され、それが「echo」「print_r()」などの標準出力（表示）する関数であればそのまま HTMLに出力されます。
　

<!DOCTYPE html>
<html lang="ja">
<head>
　：
</head>
<body>
　：
<div id="contents">
<?php echo "出力"; ?>
</div>
　：
</body>
</html>

<!DOCTYPE html>

<head>

　：

</head>

<body>

　：

<?php echo "出力"; ?>

</div>

　：

</body>

</html>

　
上記のような HTMLの場合は、9行目の echoは、9行目の箇所に出力されますが、記述された場所でそのまま出力されることが標準出力ということになります。
　
　
今回紹介する「ob_start()関数」は、この標準出力を出力せずにバッファリングする機能を提供してくれる関数です。
バッファリングした値を「ob_get_contents()関数」を使って変数に代入したり、「ob_end_flush()関数」を使って出力することができます。
また、「ob_start()関数」を使ってバッファリングを開始を宣言したら、「ob_end_clean()関数」を使って終了を宣言する必要があります。
　
　

ob_start()関数の使い方・基本編

echo "1";
ob_start();    // バッファリング開始
echo "2";
$buffer = ob_get_contents();    // 変数に代入
echo "3";
$buffer2 = ob_get_contents();    // 変数に代入
echo "4";
ob_end_clean();    // バッファリング終了
echo "5";
echo $buffer;
echo $buffer2;

echo "1";

ob_start(); // バッファリング開始

echo "2";

$buffer = ob_get_contents(); // 変数に代入

echo "3";

$buffer2 = ob_get_contents(); // 変数に代入

echo "4";

ob_end_clean(); // バッファリング終了

echo "5";

echo $buffer;

echo $buffer2;

　
上記のプログラムを実行すると、結果は「15223」となります。
　
最初の「echo」で「1」が出力された後は、「ob_start();」～「ob_end_clean();」の間はバッファリングされるために出力されません。
そして、「5」が出力された後、「ob_get_contents();」で変数「$buffer」「$buffer2」に代入された「2」「23」がそれぞれ出力されます。
　
変数に代入する「ob_get_contents();」を使うことでバッファリングした内容を任意のタイミングで出力することができるようになります。
また、変数に代入しますので、その値を置換したりやさらに値に代入したりすることも可能になります。
　
　

初めてのPHP

ob_start()関数の使い方・応用編

　
応用編として、外部ファイルを読み込む処理について考えます。
　
PHPの処理が記述された HTML＋PHPのファイル「setting.html.php」というファイルがあったとして、これを読み込む場合は、下記のように include()関数で読み込みます。
（「include_once()関数」「require()関数」などでも OKです。）
　
include("setting.html.php")
　
ですが、include()関数の場合は、先ほどの echoと同じく、読み込んだところで処理されてしまいます。
そこで登場するのが、「ob_start()関数」なのです。
　

ob_start();
include("setting.html.php");
$buffer = ob_get_contents();
ob_end_clean();

ob_start();

include("setting.html.php");

$buffer = ob_get_contents();

ob_end_clean();

　
上記のような記述をすることで、include()関数で読み込んだ情報は変数「$buffer」に入っていますので、必要に応じて出力をすることができます。
　
　
これを応用することで、下記のように条件分岐させて include()した情報を必要に応じて出力させることもできます。
変数に代入していますので、複数個所に出力する場合にも利用することができます。
　

ob_start();
if ( $a = "a" ) {
  include("setting_a.html.php");
} else {
  include("setting_b.html.php");
}
$buffer = ob_get_contents();
ob_end_clean();

ob_start();

if ( $a = "a" ) {

include("setting_a.html.php");

} else {

include("setting_b.html.php");

}

$buffer = ob_get_contents();

ob_end_clean();

ob_start()関数の使い方・応用編２

　
ob_start()関数は、callback関数を引数として与えることができます。
下記の例は、ob_start()でバッファリングしたものに対し、str_replace()関数で文字列を置換する処理を実行しています。
同じデザインのテンプレートを、入力フォーム、入力確認画面に置換して利用する、といった使い方もできるのではないでしょうか。
　

<?php
function callback ( $buffer ) {
  // Apple を Google に置換する
  return (str_replace("Apple", "Google", $buffer));
}
ob_start("callback");
?>
<html>
<body>
<p>I like Apple.</p>
</body>
</html>
<?php
ob_end_flush();    // バッファリングを出力する

<?php

function callback ( $buffer ) {

// Apple を Google に置換する

return (str_replace("Apple", "Google", $buffer));

}

ob_start("callback");

<html>

<body>

<p>I like Apple.</p>

</body>

</html>

<?php

ob_end_flush(); // バッファリングを出力する

　
上記を実行すると、下記のように「Apple」が「Google」に置換されて出力されます。
　

<html>
<body>
<p>I like Google.</p>
</body>
</html>

<html>

<body>

<p>I like Google.</p>

</body>

</html>

　
その他、callback関数の使い方によっては多様な処理が考えられるでしょう。
　
　

ob_start()関数に関連する関数

　
ここでは、ob_start()、ob_end_clean()、ob_get_contents()、ob_end_flush()を紹介しましたが、その他、下記のような関数もあるようです。
　
　ob_gzhandler()：出力バッファを gzip 圧縮するための ob_start コールバック関数
　ob_iconv_handler()：出力バッファハンドラとして文字エンコーディングを変換する
　ob_tidyhandler()：ob_tidyhandler — バッファを修正するための ob_start コールバック関数
　
　

ob_start()関数は WordPressのショートコードの処理で必要

　
さてさて、なんで ob_start()関数の記事を書いたのか。
　
実は、WordPressのショートコードで処理を作る際にどうしても必要になったのです。
　
ショートコードの処理を作っていく際に、HTMLは当然のように外部に持たせて、その外部ファイルを include()関数で読み込んで．．．．
　
するとどういうことでしょう！！
include()を実行したタイミングで読み込んだ HTMLが出力されるじゃないですか！！
include()関数で読み込んだ値を変数に代入することもできないし．．．
　
これを解消する方法がこの標準出力をバッファリングしてくれる「ob_start()関数」だったというわけです。
　
WordPressに組み込む解説をした記事は「ob_start、ob_get_contentsを利用しショートコード内でinclude・WordPressプラグイン開発」に書いていますので、WordPressで使う方はこちらの記事も読んでください。
　
と、実は長い長い前ふり記事でした。

- PHP・Smarty・ECCUBE

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Comment

松本より:

2017年5月23日 1:33 PM

初めまして。
千葉でエンジニアをしております松本と申します。

ob_startの使い方について検索していたところこのブログがヒットし、
基本編のサンプルが非常にわかりやすく、すぐに理解できました。

このようなわかりやすい例が書いてある技術ブログはなかなかないので
大変助かりました。

ありがとうございます。

返信
- エス技研より:
  
  2017年5月23日 10:39 PM
  
  松本さん、コメントありがとうございます。
  「分かりやすい」と言っていただけるとすごく嬉しいですね。
  私自身がネットで探してもよく分からず、悩んだことをなるべく記事にしていこうと思って書いていますが、それが役に立ったということで、すごく嬉しいですね。
  　
  今後も分かりやすい記事を書いていこうと思いますので、また見に来てくださいね！
  
  返信

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: PHPで月末から1ヶ月後「+1 month」を算出すると想定する日付にならない場合がある

PHPでは月末の1ヶ月後が想定した日付にならない場合がある。原因はバグではなくPHPの1ヶ月後の定義によるもの。なので必要とする日付を定義しそれに合わせてDateTime、modifyを使用して算出方法を解説している。

: リダイレクトループが原因で「ERR_TOO_MANY_REDIRECTS」「このページを表示できません」が出たときの対策12事例＋α

リダイレクトループ、自動転送設定ループの原因の解説とその対応方法を含め事例 12例を挙げて説明。

: QRコード作成ライブラリ「cakePHP-QR-Code-Helper」をPHPで使うカスタマイズ

CakePHP2用のQRコード作成ライブラリ「cakePHP-QR-Code-Helper」をプレーンのPHPでも使うためのカスタマイズ方法を解説。1ファイルを設置するだけでQRコードが作れるため使い勝手がいい。

: 連想配列のキーも値もまとめてhtmlspecialchars()でサニタイズする関数の作成解説

PHPの配列・連想配列のキーと値をまとめてhtmlspecialchars()関数でサニタイズ（無害化、無毒化）を行う関数を作成。連想配列のキーはarray_map()関数でのサニタイズは無理。

: CentOS6、7のPHPを5.3から5.6、7.0、7.1にバージョンアップする手順の解説

CentOS6系、7系のPHPバージョンを5.3から5.6、7.0、7.1にアップする作業手順と解説。yum updateコマンドを使い作業時間は約10分。コマンドの解説や引数の意味なども解説しているので役に立つはず。