Changeset 2223

Timestamp:

12/23/2015 08:25:53 PM (9 years ago)

Author:

coffee2code

Message:

developer.wordpress.org: Show array of arrays notation in nested fashion.

The docblock notation is like that of a hash parameter without a name, which visually had only appeared as an unnamed parameter with all nested elements peer to it.

For an example, see ​https://developer.wordpress.org/reference/classes/wp_date_query/__construct/

File:

• sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php

@@ -1216 +1216 @@
 
             // Handle nested hashes.
-            if ( '{' === $description[0] ) {
-                $description = substr( $description, 1 ) . '<ul class="param-hash">';
+            if ( '{' === $description[0] || '{' === $name ) {
+                $description = ltrim( $description, '{' ) . '<ul class="param-hash">';
                 $skip_closing_li = true;
             } elseif ( '}' === substr( $description, -1 ) ) {
@@ -1238 +1238 @@
                 }
 
-                $new_text .= "<b>'" . substr( $name, 1 ) . "'</b><br /><i><span class='type'>({$type})</span></i> {$description}";
+                // Normalize argument name.
+                if ( $name === '{' ) {
+                    // No name is specified, generally indicating an array of arrays.
+                    $name = '';
+                } else {
+                    // The name is defined as a variable, so remove the leading '$'.
+                    $name = ltrim( $name, '$' );
+                }
+                if ( $name ) {
+                    $new_text .= "<b>'{$name}'</b><br />";
+                }
+                $new_text .= "<i><span class='type'>({$type})</span></i> {$description}";
                 if ( ! $skip_closing_li ) {
                     $new_text .= '</li>';