<!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>Set an Apache subprocess_env variable</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.apache-response-headers.html">apache_response_headers</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.getallheaders.html">getallheaders</a></div> <div class="up"><a href="ref.apache.html">Apache Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.apache-setenv" class="refentry"> <div class="refnamediv"> <h1 class="refname">apache_setenv</h1> <p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">apache_setenv</span> — <span class="dc-title">Set an Apache subprocess_env variable</span></p> </div> <div class="refsect1 description" id="refsect1-function.apache-setenv-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>apache_setenv</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$variable</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span> [, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$walk_to_top</code><span class="initializer"> = false</span></span> ] )</div> <p class="para rdfs-comment"> <span class="function"><strong>apache_setenv()</strong></span> sets the value of the Apache environment variable specified by <em><code class="parameter">variable</code></em>. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> When setting an Apache environment variable, the corresponding <var class="varname"><var class="varname"><a href="reserved.variables.server.html" class="classname">$_SERVER</a></var></var> variable is not changed. </p> </p></blockquote> </div> <div class="refsect1 parameters" id="refsect1-function.apache-setenv-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">variable</code></em></span> <dd> <p class="para"> The environment variable that's being set. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">value</code></em></span> <dd> <p class="para"> The new <em><code class="parameter">variable</code></em> value. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">walk_to_top</code></em></span> <dd> <p class="para"> Whether to set the top-level variable available to all Apache layers. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.apache-setenv-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.apache-setenv-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4758"> <p><strong>Example #1 Setting an Apache environment variable using <span class="function"><strong>apache_setenv()</strong></span></strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />apache_setenv</span><span style="color: #007700">(</span><span style="color: #DD0000">"EXAMPLE_VAR"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Example Value"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 notes" id="refsect1-function.apache-setenv-notes"> <h3 class="title">Notes</h3> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> <span class="function"><strong>apache_setenv()</strong></span> can be paired up with <span class="function"><a href="function.apache-getenv.html" class="function">apache_getenv()</a></span> across separate pages or for setting variables to pass to Server Side Includes (.shtml) that have been included in PHP scripts. </p> </p></blockquote> </div> <div class="refsect1 seealso" id="refsect1-function.apache-setenv-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.apache-getenv.html" class="function" rel="rdfs-seeAlso">apache_getenv()</a> - Get an Apache subprocess_env variable</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.apache-response-headers.html">apache_response_headers</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.getallheaders.html">getallheaders</a></div> <div class="up"><a href="ref.apache.html">Apache Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>