Changeset 40969

Timestamp:

06/30/2017 04:48:20 AM (8 years ago)

Author:

DrewAPicture

Message:

Docs: Clarify accepted types and values for $menu parameters in several contexts:

• wp_nav_menu()
• wp_get_nav_menu_object() and its filter wp_get_nav_menu_object
• is_nav_menu()
• wp_delete_nav_menu()
• wp_get_nav_menu_items()

Props dimadin.
Fixes #38166.

Location:

trunk/src/wp-includes

Files:

• nav-menu-template.php (modified) (1 diff)
• nav-menu.php (modified) (5 diffs)

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

@@ -22 +22 @@
  *     Optional. Array of nav menu arguments.
  *
- *     @type int|string|WP_Term $menu            Desired menu. Accepts (matching in order) id, slug, name, menu object. Default empty.
+ *     @type int|string|WP_Term $menu            Desired menu. Accepts a menu ID, slug, name, or object. Default empty.
  *     @type string             $menu_class      CSS class to use for the ul element which forms the menu. Default 'menu'.
  *     @type string             $menu_id         The ID that is applied to the ul element which forms the menu.

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

@@ -13 +13 @@
  * @since 3.0.0
  *
- * @param int|string|WP_Term $menu Menu ID, slug, or name - or the menu object.
+ * @param int|string|WP_Term $menu Menu ID, slug, name, or object.
  * @return WP_Term|false False if $menu param isn't supplied or term does not exist, menu object if successful.
  */
@@ -44 +44 @@
      * @since 4.3.0
      *
-     * @param object|false $menu_obj Term from nav_menu taxonomy, or false if nothing had been found.
-     * @param string       $menu     The menu ID, slug, or name passed to wp_get_nav_menu_object().
+     * @param WP_Term|false      $menu_obj Term from nav_menu taxonomy, or false if nothing had been found.
+     * @param int|string|WP_Term $menu     The menu ID, slug, name, or object passed to wp_get_nav_menu_object().
      */
     return apply_filters( 'wp_get_nav_menu_object', $menu_obj, $menu );
@@ -57 +57 @@
  * @since 3.0.0
  *
- * @param int|string $menu The menu to check (ID, slug, or name).
+ * @param int|string|WP_Term $menu Menu ID, slug, name, or object of menu to check.
  * @return bool Whether the menu exists.
  */
@@ -217 +217 @@
  * @since 3.0.0
  *
- * @param string $menu Menu ID, slug, or name.
+ * @param int|string|WP_Term $menu Menu ID, slug, name, or object.
  * @return bool|WP_Error True on success, false or WP_Error object on failure.
  */
@@ -587 +587 @@
  * @staticvar array $fetched
  *
- * @param string $menu Menu name, ID, or slug.
- * @param array  $args {
+ * @param int|string|WP_Term $menu Menu ID, slug, name, or object.
+ * @param array              $args {
  *     Optional. Arguments to pass to get_posts().
  *