var_export
(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)
var_export — 変数の文字列表現を出力または返す
説明
var_export() は、 渡された変数に関する構造化された情報を返します。この関数は var_dump() に似ていますが、 返される表現が有効な 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"
}
注意
注意:
リソース型 の変数は、 この関数ではエクスポートする事ができません。
注意:
var_export() では循環参照を扱うことができません。 循環参照を表す解析可能な PHP コードを生成することは、不可能に近いからです。 配列やオブジェクトを完全な形式で扱いたい場合は serialize() を使用してください。
警告
PHP 8.2.0 より前のバージョンでは、var_export() でオブジェクトをエクスポートするときに、 名前空間を指定したクラスの名前の先頭にあるバックスラッシュは含めませんでした。これは互換性を高めるためでした。
注意:
var_export() が生成する PHP を評価できるようにするためには、 処理対象のすべてのオブジェクトがマジックメソッド __set_state を実装している必要があります。 これの唯一の例外は stdClass です。 stdClass は、配列をオブジェクトにキャストした形でエクスポートされます。
＋add a note
User Contributed Notes 21 notes
steven at nevvix dot com ¶
5 years ago
I improved my previous varexport().
<?php
/**
* PHP var_export() with short array syntax (square brackets) indented 2 spaces.
*
* NOTE: The only issue is when a string value has `=>\n[`, it will get converted to `=> [`
* @link https://www.php.net/manual/en/function.var-export.php
*/
function varexport($expression, $return=FALSE) {
$export = var_export($expression, TRUE);
$patterns = [
"/array \(/" => '[',
"/^([ ]*)\)(,?)$/m" => '$1]$2',
"/=>[ ]?\n[ ]+\[/" => '=> [',
"/([ ]*)(\'[^\']+\') => ([\[\'])/" => '$1$2 => $3',
];
$export = preg_replace(array_keys($patterns), array_values($patterns), $export);
if ((bool)$return) return $export; else echo $export;
}
$array = [
'str' => 'Test
spaces',
0 => 33,
1 => TRUE,
[3,4,'d',[]],
'arr' => [
'text with spaces' => '[Tes\'t"s":
=> [
=>
[
{
spaces',
],
"str2" => "Test's'
} spaces",
'arr2' => [
'text with spaces' => [
'arr3' => [
'text with spaces' => 'Te": "st \' => [
spaces',
],
],
],
];
varexport($array);
// Result:
```
[
'str' => 'Test
spaces',
0 => 33,
1 => true,
2 => [
0 => 3,
1 => 4,
2 => 'd',
3 => [
],
],
'arr' => [
'text with spaces' => '[Tes\'t"s":
=> [
=> [
{
spaces',
],
'str2' => 'Test\'s\'
} spaces',
'arr2' => [
'text with spaces' => [
'arr3' => [
'text with spaces' => 'Te": "st \' => [
spaces',
],
],
],
]
```
NOTE: The only issue is when a string value has `=>\n[`, it will get converted to `=> [`
steven at nevvix dot com ¶
6 years ago
/**
* var_export() with square brackets and indented 4 spaces.
*/
<?php
function varexport($expression, $return=FALSE) {
$export = var_export($expression, TRUE);
$export = preg_replace("/^([ ]*)(.*)/m", '$1$1$2', $export);
$array = preg_split("/\r\n|\n|\r/", $export);
$array = preg_replace(["/\s*array\s\($/", "/\)(,)?$/", "/\s=>\s$/"], [NULL, ']$1', ' => ['], $array);
$export = join(PHP_EOL, array_filter(["["] + $array));
if ((bool)$return) return $export; else echo $export;
}
Mark P ¶
8 years ago
It doesn't appear to be documented, but the behaviour of `var_export()` changed in PHP 7.
Previously, `var_export(3.)` returned "3", now it returns "3.0".
chudinov at yahoo dot com ¶
11 years ago
Looks like since version 5.4.22 var_export uses the serialize_precision ini setting, rather than the precision one used for normal output of floating-point numbers.
As a consequence since version 5.4.22 for example var_export(1.1) will output 1.1000000000000001 (17 is default precision value) and not 1.1 as before.
<?php
//ouput 1.1000000000000001
var_export(1.1)
?>
4n4jmza02 at sneakemail dot com ¶
14 years ago
I learned the hard way that if var_export encounters a resource handle it exports it as "NULL", even if it is a valid handle. The documentation states that a handle cannot be exported, but it does not describe what happens if you try to do so anyway.
I had been using var_export in some debugging code while tracing a problem with a resource handle not being generated and ended up thinking that null handles were still being generated long after the problem had been fixed.
dan at coders dot co dot nz ¶
10 years ago
I found that my complex type was exporting with
stdClass::__set_state()
in places. Not only was that strange and messy, it cannot be eval()-ed back in at all. Fatal error. Doh!
However a quick string-replace tidy-up of the result rendered it valid again.
$macro = var_export($data, TRUE);
$macro = str_replace("stdClass::__set_state", "(object)", $macro);
$macro = '$data = ' . $macro . ';';
And now the string I output *can* be evaluated back in again.
laszlo dot heredy at gmail dot com ¶
14 years ago
Try this function instead of var_export($GLOBALS) or var_dump($GLOBALS) when all you want to know is the values of the variables you set on the current page.
<?php
function globalvars(){
$result=array();
$skip=array('GLOBALS','_ENV','HTTP_ENV_VARS',
'_POST','HTTP_POST_VARS','_GET',
'HTTP_GET_VARS',
'_COOKIE',
'HTTP_COOKIE_VARS','_SERVER',
'HTTP_SERVER_VARS',
'_FILES','HTTP_POST_FILES',
'_REQUEST','HTTP_SESSION_VARS',
'_SESSION');
foreach($GLOBALS as $k=>$v)
if(!in_array($k,$skip))
$result[$k]=$v;
return $result;
}//functionglobalvars
var_export(globalvars());
?>
linus at flowingcreativity dot net ¶
19 years ago
<roman at DIESPAM dot feather dot org dot ru>, your function has inefficiencies and problems. I probably speak for everyone when I ask you to test code before you add to the manual.
Since the issue of whitespace only comes up when exporting arrays, you can use the original var_export() for all other variable types. This function does the job, and, from the outside, works the same as var_export().
<?php
function var_export_min($var, $return = false) {
if (is_array($var)) {
$toImplode = array();
foreach ($var as $key => $value) {
$toImplode[] = var_export($key, true).'=>'.var_export_min($value, true);
}
$code = 'array('.implode(',', $toImplode).')';
if ($return) return $code;
else echo $code;
} else {
return var_export($var, $return);
}
}
?>
NitPicker ¶
11 years ago
When it comes to HTML output (as discussed below), it's all fun and games until someone pokes their eye out with a "<".
Surround it with "<pre>", but do remember to wrap it in htmlspecialchars() as well.
beverasrilakshmi at gmail dot com ¶
5 years ago
Just for fun, trying to understand the definition of "returns parsable string"....any type of variable passed to var_export, the return value will be a typecasted as string...
<?php
$var = 1;
var_dump($var); //type is int as expected
echo "<br>";
$var_after_export = var_export($var,true); //returning $var will now makes it a string
var_dump($var_after_export);
?>
john dot risken at gmail dot com ¶
14 years ago
I didn't see this simple little item anywhere in the user notes. Maybe I'm blind!
Anyway, var_export and print_r both use spaces and carriage returns for formatting. Sent to an html page, most of the formatting is lost. This simple function prints a nicely formatted array to an html screen:
<?php
function pretty_var($myArray){
print str_replace(array("\n"," "),array("<br>"," "), var_export($myArray,true))."<br>";
}
?>