PHP include e require: carregar outros arquivos PHP

include 'header.php'; executa o código de outro arquivo PHP naquele ponto do script, como se ele estivesse colado ali. require 'header.php'; faz o mesmo, mas se o arquivo não puder ser carregado, o require interrompe o script com um erro fatal, enquanto o include só imprime um aviso e continua. O primeiro uso comum é um cabeçalho e um rodapé compartilhados por todas as páginas.

O bloco escreve header.php e footer.php primeiro, para que haja arquivos a incluir. Rode e olhe a aba 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';

Os arquivos incluídos são arquivos PHP comuns: podem conter HTML com tags <?= ?> e enxergam a variável $title definida antes do require. Mude o título e rode de novo; toda página que faz require do cabeçalho receberia uma mudança feita naquele único arquivo.

include ou require

A única diferença é o que acontece quando o arquivo não existe ou não pode ser lido. O include imprime dois avisos, vale false e o script continua:

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

O require imprime o mesmo aviso e depois lança um Error, que encerra o script, a menos que algo o capture:

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

Então use require para tudo sem o que a página não roda (configuração, bibliotecas de funções, arquivos de classe) e include para partes opcionais. Para uma parte que pode legitimamente não existir, verifique antes em vez de depender do aviso:

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

Saída:

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

include_once e require_once

Um arquivo que define uma função ou uma classe só pode ser carregado uma vez: carregá-lo uma segunda vez é um erro fatal, porque a função já existe.

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

Isso acontece assim que dois arquivos fazem cada um require 'helpers.php'. O require_once e o include_once lembram quais arquivos já foram carregados e os pulam na segunda vez, retornando 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";

Saída:

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

Use as formas _once para arquivos que declaram coisas, e o include simples para templates que você quer imprimir mais de uma vez. Em projetos que usam Composer, o autoloader carrega os arquivos de classe para você, então as chamadas require_once para classes praticamente desaparecem; veja Composer.

Retornar um valor de um arquivo incluído

Um return no nível superior de um arquivo incluído para aquele arquivo e devolve um valor para a expressão include ou require. Isso dá um arquivo de configuração limpo: nada de variáveis globais, só um valor que você atribui ao nome que quiser.

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

Saída:

My Shop
shop
bool(false)

Os arquivos de configuração do Laravel (config/app.php, config/database.php e os outros) funcionam assim.

Variáveis e escopo em arquivos incluídos

O código incluído roda no escopo da linha que o inclui. No topo de um script ele enxerga todas as variáveis globais; dentro de uma função, só as variáveis locais dessa função. Essa segunda regra é como funciona um pequeno renderizador de templates: uma função cujas variáveis locais são exatamente as variáveis que o template deve enxergar.

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

A aba Page mostra as duas listas, renderizadas a partir de um único arquivo de template. Como o include roda dentro de render(), o template enxerga $heading e $products, mas não $secret. A forma foreach ... endforeach usada no template é a sintaxe alternativa que o PHP oferece para templates HTML.

Caminhos de include e DIR

Um caminho como 'helper.php' não é resolvido em relação ao arquivo que contém o include. O PHP procura na configuração include_path (que normalmente começa com ., o diretório de trabalho atual) e só depois na pasta do próprio arquivo que inclui. Então, dentro de partials/nav.php, include 'helper.php' pode carregar um helper.php completamente diferente, da raiz do projeto. O __DIR__, o diretório do arquivo atual, elimina a adivinhação:

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

Saída:

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

Escreva todo include como __DIR__ . '/relative/path.php'. O diretório de trabalho depende de como o script foi iniciado (o servidor web, um cron job, a linha de comando a partir de outra pasta), mas o __DIR__ nunca muda.

Nunca inclua um arquivo escolhido pelo usuário

Um primeiro roteador comum lê o nome da página da URL: include $_GET['page'] . '.php';. Isso deixa um visitante escolher qual arquivo do servidor roda, por exemplo ?page=../../config (local file inclusion), e com configurações antigas até um arquivo de outro servidor. Mapeie nomes permitidos para arquivos. Rode o bloco e clique nos links: cada clique executa o script de novo com outro $_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;
}

Só os três nomes em $pages podem chegar ao require; o link ../secret recebe a página "Not found". Ler valores da requisição com segurança é explicado em $_GET e$_POST.