print_r
解説 | 指定した式に関する情報を解りやすく出力する |
---|---|
書式 | bool print_r( mixed expression [, bool return ] ) |
bool print_r( mixed 式 [, bool 返り値オプション ] ) |
|
引数 |
expression
式
|
return
結果をキャプチャするかどうかのオプション。デフォルトはFALSE(キャプチャしない)
|
|
返値 | TRUE(成功した時)/FALSE(失敗した時) |
print_r()は分かりやすい形式で変数の値に関する情報を表示します。
変数の情報が返されます。
expression
式情報を出力したい変数を指定します。
return
返り値オプション省略可能なオプション引数で、結果をキャプチャするかどうかのオプションです。TRUEを指定すると結果を出力せずにキャプチャします。この引数により、変数などにprint_r()関数の出力結果を保持しておく事が可能になります。デフォルトはFALSEで、キャプチャせずに出力します。
文字列型、整数型、浮動小数点型を指定した場合はその値が出力されます。
配列型やオブジェクト型を指定した場合はキーと要素を表す形式で値が表示されます。print_r()とvar_export()は(PHP5では)オブジェクトのprotected
及びprivate
プロパティも表示しますが、var_dump()は表示しません。
print_r()は配列ポインタを終端まで移動します。
この関数の出力は見やすいようにフォーマットされているので、<pre>
タグを使うと見やすく表示する事ができます。
※return引数はPHP4.3.0以降追加されました。それ以前のバージョンでprint_r()の結果をキャプチャしたい場合は出力制御関数を使用して下さい。
※PHP4.0.4以前のバージョンでは、指定した配列またはオブジェクトが自分自身への直接・間接の参照を有しているか場合には無限ループが発生しました。
参考関数
- ob_start() ---- 出力のバッファリングをオンにする
- var_dump() ---- 指定した変数に関する情報をダンプする
- var_export() ---- 変数の文字列表現を出力または取得する
サンプルスクリプト
簡単な利用例
- $fruit = array( "banana" => "バナナ", "orange" => "オレンジ", "apple"=> "りんご" );
- print "<pre>";
- print_r($fruit);
- print "</pre>";
出力結果
Array ( [banana] => バナナ [orange] => オレンジ [apple] => りんご )
配列などの場合、改行やタブを含めて表示してくれるので<pre>
タグで囲むと見やすい表示になります。
第2引数returnの指定方法
- $fruit = array( "banana" => "バナナ", "orange" => "オレンジ", "apple"=> "りんご" );
- $result = print_r($fruit, TRUE);
- print "<pre>";
- echo $result;
- print "</pre>";
出力結果
Array ( [banana] => バナナ [orange] => オレンジ [apple] => りんご )
結果を保持しておくと、後からの出力も可能になります。