Changeset 48103 for trunk/src/wp-content/themes/twentynineteen/inc/icon-functions.php

Timestamp:

06/20/2020 11:20:25 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Synchronize and correct the documentation for wp_nav_menu() arguments in bundled themes.

See #49572.

File:

• trunk/src/wp-content/themes/twentynineteen/inc/icon-functions.php (modified) (5 diffs)

trunk/src/wp-content/themes/twentynineteen/inc/icon-functions.php

@@ -32 +32 @@
  * Display SVG icons in social links menu.
  *
- * @param  string  $item_output The menu item output.
- * @param  WP_Post $item        Menu item object.
- * @param  int     $depth       Depth of the menu.
- * @param  object  $args        wp_nav_menu() arguments.
+ * @param string   $item_output The menu item's starting HTML output.
+ * @param WP_Post  $item        Menu item data object.
+ * @param int      $depth       Depth of the menu. Used for padding.
+ * @param stdClass $args        An object of wp_nav_menu() arguments.
  * @return string The menu item output with social icon.
  */
@@ -55 +55 @@
  * Add a dropdown icon to top-level menu items.
  *
- * @param string $output Nav menu item start element.
- * @param object $item   Nav menu item.
- * @param int    $depth  Depth.
- * @param object $args   Nav menu args.
+ * @param string   $item_output The menu item's starting HTML output.
+ * @param WP_Post  $item        Menu item data object.
+ * @param int      $depth       Depth of the menu. Used for padding.
+ * @param stdClass $args        An object of wp_nav_menu() arguments.
  * @return string Nav menu item start element.
- * Add a dropdown icon to top-level menu items
  */
-function twentynineteen_add_dropdown_icons( $output, $item, $depth, $args ) {
+function twentynineteen_add_dropdown_icons( $item_output, $item, $depth, $args ) {
 
     // Only add class to 'top level' items on the 'primary' menu.
     if ( ! isset( $args->theme_location ) || 'menu-1' !== $args->theme_location ) {
-        return $output;
+        return $item_output;
     }
 
@@ -78 +77 @@
 
         // Replace opening <a> with <button>.
-        $output = preg_replace(
+        $item_output = preg_replace(
             '/<a\s.*?>/',
             $link,
-            $output,
+            $item_output,
             1 // Limit.
         );
 
         // Replace closing </a> with </button>.
-        $output = preg_replace(
+        $item_output = preg_replace(
             '#</a>#i',
             '</button>',
-            $output,
+            $item_output,
             1 // Limit.
         );
@@ -98 +97 @@
         $icon = twentynineteen_get_icon_svg( 'keyboard_arrow_down', 24 );
 
-        $output .= sprintf(
+        $item_output .= sprintf(
             '<button class="submenu-expand" tabindex="-1">%s</button>',
             $icon
@@ -104 +103 @@
     }
 
-    return $output;
+    return $item_output;
 }
 add_filter( 'walker_nav_menu_start_el', 'twentynineteen_add_dropdown_icons', 10, 4 );