【WordPress】EOF, EOT, EOM, EODとは何か？functions.phpで変数に代入する値を改行する方法｜ヒアドキュメント構文（Hear Doc.)

WordPressを使っているとfunctions.phpなどのPHPファイルの中で「EOF」「EOT」「EOM」「EOD」といった記述を見かけることがあります。

<<<EOTのような形でつかわれています。

ここでは、「EOF」「EOT」「EOM」「EOD」とは何なのか？何を意味しているのかについて、実例を踏まえて解説しています。

「EOF」「EOT」「EOM」「EOD」とは何か？

実は「EOF」「EOT」「EOM」「EOD」はPHPのコードではありません。

PHPのヒアドキュメント構文（Hear Doc.）という構文で、任意の識別子を指定する必要があるのですが、その識別子として一般的によく指定されている値です。

それぞれ以下のような意味をもっています。

「テキストの終わり」「ファイルの終わり」「文章の終わり」などを示しています。

「EOF」「EOT」「EOM」「EOD」をいつ使うのか？

「EOF」「EOT」「EOM」「EOD」などは、PHPのヒアドキュメント構文（Hear Doc.）によく登場します。

PHPのヒアドキュメント構文（Hear Doc.）とは何かというと、変数に代入する値を改行ありで記述することを可能にする大変便利なものです。

例えば、add_meta_in_head関数の中で以下のように使われます。

function add_meta_in_head() {
	$add_codes = <<<EOT
	
	<!-- ここにHTMLタグを追加 -->
	
	EOT;
	echo $add_codes;
}
add_act

なお、上記の関数は変数 $add_codes に入力した値を、echoで出力しています。

ヒアドキュメント構文（Hear Doc.）の書き方

ヒアドキュメント構文（Hear Doc.）は以下のように<<<識別IDと識別IDで囲むことで記述します。

識別IDは、スペースなどを入れない連続した文字で、開始ID名と終了ID名があっていれば、ID名はなんでもOKです。

<?php
class foo {
  $bar = <<<識別ID
  bar
  識別ID;
}
?>

このため、実行内容の意味がわかりやすく視認性が高いものとして、EOT, EOF, EOM, EODなどが用いられます。

（参考）PHP 文字列（ヒアドキュメント）