Changeset 41766

Timestamp:

10/05/2017 01:37:39 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Menus: Introduce wp_get_nav_menu_name() to retrieve the name of a navigation menu as set in the admin.

Props markoheijnen, christophherr, SpencerFinnell, wojtek.szkutnik, sagarprajapati, welcher, SergeyBiryukov.
Fixes #13910.

Location:

trunk

Files:

• src/wp-includes/nav-menu.php (modified) (1 diff)
• tests/phpunit/tests/post/nav-menu.php (modified) (1 diff)

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

@@ -183 +183 @@
      */
     return apply_filters( 'has_nav_menu', $has_nav_menu, $location );
+}
+
+/**
+ * Returns the name of a navigation menu.
+ *
+ * @since 4.9.0
+ *
+ * @param string $location Menu location identifier.
+ * @return string Menu name.
+ */
+function wp_get_nav_menu_name( $location ) {
+    $menu_name = '';
+
+    $locations = get_nav_menu_locations();
+
+    if ( isset( $locations[ $location ] ) ) {
+        $menu = wp_get_nav_menu_object( $locations[ $location ] );
+
+        if ( $menu && $menu->name ) {
+            $menu_name = $menu->name;
+        }
+    }
+
+    /**
+     * Filters the navigation menu name being returned.
+     *
+     * @since 4.9.0
+     *
+     * @param string $menu_name Menu name.
+     * @param string $location  Menu location identifier.
+     */
+    return apply_filters( 'wp_get_nav_menu_name', $menu_name, $location );
 }
 

trunk/tests/phpunit/tests/post/nav-menu.php

@@ -157 +157 @@
         $this->assertSame( $term->name, $menu_items[0]->title );
         $this->assertEquals( $t, $menu_items[0]->object_id );
+    }
+
+    /**
+     * @ticket 13910
+     */
+    function test_wp_get_nav_menu_name() {
+        // Register a nav menu location.
+        register_nav_menu( 'primary', 'Primary Navigation' );
+
+        // Create a menu with a title.
+        $menu = wp_create_nav_menu( 'My Menu' );
+
+        // Assign the menu to the `primary` location.
+        $locations = get_nav_menu_locations();
+        $menu_obj = wp_get_nav_menu_object( $menu );
+        $locations['primary'] = $menu_obj->term_id;
+        set_theme_mod( 'nav_menu_locations', $locations );
+
+        $this->assertEquals( 'My Menu', wp_get_nav_menu_name( 'primary' ) );
     }