Changeset 37752

Timestamp:

06/20/2016 08:25:16 AM (8 years ago)

Author:

DrewAPicture

Message:

Docs: Improve the summaries and return descriptions for get_registered_nav_menus() and get_nav_menu_locations().

Props rabmalin for the initial patch.
Fixes #37106.

File:

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

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

@@ -127 +127 @@
 }
 /**
- * Returns all registered navigation menu locations in a theme.
+ * Retrieves all registered navigation menu locations in a theme.
  *
  * @since 3.0.0
@@ -133 +133 @@
  * @global array $_wp_registered_nav_menus
  *
- * @return array
+ * @return array Registered navigation menu locations. If none are registered, an empty array.
  */
 function get_registered_nav_menus() {
@@ -143 +143 @@
 
 /**
- * Returns an array with the registered navigation menu locations and the menu assigned to it
- *
- * @since 3.0.0
- * @return array
+ * Retrieves all registered navigation menu locations and the menus assigned to them.
+ *
+ * @since 3.0.0
+ *
+ * @return array Registered navigation menu locations and the menus assigned them.
+ *               If none are registered, an empty array.
  */