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

Timestamp:

10/10/2014 05:13:52 PM (10 years ago)

Author:

DrewAPicture

Message:

Clarify inline documentation for the _is_valid_nav_menu_item() and wp_get_nav_menu_items() in wp-includes/nav-menu.php.

Props morganestes for the initial patch.
Fixes #29914.

File:

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

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

@@ -514 +514 @@
 
 /**
- * Returns if a menu item is valid. Bug #13958
+ * Return if a menu item is valid.
+ *
+ * @link https://core.trac.wordpress.org/ticket/13958
  *
  * @since 3.2.0
  * @access private
  *
- * @param object $menu_item The menu item to check
- * @return bool false if invalid, else true.
+ * @param object $item The menu item to check.
+ * @return bool False if invalid, otherwise true.
  */
 function _is_valid_nav_menu_item( $item ) {
@@ -530 +532 @@
 
 /**
- * Returns all menu items of a navigation menu.
- *
- * @since 3.0.0
- *
- * @param string $menu menu name, id, or slug
- * @param string $args
- * @return mixed $items array of menu items, else false.
+ * Return all menu items of a navigation menu.
+ *
+ * @since 3.0.0
+ *
+ * @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.
  */
 function wp_get_nav_menu_items( $menu, $args = array() ) {