[DOC-CVS] [doc-en] master: Modernise parse_str description (#4556)

Author: Rowan Tommins (IMSoP)
Committer: GitHub (web-flow)
Pusher: Girgias
Date: 2025-05-06T21:40:12+01:00

Commit: https://github.com/php/doc-en/commit/da15b6674ac1900c7d065bd746a04b53d7e963bf
Raw diff: https://github.com/php/doc-en/commit/da15b6674ac1900c7d065bd746a04b53d7e963bf.diff

Modernise parse_str description (#4556)

Most of the text still acted as though "create a bunch of local variables" was the normal behaviour, even though it's been discouraged for years, and isn't even supported in PHP 8.

There were also a few incorrect or questionable uses of markup.

Changed paths:
  M  reference/strings/functions/parse-str.xml


Diff:

diff --git a/reference/strings/functions/parse-str.xml b/reference/strings/functions/parse-str.xml
index 9840d4deafd6..bd8172ee1ca5 100644
--- a/reference/strings/functions/parse-str.xml
+++ b/reference/strings/functions/parse-str.xml
@@ -3,7 +3,7 @@
 <refentry xml:id="function.parse-str" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>parse_str</refname>
-  <refpurpose>Parses the string into variables</refpurpose>
+  <refpurpose>Parse a string as a URL query string</refpurpose>
  </refnamediv>
  
  <refsect1 role="description">
@@ -15,8 +15,9 @@
   </methodsynopsis>
   <para>
    Parses <parameter>string</parameter> as if it were the query string
-   passed via a URL and sets variables in the current scope (or in the array
-   if <parameter>result</parameter> is provided).
+   passed via a URL and sets keys in the provided <parameter>result</parameter>
+   array. If no <parameter>result</parameter> is passed, values are instead
+   set as variables in the current scope.
   </para>
  </refsect1>
 
@@ -36,8 +37,10 @@
      <term><parameter>result</parameter></term>
      <listitem>
       <para>
-       If the second parameter <parameter>result</parameter> is present,
-       variables are stored in this variable as array elements instead.
+       A variable passed by reference, which will be set to an array
+       containing the key-value pairs extracted from <parameter>string</parameter>.
+       If the <parameter>result</parameter> parameter is not passed,
+       a separate variable is set in the local scope for each key.
       </para>
 
       <warning>
@@ -112,9 +115,10 @@ echo $output['arr'][1], PHP_EOL; // baz
    </example>
   </para>
   <para>
-   Because variables in PHP can't have dots and spaces in their names,
-   those are converted to underscores. Same applies to naming of
-   respective key names in case of using this function with
+   Any spaces and dots in parameter names are converted to underscores
+   when creating array keys or local variables.
+   This is because variable names in PHP are not allowed to contain spaces
+   or dots, but applies even when using this function with the recommended
    <parameter>result</parameter> parameter.   
    <example>
     <title><function>parse_str</function> name mangling</title>
@@ -135,7 +139,7 @@ echo $output['My_Value']; // Something
 
   <note>
    <para>
-    <function>parse_str()</function> is affected by the <link linkend="ini.max-input-vars">max_input_vars</link>
+    <function>parse_str</function> is affected by the <link linkend="ini.max-input-vars">max_input_vars</link>
     directive. Exceeding this limit triggers an <constant>E_WARNING</constant>,
     and any variables beyond the limit are not added to the result array.
     The default is 1000; adjust <link linkend="ini.max-input-vars">max_input_vars</link> as needed.
@@ -144,13 +148,14 @@ echo $output['My_Value']; // Something
 
   <note>
    <para>
-    All variables created (or values returned into array if second parameter is set)
-    are already <function>urldecode</function>d.
+    All values populated in the <parameter>result</parameter> array
+    (or variables created if second parameter is not set)
+    are already URL-decoded using the same rules as <function>urldecode</function>.
    </para>
   </note>
   <note>
    <para>
-    To get the current <literal>QUERY_STRING</literal>, you may use the variable
+    To get the query string of the current request, you may use the variable
     <varname>$_SERVER['QUERY_STRING']</varname>.
     Also, you may want to read the section on
     <link linkend="language.variables.external">variables from external