PHPのデバッグで使う print_r、var_dump、var_exportの動作の違い

2024/06/24 2024/06/27

PHPのデバッグで使う print_r、var_dump、var_exportの動作の違い

　
PHPでプログラム開発を行う時のデバッグなどで変数の中身を確認する際に「print_r()」「var_dump()」「var_export()」「echo()」を使うかと思います。
　
人によって使う関数が異なり、たぶん、初めて使った関数を何気なくずっと使い続けているのではないかと思いますし、複数の関数を使い分けている方はほぼいないのではないかと思います。
　
と言うわけで、それぞれの関数にどのような特徴があるのか、調べてみました。
　
　

print_r、var_dump、var_exportの出力形式の違い

　
まずは、それぞれ配列を出力させてみて、どのような違いがあるかを確認します。
　

// 下記の配列を出力します。
$array = [
  "aaa" => 123,
  "bbb" => "123",
  "ccc" => "123 ",
  "ddd" => "あああ",
];

print_r($array);
var_dump($array);
var_export($array);

// 下記の配列を出力します。

$array = [

"aaa" => 123,

"bbb" => "123",

"ccc" => "123 ",

"ddd" => "あああ",

];

print_r($array);

var_dump($array);

var_export($array);

　
　
出力結果は以下の通りとなりました。
　

// print_r($array);
  Array
(
    [aaa] => 123
    [bbb] => 123
    [ccc] => 123 
    [ddd] => あああ
)

// var_dump($array);
array(4) {
  ["aaa"]=>
  int(123)
  ["bbb"]=>
  string(3) "123"
  ["ccc"]=>
  string(4) "123 "
  ["ddd"]=>
  string(9) "あああ"
}

// var_export($array);
array (
  'aaa' => 123,
  'bbb' => '123',
  'ccc' => '123 ',
  'ddd' => 'あああ',
)

// print_r($array);

Array

(

[aaa] => 123

[bbb] => 123

[ccc] => 123

[ddd] => あああ

)

// var_dump($array);

array(4) {

["aaa"]=>

int(123)

["bbb"]=>

string(3) "123"

["ccc"]=>

string(4) "123 "

["ddd"]=>

string(9) "あああ"

}

// var_export($array);

array (

'aaa' => 123,

'bbb' => '123',

'ccc' => '123 ',

'ddd' => 'あああ',

)

　
出力結果の違いとしては、以下のような感じです。
　
「print_r()」は、非常にシンプル。また、「ccc」にある空白が確認出来ないためデバッグに使うには問題がありそうです。
　
「var_dump()」は、数値と認識されているか、文字と認識されているかの違いや、文字数（桁数）も確認出来ます。また、「ccc」の空白も確認出来ます。
　
「var_export()」は、文字数は分かりませんが、「ccc」の空白を確認することができます。最大の特徴は、出力された配列をそのまま PHPの配列として再利用できる点です。
（入力した変数と同じ形式ですので、PHPの配列としてコピペして使用できます。）
　
　
ちなみに、「echo」は配列を扱えないため、デバッグに使用するにはかなり限定的な使用になるかと思います。
　
　

print_r、var_dump、var_exportの出力先の違い・戻り値を受け取れるか

　
「print_r()」「var_dump()」「var_export()」の機能の違いとしては、戻り値を返す機能があるかどうか、です。
　
　
デフォルトでは、いずれも標準出力（画面に出力）する使用になっていますが、画面に表示する内容を戻り値として受け取り、変数に格納することができるか否か、の機能が異なります。
　
「print_r()」「var_export()」は、戻り値を受け取ることが出来ます。
「var_dump()」は、戻り値を受け取る仕様がありません。
　

$response = print_r($array, true);
$response = var_export($array, true);

1 2	$response = print_r($array, true); $response = var_export($array, true);

　
「print_r()」「var_export()」は、上記のように第 2引数（パラメータ）に「true」を指定することで、標準出力ではなく、戻り値として戻すようになりますので、その値を変数に格納することが出来ます。
　
　
CakePHP4でログ出力に際しては、直接配列を扱えなくなりましたので、「var_export()」を使う必要が出てきましたが、CakePHP4のログ出力に関しては下記に記事を書いていますので併せて参考にしてください。
CakePHP4でロギングスコープやログレベルを使用してログを出し分ける方法を解説
　
　

print_r、var_dump、var_exportの動作の違いのまとめ

　
上記の違いから、デバッグをする際に標準出力を行って確認をする場合は、「var_dump()」「var_export()」が有用だと思います。
　
ですが、ログ出力をする際に戻り値を必要とする場合は、「var_export()」を使うことになります。
（「print_r()」では出力される情報が不足しているため、確実なデバッグには難があるといわざるを得ません。）
　
と言うわけで、デバッグに使うなら「var_export()」がオススメ！って事になりますね。
　
　

かく言う私は「print_r()」を使っていた

　
かく言う私は「print_r()」をずっと使っていましたが、他の関数の仕様を詳しく調べることなくこれまで過ごしてきました。
　
特に不便に思うこともなかったわけですが、CakePHP4でログ出力する際に配列を扱う場合は「var_export()」を使う使う必要があるため、『「print_r()」と「var_export()」は、何が違うんだ？』と思ったことがきっかけでした。
　
ですが、しっかり調べてみると、「print_r()」を使うメリットが見えないな、と改めて思った次第です。
　
　

参考サイト

　
「var_export()」
https://www.php.net/manual/ja/function.var-export.php
一番最初に「var_export() は、渡された変数に関する構造化された情報を返します。この関数は var_dump() に似ていますが、返される表現が有効な PHP コードであるところが異なります。」と書いてありますので、明確な目的がある関数ですね。
　
「print_r()」
https://www.php.net/manual/ja/function.print-r.php
　
「var_dump()」
https://www.php.net/manual/ja/function.var-dump.php
「ブラウザに直接結果を出力するすべてのものと同様に、出力制御関数を使用してこの関数の出力をキャプチャーし、(例えば)文字列 (string)に保存することが可能です。」
と記載がある「出力制御（出力バッファリング）」に関しては下記に記事を書いていますので併せて参考にしてください。
ob_start、ob_get_contents関数でPHPの標準出力をバッファリング・変数に代入

- PHP・Smarty・ECCUBE

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

Message コメントをキャンセル

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

: カオナビAPI Ver.2.0のtokenを取得する PHP＋cURLのサンプルプログラム

PHPのcURLを使用してカオナビAPIのアクセスに必要なtoken、シートの情報を取得するサンプルプログラムを作成。cURLの処理は関数化しているため他のAPIでも流用できる。

: cURLを利用する際の注意点「&」があるURLは「”」で囲む

cURLでURLはダブルクォーテーションで囲む。LinuxでもWindowsでもコマンドでは「＆」は意味を持つ文字のためエラー原因になる。クォーテーションは常につけておく方が無難。

: AdminerはphpMyAdmin代替のデータベース管理ツール

AdminerはphpMyAdminとほぼ同機能のデータベース管理ツール。PHP 1ファイルのため設置が非常に簡単で軽快に動作し、phpMyAdminの置き換えで使うのも問題なし。

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

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

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

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

: PHP　range関数を使って階乗と重複組み合わせを計算

PHPの range関数を使って階乗と重複組み合わせを計算し、それを元に乱数発生器を作成しました。

: XML形式の値を配列形式に変換・PHPでは simplexml_load_string()

XMLとは「Extensible Markup Language」の略でテキストベースのデータフォーマット。XMLをPHPで配列に変換するWebツールの紹介とその処理「simplexml_load_string()」関数についての解説。

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

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

: 数値がMySQLのint(11)に保存できない！PHPの変数が本当にint型か確認！

PHPでintegerとdoubleが混在するような計算をする場合は要注意！計算結果が整数値であっても途中で使用する変数にdoubleの値が入っているときは計算結果がintegerではない場合があります。