Last updated: Fri, 01 Jun 2007

set_include_path

(PHP 4 >= 4.3.0, PHP 5)

set_include_path — Sets the include_path configuration option

Description

string set_include_path ( string $new_include_path )

Sets the include_path configuration option for the duration of the script.

Parameters

new_include_path: The new value for the include_path

Return Values

Returns the old include_path on success or FALSE on failure.

Examples

Example 1815. set_include_path() example


<?php

// Works as of PHP 4.3.0

set_include_path('/inc');



// Works in all PHP versions

ini_set('include_path', '/inc');

?>

Example 1816. Adding to the include path

Making use of the PATH_SEPARATOR constant, it is possible to extend the include path regardless of the operating system.

In this example we add /usr/lib/pear to the end of the existing include_path.


<?php

$path = '/usr/lib/pear';

set_include_path(get_include_path() . PATH_SEPARATOR . $path);

?>


Can be useful to check the value of the constant PATH_SEPARATOR.



if ( ! defined( "PATH_SEPARATOR" ) ) {

  if ( strpos( $_ENV[ "OS" ], "Win" ) !== false )

    define( "PATH_SEPARATOR", ";" );

  else define( "PATH_SEPARATOR", ":" );

}



For older versions of php, PATH_SEPARATOR is not defined.

If it is so, we must check what kind of OS is on the web-server and define PATH_SEPARATOR properly

huuanito at hotmail dot com
16-Jan-2007 01:18


Just a note on koenig at electronova dot net's post:

to be OS independent you'd use  '.PATH_SEPARATOR.' 

in place of :

marc dot jaeger at ti dot ch
04-Dec-2006 10:10


Not shure if it is possible to use wildchars when setting include_path in php.ini [for example include_path=.:/usr/lib/php:/home/*/includes ].

koenig at electronova dot net
02-Oct-2006 04:24


You can also add several paths in one set_include_path separating them by ':'.

ex : set_include_path('/home/mysite/includes1:/home/mysite/includes2')

junya at xs4all dot nl
28-Jan-2005 01:41


When you use .htaccess to set the include path, don't forget Apache directive 'AllowOverride Options' or 'AllowOverride All' is also needed.

df a t dougfelton d o t c o m
25-Jan-2005 03:37


In order to use .htaccess files to set the include path, PHP must be installed as an Apache module. If PHP is compiled as a CGI binary, you can set the include path in a custom php.ini file (if, for example, you're being hosted somewhere and don't have access to the main php.ini file.  Note that custom php.ini files don't affect subdirectories in the way that .htaccess files do, so you'll need to put your custom php.ini file in any subdirectories as well.

r dot s dot goldsmith at far-blue dot co dot uk
08-Dec-2004 11:23


If you want to set the paths php uses to find included files on a directory by directory level, you can do so in Apache's .htaccess file. Add the line:



php_value include_path  "<first path to look>:<second path>:<etc>:."



to the .htaccess file. This will replace any paths set in your environment or the php.ini file so remember to include the path to php's own libraries as, usually, the first option!



V.useful tip given to me by the 'php guy' at Edinburgh Uni's Computing Support.

add a note

set_magic_quotes_runtime

restore_include_path