include i require w PHP: dołączanie innych plików PHP

include 'header.php'; wykonuje kod innego pliku PHP w tym miejscu skryptu, tak jakby został tam wklejony. require 'header.php'; robi to samo, ale jeśli pliku nie da się wczytać, require zatrzymuje skrypt krytycznym błędem, a include tylko wypisuje ostrzeżenie i działa dalej. Zwykle pierwszym zastosowaniem jest nagłówek i stopka wspólne dla wszystkich stron.

Blok najpierw zapisuje header.php i footer.php, żeby było co dołączać. Uruchom i spójrz na zakładkę 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';

Dołączone pliki to zwykłe pliki PHP: mogą zawierać HTML ze znacznikami <?= ?> i widzą zmienną $title ustawioną przed require. Zmień tytuł i uruchom ponownie; każda strona, która dołącza nagłówek, odebrałaby zmianę w tym jednym pliku.

include vs require

Jedyna różnica to zachowanie, gdy pliku brakuje lub nie da się go odczytać. include wypisuje dwa ostrzeżenia, daje false, a skrypt działa dalej:

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 wypisuje to samo ostrzeżenie, a potem rzuca Error, który kończy skrypt, jeśli nic go nie złapie:

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

Dlatego używaj require dla wszystkiego, bez czego strona nie zadziała (konfiguracja, biblioteki funkcji, pliki klas), a include dla części opcjonalnych. Dla części, której może zgodnie z założeniem brakować, najpierw sprawdź jej obecność, zamiast polegać na ostrzeżeniu:

<?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";
    }
}

Wynik:

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

include_once i require_once

Plik definiujący funkcję lub klasę można wczytać tylko raz: drugie wczytanie to błąd krytyczny, bo funkcja już istnieje.

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

Dzieje się tak, gdy tylko dwa pliki wykonają require 'helpers.php'. require_once i include_once pamiętają, które pliki zostały już wczytane, i za drugim razem je pomijają, zwracając 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";

Wynik:

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

Używaj form _once dla plików, które coś deklarują, a zwykłego include dla szablonów, które chcesz wypisać więcej niż raz. W projektach używających Composera autoloader wczytuje pliki klas za ciebie, więc wywołania require_once dla klas w większości znikają; zobacz Composer.

Zwracanie wartości z dołączonego pliku

return na najwyższym poziomie dołączonego pliku zatrzymuje ten plik i oddaje wartość wyrażeniu include lub require. Daje to czysty plik konfiguracyjny: bez zmiennych globalnych, tylko wartość, którą przypisujesz do dowolnej nazwy.

<?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']);

Wynik:

My Shop
shop
bool(false)

Tak działają pliki konfiguracyjne Laravela (config/app.php, config/database.php i pozostałe).

Zmienne i zasięg w dołączonych plikach

Dołączony kod wykonuje się w zasięgu linii, która go dołącza. Na górze skryptu widzi każdą zmienną globalną; wewnątrz funkcji widzi tylko zmienne lokalne tej funkcji. Na tej drugiej zasadzie działa malutki renderer szablonów: funkcja, której zmienne lokalne to dokładnie te zmienne, które ma widzieć szablon.

<?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],
]);

Zakładka Page pokazuje obie listy, wyrenderowane z jednego pliku szablonu. Ponieważ include wykonuje się wewnątrz render(), szablon widzi $heading i $products, ale nie $secret. Forma foreach ... endforeach użyta w szablonie to składnia alternatywna, którą PHP oferuje dla szablonów HTML.

Ścieżki dołączania i DIR

Ścieżka taka jak 'helper.php' nie jest rozwiązywana względem pliku zawierającego include. PHP przeszukuje ustawienie include_path (które zwykle zaczyna się od ., bieżącego katalogu roboczego), a dopiero potem własny folder pliku dołączającego. Dlatego wewnątrz partials/nav.php include 'helper.php' może wczytać zupełnie inny helper.php z katalogu głównego projektu. __DIR__, katalog bieżącego pliku, usuwa zgadywanie:

<?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';

Wynik:

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

Pisz każde dołączenie jako __DIR__ . '/relative/path.php'. Katalog roboczy zależy od tego, jak uruchomiono skrypt (serwer WWW, zadanie cron, wiersz poleceń z innego folderu), a __DIR__ nigdy się nie zmienia.

Nigdy nie dołączaj pliku wskazanego przez użytkownika

Częsty pierwszy router czyta nazwę strony z adresu URL: include $_GET['page'] . '.php';. Pozwala to odwiedzającemu wybrać, który plik na serwerze się wykona, na przykład ?page=../../config (local file inclusion), a przy starych ustawieniach nawet plik z innego serwera. Zamiast tego przypisz dozwolone nazwy do plików. Uruchom blok i klikaj linki: każde kliknięcie uruchamia skrypt ponownie z innym $_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;
}

Do require mogą trafić tylko trzy nazwy z $pages; link ../secret dostaje stronę „Not found”. Bezpieczny odczyt wartości z żądania opisuje strona $_GET i$_POST.