説明

var_export(mixed $value, bool $return = false): ?string

var_export() は、渡された変数に関する構造化された情報を返します。この関数は var_dump() に似ていますが、返される表現が有効な PHP コードであるところが異なります。

パラメータ

value: エクスポートしたい変数
return: 使用されかつ true に設定された場合、var_export() は変数表現を出力する代わりに返します。

戻り値

return パラメータが使用され true と評価される場合、変数表現を返します。そうでない場合、この関数は null を返します。

変更履歴

バージョン説明

8.2.0 クラス名をエクスポートする場合、そのクラス名は完全修飾名になりました。これより前のバージョンでは、先頭のバックスラッシュが省略されていました。

7.3.0 stdClass オブジェクトは、存在しないメソッド stdClass::__setState() を使わず、配列をオブジェクトにキャストした形 ((object) array( ... )) でエクスポートされるようになりました。この変更によって、stdClass がエクスポート可能になり、このバージョンより前の PHP でもエクスポートした結果が動くようになりました。

バージョン	説明
8.2.0	クラス名をエクスポートする場合、そのクラス名は完全修飾名になりました。これより前のバージョンでは、先頭のバックスラッシュが省略されていました。
7.3.0	stdClass オブジェクトは、存在しないメソッド stdClass::__setState() を使わず、配列をオブジェクトにキャストした形 (`(object) array( ... )`) でエクスポートされるようになりました。この変更によって、stdClass がエクスポート可能になり、このバージョンより前の PHP でもエクスポートした結果が動くようになりました。

例

例1 var_export() の例

<?php
$a = array (1, 2, array ("a", "b", "c"));
var_export($a);
?>

上の例の出力は以下となります。

array (
  0 => 1,
  1 => 2,
  2 =>
  array (
    0 => 'a',
    1 => 'b',
    2 => 'c',
  ),
)

<?php

$b = 3.1;
$v = var_export($b, true);
echo $v;

?>

上の例の出力は以下となります。

3.1

例2 PHP 7.3.0 以降で stdClass をエクスポートする

<?php
$person = new stdClass;
$person->name = 'ElePHPant ElePHPantsdotter';
$person->website = 'https://php.net/elephpant.php';

var_export($person);

上の例の出力は以下となります。

(object) array(
   'name' => 'ElePHPant ElePHPantsdotter',
   'website' => 'https://php.net/elephpant.php',
)

例3 クラスのエクスポート

<?php
class A { public $var; }
$a = new A;
$a->var = 5;
var_export($a);
?>

上の例の出力は以下となります。

\A::__set_state(array(
   'var' => 5,
))

例4 __set_state() の使用法

<?php
class A
{
    public $var1;
    public $var2;

    public static function __set_state($an_array)
    {
        $obj = new A;
        $obj->var1 = $an_array['var1'];
        $obj->var2 = $an_array['var2'];
        return $obj;
    }
}

$a = new A;
$a->var1 = 5;
$a->var2 = 'foo';

eval('$b = ' . var_export($a, true) . ';'); // $b = A::__set_state(array(
                                            //    'var1' => 5,
                                            //    'var2' => 'foo',
                                            // ));
var_dump($b);
?>

上の例の出力は以下となります。

object(A)#2 (2) {
  ["var1"]=>
  int(5)
  ["var2"]=>
  string(3) "foo"
}

注意

注意:
resource 型の変数は、この関数ではエクスポートする事ができません。

注意:
var_export() では循環参照を扱うことができません。循環参照を表す解析可能な PHP コードを生成することは、不可能に近いからです。配列やオブジェクトを完全な形式で扱いたい場合は serialize() を使用してください。

警告

PHP 8.2.0 より前のバージョンでは、var_export() でオブジェクトをエクスポートするときに、名前空間を指定したクラスの名前の先頭にあるバックスラッシュは含めませんでした。これは互換性を高めるためでした。

注意:
var_export() が生成する PHP を評価できるようにするためには、処理対象のすべてのオブジェクトがマジックメソッド __set_state を実装している必要があります。これの唯一の例外は stdClass です。 stdClass は、配列をオブジェクトにキャストした形でエクスポートされます。

参考

print_r() - 指定した変数に関する情報を解りやすく出力する
serialize() - 値の保存可能な表現を生成する
var_dump() - 変数に関する情報をダンプする