【PHP入門】ヒアドキュメントの使い方

PHPのヒアドキュメントは複数行の文字列を表現する際に非常に便利な構文です。この記事では、ヒアドキュメントの基本的な使い方から応用的な使い方、さらにはNowdoc構文について紹介します。

ヒアドキュメントの使い方

書式

PHPのヒアドキュメントは、<<<IDで始まり、ID;で終わります。これらの間に複数行の文字列が入ります。IDは任意の文字列を使うことができます。

<<<ID
複数行の文字列
複数行の文字列
複数行の文字列
ID;

基本的な使い方

基本的な使い方は次の通りです。

//変数に代入する例
$str = <<<EOD
朝はギリシャで魚釣り、
夜はベネズエラで鬼ごっこ、
これなーんだ？
EOD;

echo $str;

//echoに渡す例
echo <<<EOD
朝はギリシャで魚釣り、
夜はベネズエラで鬼ごっこ、
これなーんだ？
EOD;

IDの命名規則

PHPのヒアドキュメントのIDに使える文字は次の通りです。

先頭に数字を使うことはできません。

よく使われるIDは次の通りです。

• EOD (End Of Data|Document の略)
• EOF (End Of File の略)
• EOM (End Of Message の略)
• EOT (End Of Text の略)
• END

どんなIDを使ってもいいのですが、3文字のアルファベット大文字を使うのが定番です。このルールに背くと、この業界で生きていくのは難しいとされています（嘘）。

$name = 'ウッカリカサゴ';

$str = <<<EOD
{$name}は、スズキ目メバル科に属する海水魚です。
EOD;

echo $str;

$name = 'ウッカリカサゴ';

$str = <<<EOD
変数 \$name の値は「ウッカリカサゴ」です
EOD;

echo $str;

また、\n（改行）や\t（タブ）のようなエスケープシーケンスを使用するとそれは展開されます。

$str = <<<EOD //コメント
朝はギリシャで魚釣り、
夜はベネズエラで鬼ごっこ、
これなーんだ？
EOD;

$str = <<<EOD
朝はギリシャで魚釣り、
夜はベネズエラで鬼ごっこ、
これなーんだ？ EOD;

$str = <<<EOD
朝はギリシャで魚釣り、
夜はベネズエラで鬼ごっこ、
これなーんだ？
EOD
EOD;

Nowdocの使い方

Nowdocはヒアドキュメントとよく似た構文です。

ヒアドキュメントがダブルクォーテーションで括った場合とほぼ同じように動作するのに対し、Nowdocはシングルクォーテーションで括った場合とほぼ同じ動作をします。

Nowdocの書式はヒアドキュメントとほぼ同じで、唯一の違いは始端IDをシングルクォーテーションで括ることです。終端IDは括りません。

$str = <<<'EOD'
\n は改行を表すエスケープシーケンスです。
\t はタブを表すエスケープシーケンスです。
EOD;

echo $str;

インデントで見やすくする

PHPのバージョン7.3未満では、ヒアドキュメントの終端IDをインデントすることができませんでした。例えば次のように書くとエラーになりました。

if ($flag) {
  $str = <<<EOD
  朝はギリシャで魚釣り、
  夜はベネズエラで鬼ごっこ、
  これなーんだ？
  EOD;
}

なので次のように書かなければなりませんでした。

if ($flag) {
  $str = <<<EOD
朝はギリシャで魚釣り、
夜はベネズエラで鬼ごっこ、
これなーんだ？
EOD;
}

すごく気持ち悪いですね。あなたもコードを見やすくするためにインデントを使っているかと思います。しかし、PHP 7.3未満では終端IDの前にいかなる文字も置くことができなかったため、このように書かなければなりませんでした。これが嫌でヒアドキュメントは使わないという人も多いそうです。

そして、PHP 7.3から終端IDをスペースまたはタブでインデントすることが可能になりました。いえい。しかも、終端IDのインデント幅と同じ分、文字列の各行からインデントが取り除かれるというオシャレ仕様です。

if ($flag) {
  $str = <<<EOD
  朝はギリシャで魚釣り、
  夜はベネズエラで鬼ごっこ、
  これなーんだ？
  EOD;
}

echo $str;

ただし、文字列のインデント幅よりも、終端IDのインデント幅のほうが大きいとエラーになるのでご注意ください。

でわでわ