<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.info.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.getenv.php',
    1 => 'getenv',
    2 => '获取单个或者全部环境变量',
  ),
  'up' => 
  array (
    0 => 'ref.info.php',
    1 => 'PHP 选项/信息 函数',
  ),
  'prev' => 
  array (
    0 => 'function.get-resources.php',
    1 => 'get_resources',
  ),
  'next' => 
  array (
    0 => 'function.getlastmod.php',
    1 => 'getlastmod',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/info/functions/getenv.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.getenv" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">getenv</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">getenv</span> &mdash; <span class="dc-title">获取单个或者全部环境变量</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.getenv-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>getenv</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$name</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$local_only</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   获取单个或者全部环境变量。
  </p>
  <p class="para">
   使用 <span class="function"><a href="function.phpinfo.php" class="function">phpinfo()</a></span> 你可以看到所有环境变量的列表。
   这些变量很多都在 <a href="https://datatracker.ietf.org/doc/html/rfc3875" class="link external">&raquo;&nbsp;RFC 3875</a> 的范围之内，
   尤其是章节4.1，&quot;Request Meta-Variables&quot;。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.getenv-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">name</code></dt>
     <dd>
      <p class="para">
       <span class="type"><a href="language.types.string.php" class="type string">string</a></span> 形式的变量名或为 <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>。
      </p>
     </dd>
    
    
     <dt><code class="parameter">local_only</code></dt>
     <dd>
      <p class="para">
       当设置为 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> 时，仅返回由操作系统或 <span class="function"><a href="function.putenv.php" class="function">putenv()</a></span>
       设置的本地环境变量。这只在 <code class="parameter">name</code> 是 <span class="type"><a href="language.types.string.php" class="type string">string</a></span> 时才生效。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.getenv-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   返回环境变量 <code class="parameter">name</code> 的值，如果环境变量 <code class="parameter">name</code>
   不存在则返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。如果 <code class="parameter">name</code> 是 <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>，则所有环境变量都将作为关联
   <span class="type"><a href="language.types.array.php" class="type array">array</a></span> 返回。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.getenv-changelog">
  <h3 class="title">更新日志</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>版本</th>
      <th>说明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">name</code> 现在可为 null。
      </td>
     </tr>

     <tr>
      <td>7.1.0</td>
      <td>
       现在可以省略 <code class="parameter">name</code> 来检索所有环境变量的关联数组 <span class="type"><a href="language.types.array.php" class="type array">array</a></span>。
      </td>
     </tr>

     <tr>
      <td>7.0.9</td>
      <td>
       添加 <code class="parameter">local_only</code> 参数。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>

 
 <div class="refsect1 examples" id="refsect1-function.getenv-examples">
  <h3 class="title">示例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>示例 #1 <span class="function"><strong>getenv()</strong></span> 示例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// getenv() 使用示例<br /></span><span style="color: #0000BB">$ip </span><span style="color: #007700">= </span><span style="color: #0000BB">getenv</span><span style="color: #007700">(</span><span style="color: #DD0000">'REMOTE_ADDR'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// 或简单仅使用全局变量（$_SERVER 或 $_ENV）<br /></span><span style="color: #0000BB">$ip </span><span style="color: #007700">= </span><span style="color: #0000BB">$_SERVER</span><span style="color: #007700">[</span><span style="color: #DD0000">'REMOTE_ADDR'</span><span style="color: #007700">];<br /><br /></span><span style="color: #FF8000">// 安全地获取环境变量，忽略通过 SAPI 或 putenv 修改的值<br /></span><span style="color: #0000BB">$ip </span><span style="color: #007700">= </span><span style="color: #0000BB">getenv</span><span style="color: #007700">(</span><span style="color: #DD0000">'REMOTE_ADDR'</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">) ?: </span><span style="color: #0000BB">getenv</span><span style="color: #007700">(</span><span style="color: #DD0000">'REMOTE_ADDR'</span><span style="color: #007700">)<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.getenv-notes">
  <h3 class="title">注释</h3>
  <div class="warning"><strong class="warning">警告</strong>
   <p class="para">
    如果 PHP 在诸如 Fast CGI 之类的 SAPI 中运行，则此函数将始终返回由 SAPI 设置的环境变量的值，即使已使用
    <span class="function"><a href="function.putenv.php" class="function">putenv()</a></span> 来设置同名的本地环境变量。使用 <code class="parameter">local_only</code>
    参数返回本地设置的环境变量的值。
   </p>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.getenv-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.putenv.php" class="function" rel="rdfs-seeAlso">putenv()</a> - 设置环境变量的值</span></li>
    <li><span class="function"><a href="function.apache-getenv.php" class="function" rel="rdfs-seeAlso">apache_getenv()</a> - 获取 Apache subprocess_env 变量</span></li>
    <li><a href="language.variables.superglobals.php" class="link">超全局变量</a></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>