Arquivo Include PHP

O inclusão do lado do servidor (SSI) é usada para criar funções, cabeçalhos, rodapés ou elementos que podem ser reutilizados em várias páginas.

A instrução include (ou require) obtém todo o texto/código/marcador existente no arquivo especificado e copia para o arquivo que usa a instrução include.

Incluir arquivos é útil, se precisar referenciar o mesmo PHP, HTML ou texto em várias páginas do site.

Instruções include e require do PHP

Através das instruções include ou require, é possível inserir o conteúdo de um arquivo PHP em outro PHP (antes que ele seja executado no servidor).

As instruções include e require são idênticas, exceto no tratamento de erros:

  • require gera um erro fatal (E_COMPILE_ERROR) e para o script
  • include gera apenas avisos (E_WARNING) e o script continua

Portanto, se você quiser continuar executando e fornecer resultados ao usuário, mesmo que o arquivo incluído esteja ausente, use include. De outro modo, em frameworks, CMS ou programação de aplicações PHP complexas, use sempre require para referenciar arquivos críticos na corrente de execução. Isso ajuda a melhorar a segurança e a integridade do aplicativo, em caso de perda acidental de um arquivo crucial.

O include poupa muita trabalho. Isso significa que você pode criar cabeçalhos, rodapés ou menus padrão para todas as páginas. Então, quando precisar atualizar o cabeçalho, você só precisa atualizar o arquivo de cabeçalho incluído.

Sintaxe

include 'filename';

ou

require 'filename';

Exemplo de include PHP

Exemplo 1

Supondo que tenhamos um arquivo de rodapé padrão chamado "footer.php", assim:

<?php
echo "<p>Copyright © 2006-" . date("Y") . " codew3c.com</p>";
?>

Se quiser usar este arquivo de rodapé em uma página, use a instrução include:

<html>
<body>
<h1>Bem-vindo ao nosso site!</h1>
<p>Um texto.</p>
<p>Um texto.</p>
<?php include 'footer.php';?>
</body>
</html>

Exemplo de execução

Exemplo 2

Supondo que tenhamos um arquivo de menu padrão chamado "menu.php":

<?php
echo '<a href="/index.asp">Página Inicial</a> -
<a href="/html/index.asp">Tutorial HTML</a> -
<a href="/css/index.asp">Tutorial CSS</a> -
<a href="/js/index.asp">Tutorial JavaScript</a> -
<a href="/php/index.asp">Tutorial PHP</a>';
?>

Todas as páginas do site usam este arquivo de menu. A prática é a seguinte (usamos um elemento <div> para que possamos facilmente aplicar estilos CSS no futuro):

<html>
<body>
<div class="menu">
<?php include 'menu.php';?>
</div>
<h1>Bem-vindo à minha página inicial!</h1>
<p>Texto.</p>
<p>Mais texto.</p>
</body>
</html>

Exemplo de execução

Exemplo 3

Supondo que tenhamos um arquivo chamado "vars.php", que define algumas variáveis:

<?php
$color='Prata';
$car='Mercedes-Benz轿跑车';
?>

Então, se referenciarmos este arquivo "vars.php", poderemos usar essas variáveis no arquivo de chamada:

<html>
<body>
<h1>Bem-vindo à minha página inicial!</h1>
<?php
include 'vars.php';
echo "Eu tenho um" . $color . $car . ".";
?>
</body>
</html>

Exemplo de execução

include vs. require PHP

A declaração require também é usada para referenciar arquivos no código PHP.

No entanto, há uma grande diferença entre include e require: se uma declaração include for usada para referenciar um arquivo e o PHP não puder encontrá-lo, o script continuará a executar:

Exemplo

<html>
<body>
<h1>Bem-vindo à minha página inicial!</h1>
<?php
include 'noFileExists.php';
echo "Eu tenho um $color $car.";
?>
</body>
</html>

Exemplo de execução

Se usarmos a declaração require para concluir o mesmo caso, a declaração echo não continuará a executar, pois o script será encerrado após o retorno de um erro grave pela declaração require:

Exemplo

<html>
<body>
<h1>Bem-vindo à minha página inicial!</h1>
<?php
require 'noFileExists.php';
echo "Eu tenho um $color $car.";
?>
</body>
</html>

Exemplo de execução

Comentário:

Use require aqui: quando o arquivo é solicitado pelo aplicativo.

Use include aqui: quando o arquivo não é necessário e o aplicativo deve continuar a executar quando o arquivo não for encontrado.