<?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 => 'ru',
  ),
  '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' => 'ru',
    '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>. Многие из этих переменных описывает
   раздел 4.1. Request Meta-Variables стандарта
   <a href="https://datatracker.ietf.org/doc/html/rfc3875" class="link external">&raquo;&nbsp;RFC 3875</a>.
  </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">
       Функция возвращает только локальные переменные окружения,
       которые установила операционная система или команда putenv, если
       для этого параметра установили значение <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>.
       Параметр повлияет на результат работы функции, только если
       значение параметра <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>
   или <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если переменная окружения <code class="parameter">name</code> не существует.
   Если значение параметра <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> теперь принимает значение <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>.
       </td>
      </tr>

      <tr>
       <td>7.1.0</td>
       <td>
        Теперь, чтобы получить ассоциативный массив (<span class="type"><a href="language.types.array.php" class="type array">array</a></span>) всех
        переменных окружения, параметр <code class="parameter">name</code> можно не указывать.
       </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 /><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">// Надёжно получаем значение переменной окружения независимо от того,<br />// установили ли или нет значение через интерфейс 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 /><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 запустили через интерфейс SAPI наподобие Fast CGI, эта функция будет возвращать
    значения переменных окружения, которые установили через 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</span></li>
    <li><a href="language.variables.superglobals.php" class="link">Суперглобальные переменные</a></li>
   </ul>
  </p>
 </div>


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