エス技研

WordPress、CakePHP、PHP、baserCMSなどの Web系システムを中心に情報を提供します!


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

      2017/03/07

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で標準出力をバッファリング・変数に代入」に記事を書いていますので参考にしてください。

 - PHP・Smarty・ECCUBE

GoogleAdwords

GoogleAdwords

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

※入力いただいたコメントは管理者の承認後に掲載されます。

  関連記事

PHPで正規表現の検証には preg_match_allが便利

PHPで正規表現の検証には preg_match_allが便利です。その便利さの使い方の解説です。

AdminerはphpMyAdmin代替のデータベース管理ツール

AdminerはphpMyAdminとほぼ同機能のデータベース管理ツール。PHP 1ファイルのため設置が非常に簡単で軽快に動作し、phpMyAdminの置き換えで使うのも問題なし。

ECCUBEを開発環境から本番ドメインに変更でエラーが・パス変更について

レンタルサーバでサーバ会社から割り当てられたURLで開発し、本番公開時にドメインを当てたらエラーが!そんな場合の対処方法の解説。対処方法は簡単ですが管理画面からは対応不可。

CentOS6、7のPHPを5.3から5.6、7.0、7.1にバージョンアップする手順の解説
CentOS6、7のPHPを5.3から5.6、7.0、7.1にバージョンアップする手順の解説

CentOS6系、7系のPHPバージョンを5.3から5.6、7.0、7.1にアップする作業手順と解説。yum updateコマンドを使い作業時間は約10分。コマンドの解説や引数の意味なども解説しているので役に立つはず。

ECCUBEの問い合わせフォームに任意の値を引数として渡す方法

ECCUBEのお問い合わせフォームに値を固有の情報を送りそれに基づいて処理をする方法を解説。ボタンの設置、受け取り側のテンプレート、プログラムのサンプルソースを提供。

ECCUBEでカード決済NGの受注情報をマイページ購入履歴に表示しない方法解説

ECCUBEでカード決済に失敗しても購入履歴一覧に注文情報(受注情報)が表示される問題への対処方法を解説。受注情報レコードの作成の流れとステイタスについても解説。

PHPパーミッション変更のchmod関数・モードを変数で指定する方法

パーミッション変更関数であるchmod関数の第二引数、ファイルモードの指定に変数を使う場合は8進数に変換するoctdec関数を使って変換します。

Smartyのテンプレート内の処理で計算、加工をする方法

Smartyのテンプレート上で変数を計算する、加工する方法を解説します。

数値文字参照コード変換ツール(HTML特殊文字コード変換ツール)

テキストを数値文字参照コード(特殊文字コード)に変換するツール。テキストを数値文字参照コードに簡単変換。数値文字参照、文字実体参照、特殊文字などの違いも解説。

ECCUBEの管理画面のSSL設定をインストール後に変更する方法

ECCUBEをインストールした後から管理画面のSSL設定を変更する方法を解説します。config.phpファイルのHTTPS_URLとADMIN_FORCE_SSLの値を変更すればOK。