Changeset 38559 for trunk/src/wp-includes/nav-menu-template.php

Timestamp:

09/07/2016 04:14:49 PM (10 years ago)

Author:

johnbillion

Message:

Menus: Correct the docblocks for Walker_Nav_Menu, wp_nav_menu(), and walk_nav_menu_tree().

This corrects the parameter type for the $args and $item parameters passed throughout these functions, class methods, and hooks.

See #24587
See #35206
See #37770

File:

• trunk/src/wp-includes/nav-menu-template.php (modified) (6 diffs)

trunk/src/wp-includes/nav-menu-template.php

@@ -83 +83 @@
          *
          * @param string|null $output Nav menu output to short-circuit with. Default null.
-         * @param object      $args   An object containing wp_nav_menu() arguments.
+         * @param stdClass    $args   An object containing wp_nav_menu() arguments.
          */
         $nav_menu = apply_filters( 'pre_wp_nav_menu', null, $args );
@@ -183 +183 @@
          * @since 3.1.0
          *
-         * @param array  $sorted_menu_items The menu items, sorted by each menu item's menu order.
-         * @param object $args              An object containing wp_nav_menu() arguments.
+         * @param array    $sorted_menu_items The menu items, sorted by each menu item's menu order.
+         * @param stdClass $args              An object containing wp_nav_menu() arguments.
          */
         $sorted_menu_items = apply_filters( 'wp_nav_menu_objects', $sorted_menu_items, $args );
@@ -214 +214 @@
          * @see wp_nav_menu()
          *
-         * @param string $items The HTML list content for the menu items.
-         * @param object $args  An object containing wp_nav_menu() arguments.
+         * @param string   $items The HTML list content for the menu items.
+         * @param stdClass $args  An object containing wp_nav_menu() arguments.
          */
         $items = apply_filters( 'wp_nav_menu_items', $items, $args );
@@ -225 +225 @@
          * @see wp_nav_menu()
          *
-         * @param string $items The HTML list content for the menu items.
-         * @param object $args  An object containing wp_nav_menu() arguments.
+         * @param string   $items The HTML list content for the menu items.
+         * @param stdClass $args  An object containing wp_nav_menu() arguments.
          */
         $items = apply_filters( "wp_nav_menu_{$menu->slug}_items", $items, $args );
@@ -247 +247 @@
          * @see wp_nav_menu()
          *
-         * @param string $nav_menu The HTML content for the navigation menu.
-         * @param object $args     An object containing wp_nav_menu() arguments.
+         * @param string   $nav_menu The HTML content for the navigation menu.
+         * @param stdClass $args     An object containing wp_nav_menu() arguments.
          */
         $nav_menu = apply_filters( 'wp_nav_menu', $nav_menu, $args );
@@ -496 +496 @@
  * @since 3.0.0
  *
- * @param array  $items
- * @param int    $depth
- * @param object $r
- * @return string
+ * @param array    $items The menu items, sorted by each menu item's menu order.
+ * @param int      $depth Depth of the item in reference to parents.
+ * @param stdClass $r     An object containing wp_nav_menu() arguments.
+ * @return string The HTML list content for the menu items.
  */
 function walk_nav_menu_tree( $items, $depth, $r ) {