エス技研

WordPress、CakePHP、PHP、baserCMSなどの Web系システムを中心に情報を提供します!


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

      2017/05/23

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

 

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

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

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

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

 

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


 

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

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

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

 
 

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

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

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

 
その他、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

GoogleAdwords

GoogleAdwords

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

Comment

  1. 松本 より:

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

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

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

    ありがとうございます。

    • エス技研 より:

      松本さん、コメントありがとうございます。
      「分かりやすい」と言っていただけるとすごく嬉しいですね。
      私自身がネットで探してもよく分からず、悩んだことをなるべく記事にしていこうと思って書いていますが、それが役に立ったということで、すごく嬉しいですね。
       
      今後も分かりやすい記事を書いていこうと思いますので、また見に来てくださいね!

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

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

  関連記事

PHPのソースで見慣れない記号が出てきた・アロー演算子(->)、ダブルアロー演算子(=>)

PHPのプログラムソースには見慣れない記号が出てきます。その意味や調べ方です。

PHP画面が真っ白 header(“Location: $url”);

PHPの開発で header(“Location: $url”);を使うと画面が真っ白になる不具合が出る場合もあります。

フォルダを指定してファイルのパーミッションを変更するプログラム

フォームからフォルダ、パーミッションを指定しパーミッションを変更するサンプルプログラムの解説です。

複数銘柄を指定して株価チャートを一覧するツール公開

入力銘柄の5日間、3か月間、6か月間、1年間、2年間の株価チャートを一覧表示しますのでチャートで売買判断をするのに最適です。

このウェブページにはリダイレクト ループが含まれていますの対策12事例+2事例追加

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

Phpmailerでスパム回避!Gmail等のSMTPを経由するPHPのメールフォーム解説

お問い合わせ等のメールフォームから送ったメールがスパム扱いされる!その対策としてライブラリ「Phpmailer」を使う方法を解説。関数化していますのでコピペでOK。

PHPパーミッション変更のchmod関数・モードを変数で指定する方法

パーミッション変更関数であるchmod関数の第二引数、ファイルモードの指定に変数を使う場合は8進数に変換するoctdec関数を使って変換します。

Smartyの Syntax Errorの原因はスペースかも

Smartyのなかなか原因がつかめない Syntax Errorの原因はスペースかもしれません。

GMOペイメントゲートウェイのjava.io.IOExceptionのエラー

ECCUBEの決済でGMOペイメントゲートウェイのモジュールを使ってテスト決済を行った場合の不具合、java.io.IOExceptionと言うエラーの原因と対策方法の解説です。

ECCUBEの管理画面のSSL設定をインストール後に変更する方法

ECCUBEをインストールした後から管理画面のSSL設定を変更する方法を解説します。config.phpファイルのHTTPS_URLとADMIN_FORCE_SSLの値を変更すればOK。