Changeset 32612

Timestamp:

05/26/2015 10:09:26 PM (10 years ago)

Author:

wonderboymusic

Message:

Fix doc blocks for nav-menu*.php files.

See #32444.

Location:

trunk/src/wp-includes

Files:

• nav-menu-template.php (modified) (6 diffs)
• nav-menu.php (modified) (13 diffs)

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

@@ -195 +195 @@
  *
  * @since 3.0.0
+ *
+ * @staticvar array $menu_id_slugs
  *
  * @param array $args {
@@ -220 +222 @@
  *                                          Uses printf() format with numbered placeholders.
  * }
- * @return mixed Menu output if $echo is false, false if there are no items or no menu was found.
+ * @return object|false|void Menu output if $echo is false, false if there are no items or no menu was found.
  */
 function wp_nav_menu( $args = array() ) {
@@ -430 +432 @@
  * @access private
  * @since 3.0.0
+ *
+ * @global WP_Query   $wp_query
+ * @global WP_Rewrite $wp_rewrite
  *
  * @param array $menu_items The current menu item objects to which to add the class property information.
@@ -652 +657 @@
  * @uses Walker_Nav_Menu to create HTML list content.
  * @since 3.0.0
- * @see Walker::walk() for parameters and return description.
+ *
+ * @param array  $items
+ * @param int    $depth
+ * @param object $r
+ * @return string
  */
 function walk_nav_menu_tree( $items, $depth, $r ) {
@@ -658 +667 @@
     $args = array( $items, $depth, $r );
 
-    return call_user_func_array( array($walker, 'walk'), $args );
+    return call_user_func_array( array( $walker, 'walk' ), $args );
 }
 
@@ -666 +675 @@
  * @since 3.0.1
  * @access private
+ *
+ * @staticvar array $used_ids
+ * @param string $id
+ * @param object $item
+ * @return string
  */
 function _nav_menu_item_id_use_once( $id, $item ) {
     static $_used_ids = array();
-    if ( in_array( $item->ID, $_used_ids ) )
+    if ( in_array( $item->ID, $_used_ids ) ) {
         return '';
+    }
     $_used_ids[] = $item->ID;
     return $id;

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

@@ -14 +14 @@
  *
  * @param string $menu Menu ID, slug, or name.
- * @return mixed false if $menu param isn't supplied or term does not exist, menu object if successful.
+ * @return object|false False if $menu param isn't supplied or term does not exist, menu object if successful.
  */
 function wp_get_nav_menu_object( $menu ) {
@@ -66 +66 @@
  * @since 3.0.0
  *
+ * @global array $_wp_registered_nav_menus
+ *
  * @param array $locations Associative array of menu location identifiers (like a slug) and descriptive text.
  */
@@ -78 +80 @@
 /**
  * Unregisters a navigation menu for a theme.
+ *
+ * @global array $_wp_registered_nav_menus
  *
  * @param string $location The menu location identifier.
@@ -100 +104 @@
  * @since 3.0.0
  *
- * @param string $location Menu location identifier, like a slug.
+ * @param string $location    Menu location identifier, like a slug.
  * @param string $description Menu location descriptive text.
  */
@@ -110 +114 @@
  *
  * @since 3.0.0
+ *
+ * @global array $_wp_registered_nav_menus
+ *
  * @return array
  */
@@ -135 +142 @@
  *
  * @since 3.0.0
+ *
  * @param string $location Menu location identifier.
  * @return bool Whether location has a menu.
@@ -221 +229 @@
  * @since 3.0.0
  *
- * @param int $menu_id The ID of the menu or "0" to create a new menu.
+ * @param int   $menu_id   The ID of the menu or "0" to create a new menu.
  * @param array $menu_data The array of menu data.
  * @return int|WP_Error Menu ID on success, WP_Error object on failure.
@@ -299 +307 @@
  * @since 3.0.0
  *
- * @param int $menu_id The ID of the menu. Required. If "0", makes the menu item a draft orphan.
- * @param int $menu_item_db_id The ID of the menu item. If "0", creates a new menu item.
- * @param array $menu_item_data The menu item's data.
+ * @param int   $menu_id         The ID of the menu. Required. If "0", makes the menu item a draft orphan.
+ * @param int   $menu_item_db_id The ID of the menu item. If "0", creates a new menu item.
+ * @param array $menu_item_data  The menu item's data.
  * @return int|WP_Error The menu item's database ID or WP_Error object on failure.
  */
@@ -487 +495 @@
  * @access private
  *
+ * @global string $_menu_item_sort_prop
+ *
  * @param object $a The first object to compare
  * @param object $b The second object to compare
@@ -523 +533 @@
  */
 function _is_valid_nav_menu_item( $item ) {
-    if ( ! empty( $item->_invalid ) )
-        return false;
-
-    return true;
+    return empty( $item->_invalid );
 }
 
@@ -533 +540 @@
  *
  * @since 3.0.0
+ *
+ * @global string $_menu_item_sort_prop
+ * @staticvar array $fetched
  *
  * @param string $menu Menu name, ID, or slug.
  * @param array  $args Optional. Arguments to pass to {@see get_posts()}.
- * @return mixed $items Array of menu items, otherwise false.
+ * @return false|array $items Array of menu items, otherwise false.
  */
 function wp_get_nav_menu_items( $menu, $args = array() ) {
@@ -783 +793 @@
  * @since 3.0.0
  *
- * @param int $object_id The ID of the original object.
+ * @param int    $object_id   The ID of the original object.
  * @param string $object_type The type of object, such as "taxonomy" or "post_type."
- * @param string $taxonomy If $object_type is "taxonomy", $taxonomy is the name of the tax that $object_id belongs to
+ * @param string $taxonomy    If $object_type is "taxonomy", $taxonomy is the name of the tax that $object_id belongs to
  * @return array The array of menu item IDs; empty array if none;
  */
@@ -869 +879 @@
  * @param string $new_status The new status of the post object.
  * @param string $old_status The old status of the post object.
- * @param object $post The post object being transitioned from one status to another.
- * @return void
+ * @param object $post       The post object being transitioned from one status to another.
  */
 function _wp_auto_add_pages_to_menu( $new_status, $old_status, $post ) {