PHP include и require: подключение других PHP-файлов

include 'header.php'; выполняет код другого PHP-файла в этом месте скрипта, будто он вставлен сюда. require 'header.php'; делает то же самое, но если файл не удаётся загрузить, require останавливает скрипт фатальной ошибкой, а 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';

Подключаемые файлы это обычные PHP-файлы: в них может быть HTML с тегами <?= ?>, и они видят переменную $title, заданную до require. Измените заголовок и запустите снова; изменение в этом одном файле подхватила бы каждая страница, которая подключает шапку.

include и require

Единственная разница в том, что происходит, когда файла нет или его нельзя прочитать. include печатает два предупреждения, возвращает 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

Файл, который объявляет функцию или класс, можно загрузить только один раз: повторная загрузка это фатальная ошибка, потому что функция уже существует.

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

Так происходит, как только два файла делают require 'helpers.php'. require_once и include_once запоминают уже загруженные файлы и при повторе их пропускают, возвращая 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 для файлов, которые что-то объявляют, а обычный include для шаблонов, которые нужно вывести больше одного раза. В проектах с Composer файлы классов загружает автозагрузчик, поэтому вызовы require_once для классов в основном исчезают; смотрите Composer.

Возврат значения из подключённого файла

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 и остальные).

Переменные и область видимости в подключённых файлах

Подключённый код выполняется в области видимости той строки, которая его подключает. В начале скрипта он видит все глобальные переменные; внутри функции только локальные переменные этой функции. На втором правиле построен крошечный шаблонизатор: функция, локальные переменные которой это ровно те переменные, которые должен видеть шаблон.

<?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 показывает оба списка, отрисованные из одного файла шаблона. Поскольку include выполняется внутри render(), шаблон видит $heading и $products, но не $secret. Форма foreach ... endforeach, используемая в шаблоне, это альтернативный синтаксис, который PHP предлагает для HTML-шаблонов.

Пути подключения и DIR

Путь вроде 'helper.php' разрешается не относительно файла, который содержит include. PHP ищет в настройке include_path (которая обычно начинается с ., текущего рабочего каталога) и только потом в папке самого подключающего файла. Поэтому внутри 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

Пишите каждое подключение как __DIR__ . '/relative/path.php'. Рабочий каталог зависит от того, как запущен скрипт (веб-сервер, задача cron, командная строка из другой папки), а __DIR__ не меняется никогда.

Никогда не подключайте файл, имя которого задал пользователь

Частый первый маршрутизатор читает имя страницы из 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; ссылка ../secret получает страницу "Not found". Безопасное чтение значений запроса описано в $_GET и$_POST.