var_export

関数の概要

var_export は、PHPの変数の内容をPHPコード形式で文字列として出力または返す関数です。この関数を使うことで、変数の状態をコードとして変換できるため、デバッグや設定ファイルの自動生成、データの永続化などに便利です。出力される内容はそのままPHPコードとして使えるため、実際に再利用や保存がしやすくなっています。

パラメータの説明

  • mixed $expression
    出力したい変数。配列やオブジェクト、スカラー値などあらゆる型を渡せます。
  • bool $return（省略可能、デフォルトは false）
    true を指定すると、結果を返り値として返します。false の場合は直接標準出力に出力されます。

戻り値

$return パラメータが true の場合、変数の内容をPHPコードに変換した文字列を返します。false の場合は null を返し、標準出力に直接表示されます。

使用例

基本的な使い方

<?php
$array = ['apple', 'banana', 'cherry'];
var_export($array);
?>

このコードでは配列 $array の内容がPHPコードとして画面に出力されます。出力結果は次のようになります。

array (
  0 => 'apple',
  1 => 'banana',
  2 => 'cherry',
)

出力を文字列として取得する

<?php
$number = 123;
$exported = var_export($number, true);
echo "変数の内容は： " . $exported;
?>

$return に true を渡すことで、出力を文字列として取得し変数 $exported に保存しています。これを使えば、ファイルに書き込むなどの応用が可能です。

複雑な配列も出力できる

<?php
$data = [
    "name" => "山田太郎",
    "age" => 30,
    "hobbies" => ["読書", "サッカー", "プログラミング"]
];
var_export($data);
?>

多次元配列や連想配列もきれいなPHPコード形式で出力されるため、状態の確認や保存に便利です。

関連する関数

  • var_dump – 変数の詳細な情報を表示する。実行時のデバッグに使うことが多い。
  • print_r – 配列やオブジェクトを読みやすく表示するがPHPコード形式ではない。
  • serialize – 変数をシリアライズ形式の文字列に変換。コードとしては使えない。

まとめ

var_export は変数の内容をPHPコードの形式で出力または文字列で取得できる便利な関数です。特に設定データや複雑な配列をファイルに書き出す場合や、変数の状態を再現したいときに役立ちます。var_dump や print_r と使い分けて、より実務で役立つデバッグやデータ管理を行いましょう。

スポンサーリンク