PHPのinclude文の作成・使用方法

PHPのinclude文は、外部ファイルの読み込みに使用します。include文の作成・使用方法は、以下のとおりです。

include文の構文を覚える

include文の構文は、以下のとおりです。

PHP

include "ファイル名.php";

ファイル名.phpは、読み込みたいファイルの名前です。ファイル名は、相対パスまたは絶対パスで指定できます。

相対パス
相対パスは、読み込みたいファイルの位置を、現在のファイルの位置を基準に指定します。相対パスの書き方は、以下のとおりです。

PHP
include "function.php";

この場合、読み込みたいファイル function.php は、現在のファイルと同じディレクトリに存在します。

絶対パス
絶対パスは、読み込みたいファイルの位置を、絶対的な位置で指定します。絶対パスの書き方は、以下のとおりです。
PHP

include "/path/to/file.php";

この場合、読み込みたいファイル file.php は、/path/to ディレクトリに存在します。

読み込みたいファイルを用意する

include文で読み込むファイルは、PHPコードのみで構成されている必要があります。HTMLコードやCSSコードを含むファイルを読み込もうとすると、エラーが発生します。

include文を記述する

読み込みたいファイル名を、include文の引数として指定します。

include文を実行する

include文を実行するには、スクリプトを実行します。

include文の例

以下は、include文の例です。

PHP

// 外部ファイル `function.php` を読み込む
include "function.php";

// `sum()` 関数を呼び出す
$result = sum(10, 20);

// `sum()` 関数から返された値を出力する
echo $result; // 30

この例では、まず include 文を使用して、外部ファイル function.php を読み込みます。function.php ファイルには、以下のコードが記載されています。

PHP

// `sum()` 関数の定義
function sum(int $a, int $b) {
  return $a + $b;
}

sum() 関数は、引数として渡された $a と $b の合計を返す関数です。

include 文で function.php ファイルを読み込んだ後、sum() 関数を呼び出すことができます。

この場合、sum() 関数は、10 と 20 の合計を計算し、30 を返します。

include文の注意点

include文で読み込んだファイルは、PHPコードとして解釈されるため、読み込むファイルには PHP コードのみを含めるようにしましょう。

例えば、以下のように、HTML コードを含むファイルを読み込むと、エラーが発生します。

PHP

// HTML コードを含むファイルを読み込む
include "file.html";

この場合、ファイル file.html には、以下の HTML コードが記載されているものとします。

HTML

<!DOCTYPE html>
<html lang="ja">
<head>
  <title>test</title>
</head>
<body>
  <h1>Hello, world!</h1>
</body>
</html>

この場合、include 文で file.html ファイルを読み込むと、以下のエラーが発生します。

PHP Parse error: syntax error, unexpected ‘<!DOCTYPE’ (T_DOCTYPE), expecting variable (T_VARIABLE) or ‘$’ in /path/to/file.php on line 1

PHPのinclude文のまとめ

PHPのinclude文は、外部ファイルの読み込みに使用します。include文の書き方は、以下のとおりです。

PHP

include "ファイル名.php";

ファイル名.phpは、読み込みたいファイルの名前です。ファイル名は、相対パスまたは絶対パスで指定できます。

相対パス

相対パスは、読み込みたいファイルの位置を、現在のファイルの位置を基準に指定します。相対パスの書き方は、以下のとおりです。

PHP

include "function.php";

この場合、読み込みたいファイル function.php は、現在のファイルと同じディレクトリに存在します。

絶対パス

絶対パスは、読み込みたいファイルの位置を、絶対的な位置で指定します。絶対パスの書き方は、以下のとおりです。

PHP

include "/path/to/file.php";

この場合、読み込みたいファイル file.php は、/path/to ディレクトリに存在します。

include文を使用する際は、以下の点に注意しましょう。

ファイル名のスペルミスに注意する
読み込みたいファイルが存在するディレクトリを指定しているか確認する
読み込みたいファイルがPHPコードのみで構成されているか確認する

include文の活用例

include文は、以下の用途に活用できます。

関数やクラスを共通化するために、外部ファイルに定義してinclude文で読み込む
データベースへの接続情報や、ユーザーの設定情報を外部ファイルに保存してinclude文で読み込む
テンプレートファイルを読み込む
ライブラリやフレームワークを読み込む

include文は、PHPの基本的な文法のひとつです。ぜひマスターしておきましょう。