<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Sets the include_path configuration option</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.restore-include-path.html">restore_include_path</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.set-magic-quotes-runtime.html">set_magic_quotes_runtime</a></div> <div class="up"><a href="ref.info.html">PHP Options/Info Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.set-include-path" class="refentry"> <div class="refnamediv"> <h1 class="refname">set_include_path</h1> <p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">set_include_path</span> — <span class="dc-title">Sets the include_path configuration option</span></p> </div> <div class="refsect1 description" id="refsect1-function.set-include-path-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><strong>set_include_path</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$new_include_path</code></span> )</div> <p class="para rdfs-comment"> Sets the <a href="ini.core.html#ini.include-path" class="link">include_path</a> configuration option for the duration of the script. </p> </div> <div class="refsect1 parameters" id="refsect1-function.set-include-path-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">new_include_path</code></em></span> <dd> <p class="para"> The new value for the <a href="ini.core.html#ini.include-path" class="link">include_path</a> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.set-include-path-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the old <a href="ini.core.html#ini.include-path" class="link">include_path</a> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.set-include-path-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-519"> <p><strong>Example #1 <span class="function"><strong>set_include_path()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Works as of PHP 4.3.0<br /></span><span style="color: #0000BB">set_include_path</span><span style="color: #007700">(</span><span style="color: #DD0000">'/usr/lib/pear'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Works in all PHP versions<br /></span><span style="color: #0000BB">ini_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'include_path'</span><span style="color: #007700">, </span><span style="color: #DD0000">'/usr/lib/pear'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> <p class="para"> <div class="example" id="example-520"> <p><strong>Example #2 Adding to the include path</strong></p> <div class="example-contents"><p> Making use of the <strong><code>PATH_SEPARATOR</code></strong> constant, it is possible to extend the include path regardless of the operating system. </p></div> <div class="example-contents"><p> In this example we add <var class="filename">/usr/lib/pear</var> to the end of the existing <em>include_path</em>. </p></div> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$path </span><span style="color: #007700">= </span><span style="color: #DD0000">'/usr/lib/pear'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">set_include_path</span><span style="color: #007700">(</span><span style="color: #0000BB">get_include_path</span><span style="color: #007700">() . </span><span style="color: #0000BB">PATH_SEPARATOR </span><span style="color: #007700">. </span><span style="color: #0000BB">$path</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.set-include-path-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.ini-set.html" class="function" rel="rdfs-seeAlso">ini_set()</a> - Sets the value of a configuration option</span></li> <li class="member"> <span class="function"><a href="function.get-include-path.html" class="function" rel="rdfs-seeAlso">get_include_path()</a> - Gets the current include_path configuration option</span></li> <li class="member"> <span class="function"><a href="function.restore-include-path.html" class="function" rel="rdfs-seeAlso">restore_include_path()</a> - Restores the value of the include_path configuration option</span></li> <li class="member"> <span class="function"><a href="function.include.html" class="function" rel="rdfs-seeAlso">include</a> - include</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.restore-include-path.html">restore_include_path</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.set-magic-quotes-runtime.html">set_magic_quotes_runtime</a></div> <div class="up"><a href="ref.info.html">PHP Options/Info Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>