PHPのincludeとrequire：ほかのPHPファイルを読み込む

include 'header.php';は、スクリプトのその場所で、貼り付けたかのようにほかのPHPファイルのコードを実行します。require 'header.php';も同じことをしますが、ファイルを読み込めないとき、requireは致命的エラーでスクリプトを止め、includeは警告を表示するだけで続けます。最初によく使うのは、すべてのページで共有するヘッダーとフッターです。

このブロックは、includeするファイルがあるよう先にheader.phpとfooter.phpを書き出します。実行してPageタブを見てください。

<?php
file_put_contents('header.php', <<<'PHP'
<!doctype html>
<html>
<head><title><?= $title ?></title></head>
<body style="font-family: sans-serif">
<nav><a href="?">Home</a> | <a href="?">Shop</a> | <a href="?">Contact</a></nav>
<hr>
PHP);

file_put_contents('footer.php', <<<'PHP'
<hr>
<footer>&copy; <?= date('Y') ?> My Shop</footer>
</body>
</html>
PHP);

$title = 'Welcome';
require 'header.php';
?>
<h1><?= $title ?></h1>
<p>This page is made of three files: header.php, this script, and footer.php.</p>
<?php
require 'footer.php';

includeされるファイルは普通のPHPファイルです。<?= ?>タグを含むHTMLを書け、requireの前にセットした$title変数も見えます。タイトルを変えてもう一度実行してみてください。ヘッダーをrequireしているすべてのページが、その1つのファイルの変更を反映します。

includeとrequireの違い

違いは、ファイルがないか読めないときに何が起こるかだけです。includeは2つの警告を表示し、falseに評価され、スクリプトは続きます。

Warning: include(sidebar.php): Failed to open stream: No such file or directory in /home/index.php on line 2

Warning: include(): Failed opening 'sidebar.php' for inclusion (include_path='.:/usr/share/php83') in /home/index.php on line 2

requireは同じ警告を表示してからErrorを投げ、何かがキャッチしない限りスクリプトを終わらせます。

PHP Warning:  require(config.php): Failed to open stream: No such file or directory in /home/index.php on line 2
PHP Fatal error:  Uncaught Error: Failed opening required 'config.php' (include_path='.:/usr/share/php83') in /home/index.php:2

そのため、ページがそれなしでは動かないもの（設定、関数ライブラリ、クラスのファイル）にはrequireを、任意の部分にはincludeを使います。正当に存在しないこともある部分は、警告に頼らず先に確認しましょう。

<?php
file_put_contents('banner.php', '<?php echo "Spring sale: 20% off\n";');

foreach (['banner.php', 'sidebar.php'] as $part) {
    if (is_file($part)) {
        $result = include $part;
        echo "$part included, include returned ";
        var_dump($result);
    } else {
        echo "$part not found, skipped\n";
    }
}

出力：

Spring sale: 20% off
banner.php included, include returned int(1)
sidebar.php not found, skipped

include_onceとrequire_once

関数やクラスを定義するファイルは1回しか読み込めません。関数がすでに存在するので、2回目の読み込みは致命的エラーになります。

Fatal error: Cannot redeclare greet() (previously declared in /home/helpers.php:2) in /home/helpers.php on line 2

これは、2つのファイルがそれぞれrequire 'helpers.php'したとたんに起こります。require_onceとinclude_onceは、どのファイルがすでに読み込まれたかを覚えていて、2回目は飛ばしてtrueを返します。

<?php
file_put_contents('helpers.php', <<<'PHP'
<?php
function greet(string $name): string
{
    return "Hello, $name";
}
PHP);

var_dump(require_once 'helpers.php');   // loaded: 1
var_dump(require_once 'helpers.php');   // already loaded: true, skipped
var_dump(include_once 'helpers.php');   // the same list for both

echo greet('Ada'), "\n";

出力：

int(1)
bool(true)
bool(true)
Hello, Ada

何かを宣言するファイルには_onceの形を使い、2回以上出力したいテンプレートには普通のincludeを使います。Composerを使うプロジェクトではオートローダーがクラスのファイルを読み込んでくれるので、クラスのためのrequire_onceの呼び出しはほとんどなくなります。Composerを参照してください。

includeしたファイルから値を返す

includeしたファイルのトップレベルのreturnは、そのファイルを止め、includeやrequireの式に値を返します。これできれいな設定ファイルが作れます。グローバル変数はなく、好きな名前に代入する値があるだけです。

<?php
file_put_contents('config.php', <<<'PHP'
<?php
return [
    'site'     => 'My Shop',
    'currency' => 'EUR',
    'debug'    => false,
    'db'       => ['host' => 'localhost', 'name' => 'shop'],
];
PHP);

$config = require 'config.php';

echo $config['site'], "\n";
echo $config['db']['name'], "\n";
var_dump($config['debug']);

出力：

My Shop
shop
bool(false)

Laravelの設定ファイル（config/app.php、config/database.phpなど）はこの方法で動いています。

includeしたファイルの変数とスコープ

includeしたコードは、includeした行のスコープで実行されます。スクリプトのトップではすべてのグローバル変数が見え、関数の中ではその関数のローカル変数だけが見えます。2つ目のルールを使えば、小さなテンプレートレンダラーが作れます。テンプレートに見せるべき変数をちょうどローカル変数として持つ関数です。

<?php
file_put_contents('product-list.php', <<<'PHP'
<h2><?= htmlspecialchars($heading) ?></h2>
<ul>
<?php foreach ($products as $name => $price): ?>
    <li><?= htmlspecialchars($name) ?>: <?= number_format($price, 2) ?> EUR</li>
<?php endforeach; ?>
</ul>
<p><?= count($products) ?> products</p>
PHP);

function render(string $template, array $vars): string
{
    extract($vars);       // $vars['heading'] becomes $heading
    ob_start();           // capture the output instead of printing it
    include $template;
    return ob_get_clean();
}

$secret = 'not visible inside the template';

echo render('product-list.php', [
    'heading'  => 'Fruit',
    'products' => ['Apple' => 0.5, 'Mango' => 1.75, 'Cherries' => 4.2],
]);
echo render('product-list.php', [
    'heading'  => 'Tea',
    'products' => ['Sencha' => 6, 'Earl Grey' => 4.5],
]);

Pageタブには、1つのテンプレートファイルから描画された両方のリストが表示されます。includeはrender()の中で実行されるので、テンプレートには$headingと$productsが見えますが、$secretは見えません。テンプレートで使っているforeach ... endforeachの形は、PHPがHTMLテンプレート向けに用意している別の構文です。

includeのパスと__DIR__

'helper.php'のようなパスは、includeを含むファイルからの相対では解決されません。PHPはinclude_pathの設定（ふつうは現在の作業ディレクトリを表す.で始まります）を探し、そのあとでやっとincludeしているファイル自身のフォルダーを探します。そのためpartials/nav.phpの中のinclude 'helper.php'は、プロジェクトのルートにあるまったく別のhelper.phpを読み込むことがあります。現在のファイルのディレクトリを表す__DIR__を使えば、推測の余地がなくなります。

<?php
mkdir('partials');
file_put_contents('helper.php', '<?php echo "loaded the root helper.php\n";');
file_put_contents('partials/helper.php', '<?php echo "loaded partials/helper.php\n";');

file_put_contents('partials/nav.php', <<<'PHP'
<?php
include 'helper.php';                 // searched from the working directory
include __DIR__ . '/helper.php';      // always the file next to nav.php
echo "__DIR__ in nav.php is ", basename(__DIR__), "\n";
PHP);

include 'partials/nav.php';

出力：

loaded the root helper.php
loaded partials/helper.php
__DIR__ in nav.php is partials

すべてのincludeを__DIR__ . '/relative/path.php'の形で書きましょう。作業ディレクトリはスクリプトの起動のされ方（Webサーバー、cronジョブ、別のフォルダーからのコマンドライン）によって変わりますが、__DIR__は決して変わりません。

ユーザーが名前を指定したファイルを決してincludeしない

最初のルーターによくあるのが、URLからページ名を読むinclude $_GET['page'] . '.php';です。これでは訪問者がサーバー上のどのファイルを実行するかを選べてしまいます。たとえば?page=../../config（ローカルファイルインクルージョン）で、古い設定ならほかのサーバーのファイルさえ選べます。代わりに、許可された名前をファイルに対応させましょう。ブロックを実行してリンクをクリックすると、クリックのたびに別の$_GET['page']でスクリプトがもう一度実行されます。

<?php
file_put_contents('home.php', '<h2>Home</h2><p>Welcome to the shop.</p>');
file_put_contents('about.php', '<h2>About</h2><p>We sell fruit since 1999.</p>');
file_put_contents('contact.php', '<h2>Contact</h2><p>hello@example.com</p>');

$pages = [
    'home'    => 'home.php',
    'about'   => 'about.php',
    'contact' => 'contact.php',
];

$page = $_GET['page'] ?? 'home';
$file = $pages[$page] ?? null;
if ($file === null) {
    http_response_code(404);   // before any output, or the header cannot be sent
}
?>
<nav>
    <a href="?page=home">Home</a> |
    <a href="?page=about">About</a> |
    <a href="?page=contact">Contact</a> |
    <a href="?page=../secret">../secret</a>
</nav>
<?php
if ($file === null) {
    echo '<h2>Not found</h2><p>No page called ', htmlspecialchars($page), '.</p>';
} else {
    require __DIR__ . '/' . $file;
}

requireに届くのは$pagesにある3つの名前だけで、../secretのリンクは「Not found」のページになります。リクエストの値を安全に読む方法は$_GETと$_POSTで扱っています。