【PHP8.x】var_export関数の使い方

var_export関数は、指定された変数の表現を出力または返却する関数です。この関数は、PHPのコードとして評価可能な形式で変数の内容を表現するため、配列やオブジェクトなど、複雑な構造を持つ変数の状態を把握するのに役立ちます。主に、デバッグや設定ファイルの生成、データのシリアライズなどに利用されます。

var_export関数は、引数として変数を受け取り、オプションで第2引数に return パラメータを指定できます。return パラメータが true の場合、var_export関数は変数の表現を文字列として返します。return パラメータが省略された場合、または false の場合、変数の表現は直接出力されます。

この関数は、変数の型を保持したまま表現を生成するため、serialize 関数や json_encode 関数とは異なり、PHPのコードとして直接利用できる形式でデータを出力できる点が特徴です。特に、配列のキーやオブジェクトのプロパティ名も正確に表現されるため、設定ファイルなど、PHPのコードとして解釈される必要があるデータの生成に非常に適しています。ただし、var_export 関数は循環参照を持つオブジェクトを適切に処理できないため、その点には注意が必要です。

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

mixed $value, bool $return = false

• mixed $value: エクスポートしたい値
• bool $return = false: trueを指定すると、関数は文字列を返します。false（デフォルト）の場合は、直接出力します。

?string

指定された変数のPHPコード表現を文字列として返します。変数がエクスポートできない場合はNULLを返します。