関数・クラス解説

var_export

version:PHP 4 >= 4.2.0, PHP 5, PHP 7 (公式)

変数の文字列表現を出力または返す

公式リファレンス

書式

var_export ( mixed $expression [, bool $return = FALSE ] ) : mixed

説明

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

パラメータ

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

返値

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

注意

注意: return パラメータを使う場合、この関数は内部的に出力バッファリングを使います。そのため、ob_start() コールバック関数の中では使えません。
警告 var_export() でオブジェクトをエクスポートするときに、 名前空間を指定したクラスの名前の先頭にあるバックスラッシュは含めません。これは互換性を高めるためです。

更新履歴

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

サンプル

例1 var_export() の例

$a = array (1, 2, array ("a", "b", "c")); var_export($a);

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

array ( 0 => 1, 1 => 2, 2 => array ( 0 => 'a', 1 => 'b', 2 => 'c', ), ) $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 5.1.0 以降でのクラスのエクスポート

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

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

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

例4 __set_state() の使用法 (PHP 5.1.0 以降)

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" }

参考

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


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    stristr
     大文字小文字を区別せず文字列を検索し、ヒット箇所以降(あるいは以前)の文字列を返却

    stripslashes
     バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    stripos
     大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    stripcslashes
     addcslashes() でクォートされた文字列をアンクォートする

    strip_tags
     文字列から HTML と PHP のタグを除去して返却

    strcspn
     指定した文字が最初に現れる位置を調べる

    strcoll
     ロケールに基づいて2つの文字列を比較し同じか(あるいは大小)を判定する

    strcmp
     2つの文字列を比較し同じか(あるいは大小)を判定する

    strchr
     strstr() のエイリアス

    strcasecmp
     2つの文字列を比較(大文字小文字を区別せず同じとみなす)

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール