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 コメントをキャンセル

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

: PHPのスクレイピングライブラリ「PHP Simple HTML DOM Parser」の使い方

PHPのスクレイピングライブラリ「PHP Simple HTML DOM Parser」の使い方を解説。要素を取得する方法、そこから属性を取得する方法を解説。また、マニュアルにはない注意点なども解説。

: ECCUBE2.13.3で商品規格の在庫数が無制限から変更できないバグがある

2.13.3固有のバグである商品規格の在庫数の入力エリアがアクティブにならない不具合を解消する解説です。product_class.tplの2行を修正するだけの簡単対応です。

: 指定した数で文字列を丸める（n文字目で…にする）関数substr、mb_substr、mb_strimwidthの違い

文字列を指定された数で抜き出すPHPの関数、substr、mb_substr、mb_strimwidthについての解説。似た関数だが引数の指定方法が違ったり、文字数がバイト数か文字数かも違ったり、注意が必要だ。

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

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

: PHPでスクレイピング。phpQueryとphp-simple-html-dom-parserの比較と設置方法

「PHP スクレイピング」で検索すると「phpQuery」ばかりヒットするが、10年以上も放置されている。なので今も開発が続いている「PHP Simple HTML DOM Parser」をオススメする。

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

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

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

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

: Basic認証の.htaccess、.htpasswd生成ツールと解説

Basic認証を設定する際に必要となる.htaccess、.htpasswdファイルを生成するツール。ID、PASS、.htpasswdへのパスを入力することで編集する情報を生成します。

: PHPのcURLでAPIやWebサイトへのアクセス方法。file_get_contentsとの比較

PHPからWebサイトにアクセスしてHTMLを取得、APIにアクセスして情報を取得する場合は、cURLがオススメ。file_get_contentsでも可能だがエラー制御に難がありトラブルのもとになる。