include、requireのパス指定をdirname(__FILE__)、__DIR__と書く理由

include、requireの一番いいパス指定の仕方の解説

include、requireの一番いいパス指定の仕方

　
PHPのプログラムで、外部ファイルを読み込む際には、require、include、require_once、include_onceを利用します。
　
その際、読み込むファイルのパスの記述の仕方によっては不具合の原因となりますので、不具合を生まない記述をしておく必要があります。
　
具体的には下記の様に指定します。
　

　
なぜこのような指定をするかの解説を行います。
　
　
requireの他、include、require_once、include_onceとありますが、いずれもファイルのパス指定方法は同じですので、ここでは「require」で話を進めていきます。
　
　

require ( dirname ( __FILE__ ) . '/path/file.php')と指定する理由

　
requireのパス指定を上記のようにする理由
　
他のファイルから呼び出された場合でも正確にパスの位置を指示できるようにするため
です。
　
　
下記のような相対パスでの書き方をすることもできますが、この書き方では不具合が発生する場合があるからです。
　require ( './path/file.php');
　
　

include、requireで相対パスが問題を発生させる場合の例

　
　/file_1.php
　/lib.php
　/dir/file_2.php
という構造のファイルがあるとします。
　
　
file_1.php の中身は下記のような内容です。

　
file_2.php の中身は下記のような内容です。

　
この場合、file_1.phpを実行した場合は何の問題もなく実行されます。
ですが、file_2.phpを実行した場合は、下記のエラーが表示され処理が止まります。
　
————-
Warning: require(./lib.php): failed to open stream: No such file or directory in C:\xampp\htdocs\test3.php on line 3
　
Fatal error: require(): Failed opening required ‘./lib.php’ (include_path=’.;C:\xampp\php\PEAR’) in C:\xampp\htdocs\test3.php on line 3
————-
　
エラーになる理由は、requireで呼び込まれる際のパスは、「file_1.php」からのパスではなく、処理が実行されている「file_2.php」からのパスとして処理されるからです。
そのため、「file_1.php」の時のパスは「./lib.php」でいいのですが「file_2.php」の時は「../lib.php」となる必要があるためにエラーとなってしまいます。
　
　

include、requireのパス指定で問題を解消する方法

　
相対パスで指定した場合に発生する問題を解消するための書き方として、下記のいずれかの方法で絶対パスでファイルを指定する必要があるのです。
　

　
　
こうすることで、どこにあるファイルから読み込まれても「dirname ( __FILE__ )」によって「file_1.php」の場所が絶対パスで指定されることになりますので、エラーになることがなくなるのです。
　
また、「__FILE__」などの定数や、「$_SERVER[‘DOCUMENT_ROOT’]」の環境変数を使って絶対パスを指定することで、サーバが変わった場合でも不具合の原因になることを防いでくれます
　
「dirname ( __FILE__ ) と __DIR__の違い」については後述しています。
　
　
ちなみに、ファイルがあるフォルダより親のフォルダを経由して指定する場合は、下記のような指定も可能です。

include、requireでその他のパス指定方法の問題点の解説

絶対パスで指定する場合

　
require ( ‘/root/path/file.php’ );
　
もうすでに先に書いてしまいましたが、このように直接絶対パスで書くことで、相対パスで記述した時のような他のファイルから呼び出された場合の不具合は発生しません。
ですが、サーバが変った場合は、サーバの構成の違いによっては絶対パスが変わってしまう場合がありますので、不具合の原因になります。
　
絶対にサーバが変わらないという場合はこの書き方でも問題ありませんが、わざわざこの方法を採用するメリットがありませんね。
　
　

パスを指定しない指定方法

　
require ( ‘path/file.php’ );
　
相対パスの指定の仕方とあまり変わらないように見えますが、「path」の前の「/」「./」などを書かずに指定する方法も設定できます。
実は、この方法では、相対パスの際に発生したような「file_2.php」から読み込むときのエラーも発生しません。
理由は、パスを指定しないことで PHPが勝手にファイルを探してくれるためです。
　
ですが、この方法は PHPがファイルを探す時間がかかってしまいます。
　
この方法の指定では、php.iniの include_pathに設定してあるディレクトリの中にある「path」ディレクトリから「file.php」を探す処理が実行されます。
そのため、php.iniの include_pathに複数のディレクトリが指定してあるとそれらのディレクトリが検索されますので、その分余計な処理が増えることになります。
　
requireの記述が数ヶ所程度であれば気にする必要がない差だとは思いますが、requireの記述が多いと下記の様に 3倍も処理スピードが変わる場合もあるようです。
　http://dqn.sakusakutto.jp/2013/05/php_require_once_include_once_include_path.html
　
パスを指定するだけで処理が早くなるわけですので、これまた指定しないメリットがありませんね。
　
　

dirname ( __FILE__ ) と __DIR__の違い

　
dirname ( __FILE__ )
と
__DIR__
の実行結果は同じです。
どちらを使っても問題ありませんが「__DIR__」を使っておきましょう。
　
「__DIR__」の方は PHP 5.3から追加されたものです。
そのため、今後は「__DIR__」の書き方が主流になっていくと思いますが、以前に書かれたプログラム、もしくは、それを元にして書かれたプログラムは、今でも「dirname ( __FILE__ )」が使われているということになるのでしょう。
　
ただ、PHP 5.2以前のサーバでも使われるような汎用的なプログラムを作成する場合は「dirname ( __FILE__ )」を使っておくという判断もあるでしょう。
　
　

include や require で読み込んだ値をバッファリングする方法

　
include や requireで読み込むファイルの中に標準出力命令（echoや print）がある場合や HTMLファイルである場合は、include や requireが記述されている場所にそのまま標準出力されてしまいます。
　
そのため、include や requireは記述する場所が固定されてしまいます。
これを自由な場所に編集する方法の一つとして、標準出力をバッファリングする関数 ob_start()が用意されています。
　
このバッファリング関数 ob_start()については「PHP関数ob_start、ob_get_contentsで標準出力をバッファリング・変数に代入」に記事を書いていますので参考にしてください。