PHP include e require: caricare altri file PHP

include 'header.php'; esegue il codice di un altro file PHP in quel punto dello script, come se fosse incollato lì. require 'header.php'; fa lo stesso, ma se il file non si può caricare require ferma lo script con un errore fatale mentre include stampa solo un warning e prosegue. Il primo uso abituale è un header e un footer condivisi da tutte le pagine.

Il blocco scrive prima header.php e footer.php, così ci sono dei file da includere. Eseguilo e guarda la scheda 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';

I file inclusi sono normali file PHP: possono contenere HTML con i tag <?= ?>, e vedono la variabile $title impostata prima del require. Cambia il titolo ed eseguilo di nuovo; ogni pagina che include l'header recepirebbe una modifica a quell'unico file.

include vs require

L'unica differenza è cosa succede quando il file manca o non è leggibile. include stampa due warning, vale false e lo script prosegue:

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 stampa lo stesso warning e poi lancia un Error, che termina lo script a meno che qualcosa non lo catturi:

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

Quindi usa require per tutto ciò senza cui la pagina non può girare (configurazione, librerie di funzioni, file di classi) e include per le parti facoltative. Per una parte che può legittimamente mancare, verificala prima invece di affidarti al warning:

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

Output:

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

include_once e require_once

Un file che definisce una funzione o una classe si può caricare una volta sola: caricarlo una seconda volta è un errore fatale, perché la funzione esiste già.

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

Succede appena due file fanno ciascuno require 'helpers.php'. require_once e include_once ricordano quali file sono già stati caricati e li saltano la seconda volta, restituendo 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";

Output:

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

Usa le forme _once per i file che dichiarano qualcosa, e il semplice include per i template che vuoi stampare più di una volta. Nei progetti che usano Composer, l'autoloader carica i file delle classi per te, quindi le chiamate require_once per le classi in gran parte spariscono; vedi Composer.

Restituire un valore da un file incluso

Un return al livello principale di un file incluso ferma quel file e restituisce un valore all'espressione include o require. Ne viene fuori un file di configurazione pulito: nessuna variabile globale, solo un valore che assegni al nome che preferisci.

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

Output:

My Shop
shop
bool(false)

I file di configurazione di Laravel (config/app.php, config/database.php e gli altri) funzionano così.

Variabili e scope nei file inclusi

Il codice incluso viene eseguito nello scope della riga che lo include. In cima a uno script vede ogni variabile globale; dentro una funzione vede solo le variabili locali di quella funzione. Questa seconda regola è il modo in cui funziona un piccolo renderer di template: una funzione le cui variabili locali sono esattamente quelle che il template deve vedere.

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

La scheda Page mostra entrambe le liste, prodotte da un solo file di template. Dato che include viene eseguito dentro render(), il template vede $heading e $products ma non $secret. La forma foreach ... endforeach usata nel template è la sintassi alternativa che PHP offre per i template HTML.

Percorsi degli include e DIR

Un percorso come 'helper.php' non viene risolto rispetto al file che contiene l'include. PHP cerca nell'impostazione include_path (che normalmente inizia con ., la cartella di lavoro corrente) e solo dopo nella cartella del file che include. Quindi dentro partials/nav.php, include 'helper.php' può caricare un helper.php completamente diverso dalla radice del progetto. __DIR__, la cartella del file corrente, elimina l'incertezza:

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

Output:

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

Scrivi ogni include come __DIR__ . '/relative/path.php'. La cartella di lavoro dipende da come è stato avviato lo script (il server web, un cron job, la riga di comando da un'altra cartella), ma __DIR__ non cambia mai.

Non includere mai un file scelto dall'utente

Un classico primo router legge il nome della pagina dall'URL: include $_GET['page'] . '.php';. Questo permette a un visitatore di scegliere quale file del server viene eseguito, per esempio ?page=../../config (local file inclusion), e con vecchie impostazioni persino un file da un altro server. Associa invece i nomi consentiti ai file. Esegui il blocco e clicca i link: ogni clic esegue di nuovo lo script con un diverso $_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;
}

Solo i tre nomi in $pages possono arrivare a require; il link ../secret riceve la pagina "Not found". Leggere in modo sicuro i valori della richiesta è trattato in $_GET e$_POST.