<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.strings.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.parse-str.php',
    1 => 'parse_str',
    2 => 'Разбирает строку как аргументы URL-адреса',
  ),
  'up' => 
  array (
    0 => 'ref.strings.php',
    1 => 'Функции для работы со строками',
  ),
  'prev' => 
  array (
    0 => 'function.ord.php',
    1 => 'ord',
  ),
  'next' => 
  array (
    0 => 'function.print.php',
    1 => 'print',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/strings/functions/parse-str.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.parse-str" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">parse_str</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">parse_str</span> &mdash; <span class="dc-title">Разбирает строку как аргументы URL-адреса</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.parse-str-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>parse_str</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$string</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter reference">&$result</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

  <p class="para rdfs-comment">
   Функция разбирает строку <code class="parameter">string</code> как аргументы URL-адреса
   и заполняет переменную <code class="parameter">result</code> массивом, в котором ключами становятся названия, а значениями — значения аргументов.
   При пропуске параметра <code class="parameter">result</code> функция
   создаст переменные в текущей области видимости.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.parse-str-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">string</code></dt>
     <dd>
      <p class="para">
       Строка в формате аргументов URL-адреса.
      </p>
     </dd>
    
    
     <dt><code class="parameter">result</code></dt>
     <dd>
      <p class="para">
       Переменная по ссылке. Функция заполнит переменную парами
       «ключ — значение», которые извлечёт из строки <code class="parameter">string</code>.
       При пропуске параметра <code class="parameter">result</code>
       каждый ключ станет отдельной переменной в локальной области видимости.
      </p>
      <div class="warning"><strong class="warning">Внимание</strong>
       <p class="para">
        Начиная с PHP 7.2 вызов функции с одним аргументом <em>УСТАРЕЛ</em>;
        разработчики языка <em>НАСТОЯТЕЛЬНО</em> рекомендуют вызывать функцию
        с аргументом <code class="parameter">result</code>.
        С PHP 8.0.0 параметр <code class="parameter">result</code> стал <em>обязательным</em>.
       </p>
      </div>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.parse-str-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция не возвращает значения после выполнения.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.parse-str-changelog">
  <h3 class="title">Список изменений</h3>
  <p class="para">
   <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">result</code> стал обязательным.
      </td>
     </tr>

      <tr>
       <td>7.2.0</td>
       <td>
        Вызов функции <span class="function"><strong>parse_str()</strong></span> без второго аргумента теперь
        выдаёт ошибку уровня <strong><code><a href="errorfunc.constants.php#constant.e-deprecated">E_DEPRECATED</a></code></strong>.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.parse-str-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример разбора аргументов URL-адреса функцией <span class="function"><strong>parse_str()</strong></span></strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$str </span><span style="color: #007700">= </span><span style="color: #DD0000">"first=value&amp;arr[]=foo+bar&amp;arr[]=baz"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Правильный вызов с двумя аргументами<br /></span><span style="color: #0000BB">parse_str</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #0000BB">$output</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$output</span><span style="color: #007700">[</span><span style="color: #DD0000">'first'</span><span style="color: #007700">], </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;  </span><span style="color: #FF8000">// value<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$output</span><span style="color: #007700">[</span><span style="color: #DD0000">'arr'</span><span style="color: #007700">][</span><span style="color: #0000BB">0</span><span style="color: #007700">], </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">; </span><span style="color: #FF8000">// foo bar<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$output</span><span style="color: #007700">[</span><span style="color: #DD0000">'arr'</span><span style="color: #007700">][</span><span style="color: #0000BB">1</span><span style="color: #007700">], </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">; </span><span style="color: #FF8000">// baz</span></span></code></div>
    </div>

   </div>
  </p>
  <p class="para">
   Функция заменит пробелы и точки в названиях аргументов URL-адреса символами подчёркивания
   прежде чем создать ключи массива или локальные переменные,
   поскольку в названия PHP-переменных нельзя включать пробелы или точки.
   Эти же правила относятся к названиям ключей в массиве
   <code class="parameter">result</code> при вызове функции с двумя аргументами.
   <div class="example" id="example-2">
    <p><strong>Пример #2 Пример искажения названия аргумента функцией <span class="function"><strong>parse_str()</strong></span></strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />parse_str</span><span style="color: #007700">(</span><span style="color: #DD0000">"My Value=Something"</span><span style="color: #007700">, </span><span style="color: #0000BB">$output</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$output</span><span style="color: #007700">[</span><span style="color: #DD0000">'My_Value'</span><span style="color: #007700">]; </span><span style="color: #FF8000">// Выводит: Something</span></span></code></div>
    </div>

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

 <div class="refsect1 notes" id="refsect1-function.parse-str-notes">
  <h3 class="title">Примечания</h3>

  <blockquote class="note"><p><strong class="note">Замечание</strong>: 
   <p class="para">
    Директива <a href="info.configuration.php#ini.max-input-vars" class="link">max_input_vars</a> ограничивает количество входных переменных,
    которое обработает функция <span class="function"><strong>parse_str()</strong></span>.
    Превышение предела выдаёт ошибку уровня <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>,
    а переменные за пределами ограничения не добавляются в результат.
    Предустановленное значение директивы <a href="info.configuration.php#ini.max-input-vars" class="link">max_input_vars</a> — 1000.
   </p>
  </p></blockquote>

  <blockquote class="note"><p><strong class="note">Замечание</strong>: 
   <p class="para">
    Перед заполнением массива <code class="parameter">result</code> функция
    декодирует названия и значения аргументов URL-адреса по правилам функции <span class="function"><a href="function.urldecode.php" class="function">urldecode()</a></span>.
    Названия переменных, которые функция создаёт при пропуске второго аргумента, тоже декодируются.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Замечание</strong>: 
   <p class="para">
    Строку аргументов текущего запроса содержит элемент
    <var class="varname"><a href="reserved.variables.server.php" class="classname">$_SERVER['QUERY_STRING']</a></var>.
    Дополнительную информацию о переменных запроса содержит раздел
    «<a href="language.variables.external.php" class="link">Переменные из внешних источников</a>».
   </p>
  </p></blockquote>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.parse-str-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.parse-url.php" class="function" rel="rdfs-seeAlso">parse_url()</a> - Разбирает URL-адрес и возвращает компоненты адреса</span></li>
    <li><span class="function"><a href="function.pathinfo.php" class="function" rel="rdfs-seeAlso">pathinfo()</a> - Возвращает информацию о пути к файлу</span></li>
    <li><span class="function"><a href="function.http-build-query.php" class="function" rel="rdfs-seeAlso">http_build_query()</a> - Генерирует URL-кодированную строку запроса</span></li>
    <li><span class="function"><a href="function.urldecode.php" class="function" rel="rdfs-seeAlso">urldecode()</a> - Декодирует строку, закодированную для безопасного включения в структуру URL-адреса</span></li>
   </ul>
  </p>
 </div>


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