<!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>Get 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-get-version.html">apache_get_version</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apache-lookup-uri.html">apache_lookup_uri</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-getenv" class="refentry">
<div class="refnamediv">
<h1 class="refname">apache_getenv</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">apache_getenv</span> — <span class="dc-title">Get an Apache subprocess_env variable</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.apache-getenv-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>apache_getenv</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$variable</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$walk_to_top</code><span class="initializer"> = <strong><code>FALSE</code></strong></span></span>
] )</div>
<p class="para rdfs-comment">
Retrieve an Apache environment variable specified by
<code class="parameter">variable</code>.
</p>
<p class="para">
This function requires Apache 2 otherwise it's undefined.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.apache-getenv-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">variable</code></dt>
<dd>
<p class="para">
The Apache environment variable
</p>
</dd>
<dt>
<code class="parameter">walk_to_top</code></dt>
<dd>
<p class="para">
Whether to get the top-level variable available to all Apache layers.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.apache-getenv-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The value of the Apache environment variable on success, or <strong><code>FALSE</code></strong> on
failure
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.apache-getenv-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5943">
<p><strong>Example #1 <span class="function"><strong>apache_getenv()</strong></span> example</strong></p>
<div class="example-contents"><p>
The example above shows how to retrieve the value of the Apache
environment variable <var class="varname"><var class="varname">SERVER_ADDR</var></var>.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">apache_getenv</span><span style="color: #007700">(</span><span style="color: #DD0000">"SERVER_ADDR"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$ret</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
42.24.42.240
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.apache-getenv-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.apache-setenv.html" class="function" rel="rdfs-seeAlso">apache_setenv()</a> - Set an Apache subprocess_env variable</span></li>
<li class="member"><span class="function"><a href="function.getenv.html" class="function" rel="rdfs-seeAlso">getenv()</a> - Gets the value of an environment variable</span></li>
<li class="member"><a href="language.variables.superglobals.html" class="link">Superglobals</a></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-get-version.html">apache_get_version</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apache-lookup-uri.html">apache_lookup_uri</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>
