PHP var_exportの使い方と利用例について解説

PHP の var_export は変数の内容を再利用可能なコードとして出力する関数です。

デバッグやコードチェック時に利用でき、結果を直接確認しやすくなります。

この記事ではその基本的な使用例と注意すべきポイントを簡潔に紹介します。

PHP var_exportの基本

var_exportの概要

PHPの組み込み関数であるvar_exportは、変数の内容をPHPコードとして有効な形式で表現するために利用されます。

変数の状態をそのまま再現可能な文字列に変換するため、後で同じ値を復元できるメリットがあります。

ただし、返り値としての文字列が得られるか、直接出力されるかはオプションに依存します。

基本的な使用方法

var_exportは、指定した変数の内容を「人間が理解しやすい」形で整形して出力します。

PHPコードとして有効な表現であるため、そのままevalで再利用することも可能です。

引数と返り値の仕様

var_exportには少なくとも1つの必須引数と、オプションの引数が存在します。

• 第一引数：出力対象の変数を指定します。
• 第二引数(省略可能)：真偽値を指定することで、直接出力するか返り値として文字列を返すかを制御できます。

この引数にtrueを指定すると、出力結果が文字列として返され、falseまたは省略した場合は直接出力されます。

以下のサンプルコードをご覧ください。

<?php
// サンプルデータの定義
$data = ['key' => 'value'];
// 直接出力する場合(返り値は出力されるだけ)
var_export($data);
// 返り値として文字列を取得する場合
$output = var_export($data, true);
echo "\n出力内容: " . $output;
?>

array (
  'key' => 'value',
)
出力内容: array (
  'key' => 'value',
)

実行結果の出力形式

var_exportが出力する結果は、PHPで利用可能なコード表現となります。

たとえば、配列であれば以下のように記述されます。

• インデントや改行が適切に付与され、読みやすく整形された出力が得られます。
• 返り値が文字列であれば、後続処理で容易に利用することが可能です。

PHP var_exportの利用例

シンプルな変数の出力例

数値や文字列などのシンプルな変数を出力する場合に、var_exportを利用する例です。

以下のサンプルコードは、整数や文字列を直接出力する例を示しています。

<?php
// シンプルな変数の定義
$number = 42;
$string = "Hello World";
// 変数の直接出力
var_export($number);
echo "\n";
var_export($string);
?>

42
'Hello World'

複雑なデータ型の出力例

複雑なデータ型である配列やオブジェクトも、var_exportを使用して簡単に出力できます。

配列の出力例

多次元配列を含む複雑なデータ構造もvar_exportで整形して出力できます。

以下のコードは、連想配列を例に挙げています。

<?php
// 複雑な配列の定義
$dataArray = [
    'name' => 'Alice',
    'age' => 30,
    'languages' => ['PHP', 'JavaScript', 'Python']
];
// 配列の出力
var_export($dataArray);
?>

array (
  'name' => 'Alice',
  'age' => 30,
  'languages' =>
  array (
    0 => 'PHP',
    1 => 'JavaScript',
    2 => 'Python',
  ),
)

オブジェクトの出力例

オブジェクトの場合、クラス名とともにプロパティの内容が表示されます。

以下のサンプルコードは、シンプルなユーザークラスを定義し、そのインスタンスを出力する例です。

<?php
// ユーザークラスの定義
class User {
    public $name;
    public $email;
    public function __construct($name, $email) {
        $this->name = $name;
        $this->email = $email;
    }
}
// インスタンスの生成と出力
$user = new User('Bob', 'bob@example.com');
var_export($user);
?>

User::__set_state(array(
   'name' => 'Bob',
   'email' => 'bob@example.com',
))

他のデバッグ関数との比較

print_rとの違い

print_rは、変数の内容を読みやすい形式で表示するための関数です。

ただし、以下の点でvar_exportと異なります。

• print_rは、出力結果がPHPコードとして再利用できる形式ではありません。
• ヒューマンリーダブルなフォーマットに重点を置いているため、コードとしての利用は難しい場合があります。

下記のサンプルコードは、同じ配列をvar_exportとprint_rで出力する例です。

<?php
$data = ['color' => 'red', 'size' => 'L'];
echo "var_export: \n";
var_export($data);
echo "\nprint_r: \n";
print_r($data);
?>

var_export:
array (
  'color' => 'red',
  'size' => 'L',
)
print_r:
Array
(
    [color] => red
    [size] => L
)

var_dumpとの違い

var_dumpは、変数の型や長さなど詳細な情報を出力します。

以下の点でvar_exportと異なります。

• var_dumpは、データ型や内部情報を含む詳細な出力を行います。
• var_exportは、変数を再利用可能なPHPコードとして整形して出力します。

以下のサンプルコードは、同一の配列に対してvar_exportとvar_dumpを比較しています。

<?php
$data = ['color' => 'red', 'size' => 'L'];
echo "var_export: \n";
var_export($data);
echo "\nvar_dump: \n";
var_dump($data);
?>

var_export:
array (
  'color' => 'red',
  'size' => 'L',
)
var_dump:
array(2) {
  ["color"]=>
  string(3) "red"
  ["size"]=>
  string(1) "L"
}

注意事項と活用のヒント

出力結果の整形と利用方法

var_exportで出力される結果は、基本的にPHPコードとして利用可能な形式に整形されています。

場合により、表示上のカスタマイズや整形を行いたい場合は、返り値として取得した後に適宜加工してください。

たとえば、出力結果に対して文字列操作関数を用いてインデントの変更や不要な空白の削除が可能です。

バージョンによる挙動の違い

PHPのバージョンによっては、var_exportが出力する形式に若干の違いが見られることがあります。

特にオブジェクトの出力形式については、バージョンアップに伴い変化する可能性があるため、利用時には公式ドキュメントを確認することが望ましいです。

セキュリティ面の留意点

var_exportは変数の完全な内容を出力するため、機密情報が含まれる場合は注意が必要です。

ログや画面に出力する前に、不要な情報が含まれていないか十分に確認することが大切です。

まとめ

この記事では、PHPのvar_exportの概要や基本的な使用方法、実行結果の出力形式、利用例、他のデバッグ関数との違い、注意事項について解説しました。

全体を通して、var_exportの特徴と実際の利用シーンが理解できる内容でした。

ぜひ、実際の開発にvar_exportを取り入れ、より効果的なデバッグを体験してください。