PHPのvar_dump()とprint_r()：配列の表示とデバッグ

print_r($array)は、配列やオブジェクトをキーと値付きの読みやすい形で出力します。var_dump($value)は同じ構造に加えて、すべての値の型と長さを出力します。配列に何が入っているかを見るならprint_rを、値が"1"なのか1なのかを知る必要があるならvar_dumpを使います。

<?php
$user = ["name" => "Ada", "age" => 36, "admin" => false, "tags" => ["math", "code"]];

print_r($user);
echo "\n";
var_dump($user);

2つの出力のadminを比べてください。print_rは矢印のあとに何も出力していませんが、var_dumpはbool(false)と出力しています。この違いが、デバッグ中にvar_dumpを選ぶいちばんの理由です。

print_r、var_dump、var_exportの違い

3つの関数は同じデータを異なる詳しさで表示します。

<?php
$values = [0, "0", "", null, false, 1.5];

echo "print_r:\n";
print_r($values);

echo "\nvar_dump:\n";
var_dump($values);

echo "\nvar_export:\n";
var_export($values);
echo "\n";

print_rはいちばん読みやすく、var_dumpはいちばん正確で、var_exportはファイルに貼り戻せるコードを返します。

print_rの出力を文字列として得る

2つ目の引数にtrueを渡すと、print_rは出力せずにテキストを返します。配列をログファイルに書いたり、もっと大きなメッセージの中に入れたりする方法です。

<?php
$order = ["id" => 1042, "items" => ["book", "pen"], "total" => 18.5];

$text = print_r($order, true);

echo "Order received:\n" . $text;
echo "That was " . strlen($text) . " characters\n";

file_put_contents("debug.log", date("H:i:s") . " " . $text, FILE_APPEND);
echo "Log size: " . filesize("debug.log") . " bytes\n";

var_export($value, true)も同じように文字列を返します。var_dumpは常に出力するので、取り込むには出力バッファリングが必要です：ob_start(); var_dump($x); $text = ob_get_clean();。

preを使ってHTMLで配列を整形表示する

ブラウザでは、HTMLが空白を無視するので、print_rの改行と空白はつぶれて1行の長い行になります。レイアウトを保つには、出力を<pre>で包みます。実行してPageタブを見てください。

<?php
$menu = [
    "Starters" => ["Soup" => 6, "Salad" => 7],
    "Mains" => ["Pasta" => 14, "Risotto" => 15],
];

echo "<h3>Without pre</h3>\n";
print_r($menu);

echo "<h3>With pre</h3>\n";
echo "<pre>" . htmlspecialchars(print_r($menu, true)) . "</pre>\n";

echo "<h3>As JSON</h3>\n";
echo "<pre>" . htmlspecialchars(json_encode($menu, JSON_PRETTY_PRINT)) . "</pre>\n";

ユーザーの入力のように、データに<や&が含まれうるとたんにhtmlspecialcharsが重要になります。それがなければ、ブラウザはそのテキストをHTMLとして扱ってしまいます。JavaScriptやAPIに送るデータには、json_encodeの形がいちばん役立つことがよくあります。

複数の値を一度にダンプする

var_dumpは引数をいくつでも受け取り、順に出力するので、2つの値を並べて比べるのに手軽です。

<?php
$fromForm = "42";
$fromDb = 42;

var_dump($fromForm, $fromDb, $fromForm == $fromDb, $fromForm === $fromDb);

出力を見ると、==が等しいと言い===が言わない理由がわかります。一方はstring(2) "42"、もう一方はint(42)です。

オブジェクトを出力する

3つの関数はオブジェクトも出力します。var_dumpとprint_rはprivateとprotectedのプロパティに印を付けるので（[label:Point:private]）、プロパティが見当たらないように思えるときに役立ちます。

<?php
class Point
{
    public function __construct(
        public int $x,
        public int $y,
        private string $label = "origin",
    ) {}
}

$p = new Point(3, 4);

print_r($p);
echo "\n";
var_dump($p);

var_dumpの出力の#1はオブジェクトのIDです。同じIDを表示する2つの変数は、同じオブジェクトを指しています。

よくあるミス：配列をechoする

echoは引数を文字列に変えます。配列には文字列の形がないので、PHPはArrayという単語を出力し、警告を出します。

<?php
$colors = ["red", "green", "blue"];
echo $colors;

PHPの出力：

Warning: Array to string conversion in /home/index.php on line 3
Array

上の関数のどれかで中身を出力するか、自分で値をつなぎます。

<?php
$colors = ["red", "green", "blue"];

echo implode(", ", $colors), "\n";
echo json_encode($colors), "\n";
print_r($colors);

implodeはユーザーにリストを見せるため、json_encodeはログやAPIのため、print_rやvar_dumpは自分のデバッグのためのものです。