Changeset 42034

Timestamp:

10/28/2017 05:47:06 AM (7 years ago)

Author:

westonruter

Message:

Customize: Deprecate nav menu classes that are no longer used, instead of removing them immediately.

• Deprecate PHP classes WP_Customize_New_Menu_Section and WP_Customize_New_Menu_Control.
• Deprecate JS class wp.customize.Menus.NewMenuControl.
• Also introduce wp.customize.Menus.createNavMenu() for logic to create nav menus separately from the logic for handling UI interactions.

Amends [41768].
See #40104, #42364.
Fixes #42357.

Location:

trunk

Files:

• src/wp-admin/js/customize-nav-menus.js (modified) (7 diffs)
• src/wp-includes/class-wp-customize-control.php (modified) (1 diff)
• src/wp-includes/class-wp-customize-manager.php (modified) (2 diffs)
• src/wp-includes/class-wp-customize-section.php (modified) (1 diff)
• src/wp-includes/customize/class-wp-customize-new-menu-control.php (modified) (3 diffs)
• src/wp-includes/customize/class-wp-customize-new-menu-section.php (modified) (3 diffs)
• tests/qunit/wp-admin/js/customize-nav-menus.js (modified) (1 diff)

trunk/src/wp-admin/js/customize-nav-menus.js

@@ -1163 +1163 @@
 
     /**
+     * Create a nav menu setting and section.
+     *
+     * @since 4.9.0
+     *
+     * @param {string} [name=''] Nav menu name.
+     * @returns {wp.customize.Menus.MenuSection} Added nav menu.
+     */
+    api.Menus.createNavMenu = function createNavMenu( name ) {
+        var customizeId, placeholderId, setting;
+        placeholderId = api.Menus.generatePlaceholderAutoIncrementId();
+
+        customizeId = 'nav_menu[' + String( placeholderId ) + ']';
+
+        // Register the menu control setting.
+        setting = api.create( customizeId, customizeId, {}, {
+            type: 'nav_menu',
+            transport: api.Menus.data.settingTransport,
+            previewer: api.previewer
+        } );
+        setting.set( $.extend(
+            {},
+            api.Menus.data.defaultSettingValues.nav_menu,
+            {
+                name: name || ''
+            }
+        ) );
+
+        /*
+         * Add the menu section (and its controls).
+         * Note that this will automatically create the required controls
+         * inside via the Section's ready method.
+         */
+        return api.section.add( new api.Menus.MenuSection( customizeId, {
+            panel: 'nav_menus',
+            title: displayNavMenuName( name ),
+            customizeAction: api.Menus.data.l10n.customizingMenus,
+            priority: 10,
+            menu_id: placeholderId
+        } ) );
+    };
+
+    /**
      * wp.customize.Menus.NewMenuSection
      *
@@ -1340 +1382 @@
                 nameInput = contentContainer.find( '.menu-name-field' ).first(),
                 name = nameInput.val(),
-                menuSection,
-                customizeId,
-                editMenuSection,
-                placeholderId = api.Menus.generatePlaceholderAutoIncrementId();
+                menuSection;
 
             if ( ! name ) {
@@ -1351 +1390 @@
             }
 
-            customizeId = 'nav_menu[' + String( placeholderId ) + ']';
-
-            // Register the menu control setting.
-            api.create( customizeId, customizeId, {}, {
-                type: 'nav_menu',
-                transport: api.Menus.data.settingTransport,
-                previewer: api.previewer
-            } );
-            api( customizeId ).set( $.extend(
-                {},
-                api.Menus.data.defaultSettingValues.nav_menu,
-                {
-                    name: name
-                }
-            ) );
-
-            /*
-             * Add the menu section (and its controls).
-             * Note that this will automatically create the required controls
-             * inside via the Section's ready method.
-             */
-            menuSection = new api.Menus.MenuSection( customizeId, {
-                panel: 'nav_menus',
-                title: displayNavMenuName( name ),
-                customizeAction: api.Menus.data.l10n.customizingMenus,
-                priority: 10,
-                menu_id: placeholderId
-            } );
-            api.section.add( customizeId, menuSection );
+            menuSection = api.Menus.createNavMenu( name );
 
             // Clear name field.
@@ -1391 +1402 @@
                 if ( checkbox.prop( 'checked' ) ) {
                     navMenuLocationSetting = api( 'nav_menu_locations[' + checkbox.data( 'location-id' ) + ']' );
-                    navMenuLocationSetting.set( placeholderId );
+                    navMenuLocationSetting.set( menuSection.params.menu_id );
 
                     // Reset state for next new menu
@@ -1401 +1412 @@
 
             // Focus on the new menu section.
-            editMenuSection = api.section( customizeId );
-            editMenuSection.focus( {
+            menuSection.focus( {
                 completeCallback: function() {
-                    editMenuSection.highlightNewItemButton();
-                }
-            } ); // @todo should we focus on the new menu's control and open the add-items panel? Thinking user flow...
+                    menuSection.highlightNewItemButton();
+                }
+            } );
         },
 
@@ -3009 +3019 @@
 
     /**
+     * wp.customize.Menus.NewMenuControl
+     *
+     * Customizer control for creating new menus and handling deletion of existing menus.
+     * Note that 'new_menu' must match the WP_Customize_New_Menu_Control::$type.
+     *
+     * @constructor
+     * @augments wp.customize.Control
+     * @deprecated 4.9.0 This class is no longer used due to new menu creation UX.
+     */
+    api.Menus.NewMenuControl = api.Control.extend({
+
+        /**
+         * Initialize.
+         *
+         * @deprecated 4.9.0
+         */
+        initialize: function() {
+            if ( 'undefined' !== typeof console && console.warn ) {
+                console.warn( '[DEPRECATED] wp.customize.NewMenuControl will be removed. Please use wp.customize.Menus.createNavMenu() instead.' );
+            }
+            api.Control.prototype.initialize.apply( this, arguments );
+        },
+
+        /**
+         * Set up the control.
+         *
+         * @deprecated 4.9.0
+         */
+        ready: function() {
+            this._bindHandlers();
+        },
+
+        _bindHandlers: function() {
+            var self = this,
+                name = $( '#customize-control-new_menu_name input' ),
+                submit = $( '#create-new-menu-submit' );
+            name.on( 'keydown', function( event ) {
+                if ( 13 === event.which ) { // Enter.
+                    self.submit();
+                }
+            } );
+            submit.on( 'click', function( event ) {
+                self.submit();
+                event.stopPropagation();
+                event.preventDefault();
+            } );
+        },
+
+        /**
+         * Create the new menu with the name supplied.
+         *
+         * @deprecated 4.9.0
+         */
+        submit: function() {
+
+            var control = this,
+                container = control.container.closest( '.accordion-section-new-menu' ),
+                nameInput = container.find( '.menu-name-field' ).first(),
+                name = nameInput.val(),
+                menuSection;
+
+            if ( ! name ) {
+                nameInput.addClass( 'invalid' );
+                nameInput.focus();
+                return;
+            }
+
+            menuSection = api.Menus.createNavMenu( name );
+
+            // Clear name field.
+            nameInput.val( '' );
+            nameInput.removeClass( 'invalid' );
+
+            wp.a11y.speak( api.Menus.data.l10n.menuAdded );
+
+            // Focus on the new menu section.
+            menuSection.focus();
+        }
+    });
+
+    /**
      * Extends wp.customize.controlConstructor with control constructor for
      * menu_location, menu_item, nav_menu, and new_menu.
@@ -3017 +3108 @@
         nav_menu: api.Menus.MenuControl,
         nav_menu_name: api.Menus.MenuNameControl,
+        new_menu: api.Menus.NewMenuControl, // @todo Remove in 5.0. See #42364.
         nav_menu_locations: api.Menus.MenuLocationsControl,
         nav_menu_auto_add: api.Menus.MenuAutoAddControl

trunk/src/wp-includes/class-wp-customize-control.php

@@ -770 +770 @@
 /**
  * WP_Customize_Nav_Menu_Name_Control class.
+ *
+ * As this file is deprecated, it will trigger a deprecation notice if instantiated. In a subsequent
+ * release, the require_once() here will be removed and _deprecated_file() will be called if file is
+ * required at all.
+ *
+ * @deprecated 4.9.0 This file is no longer used due to new menu creation UX.
  */
 require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-name-control.php' );

trunk/src/wp-includes/class-wp-customize-manager.php

@@ -318 +318 @@
         require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-locations-control.php' );
         require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-auto-add-control.php' );
+        require_once( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-control.php' ); // @todo Remove in 5.0. See #42364.
 
         require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menus-panel.php' );
@@ -325 +326 @@
         require_once( ABSPATH . WPINC . '/customize/class-wp-customize-sidebar-section.php' );
         require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-section.php' );
+        require_once( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-section.php' ); // @todo Remove in 5.0. See #42364.
 
         require_once( ABSPATH . WPINC . '/customize/class-wp-customize-custom-css-setting.php' );

trunk/src/wp-includes/class-wp-customize-section.php

@@ -386 +386 @@
 /** WP_Customize_Nav_Menu_Section class */
 require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-section.php' );
+
+/**
+ * WP_Customize_New_Menu_Section class
+ *
+ * As this file is deprecated, it will trigger a deprecation notice if instantiated. In a subsequent
+ * release, the require_once() here will be removed and _deprecated_file() will be called if file is
+ * required at all.
+ *
+ * @deprecated 4.9.0 This file is no longer used due to new menu creation UX.
+ */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-section.php' );

trunk/src/wp-includes/customize/class-wp-customize-new-menu-control.php

@@ -6 +6 @@
  * @subpackage Customize
  * @since 4.4.0
+ * @deprecated 4.9.0 This file is no longer used as of the menu creation UX introduced in #40104.
  */
 
@@ -12 +13 @@
  *
  * @since 4.3.0
+ * @deprecated 4.9.0 This class is no longer used as of the menu creation UX introduced in #40104.
  *
  * @see WP_Customize_Control
@@ -26 +28 @@
 
     /**
+     * Constructor.
+     *
+     * @since 4.9.0
+     *
+     * @param WP_Customize_Manager $manager Manager.
+     * @param string               $id      ID.
+     * @param array                $args    Args.
+     */
+    public function __construct( WP_Customize_Manager $manager, $id, array $args = array() ) {
+        _deprecated_file( basename( __FILE__ ), '4.9.0' ); // @todo Move this outside of class in 5.0, and remove its require_once() from class-wp-customize-control.php. See #42364.
+        parent::__construct( $manager, $id, $args );
+    }
+
+    /**
      * Render the control's content.
      *

trunk/src/wp-includes/customize/class-wp-customize-new-menu-section.php

@@ -6 +6 @@
  * @subpackage Customize
  * @since 4.4.0
+ * @deprecated 4.9.0 This file is no longer used as of the menu creation UX introduced in #40104.
  */
 
@@ -11 +12 @@
  * Customize Menu Section Class
  *
- * Implements the new-menu-ui toggle button instead of a regular section.
- *
  * @since 4.3.0
+ * @deprecated 4.9.0 This class is no longer used as of the menu creation UX introduced in #40104.
  *
  * @see WP_Customize_Section
@@ -26 +26 @@
      */
     public $type = 'new_menu';
+
+    /**
+     * Constructor.
+     *
+     * Any supplied $args override class property defaults.
+     *
+     * @since 4.9.0
+     *
+     * @param WP_Customize_Manager $manager Customizer bootstrap instance.
+     * @param string               $id      An specific ID of the section.
+     * @param array                $args    Section arguments.
+     */
+    public function __construct( WP_Customize_Manager $manager, $id, array $args = array() ) {
+        _deprecated_file( basename( __FILE__ ), '4.9.0' ); // @todo Move this outside of class in 5.0, and remove its require_once() from class-wp-customize-section.php. See #42364.
+        parent::__construct( $manager, $id, $args );
+    }
 
     /**

trunk/tests/qunit/wp-admin/js/customize-nav-menus.js

@@ -114 +114 @@
     // @todo Add tests for api.Menus.MenuAutoAddControl
     // @todo Add tests for api.Menus.MenuControl
-    // @todo Add tests for api.Menus.NewMenuControl
     // @todo Add tests for api.Menus.applySavedData
     // @todo Add tests for api.Menus.focusMenuItemControl
+    // @todo Add tests for api.Menus.createNavMenu
 
     test( 'api.Menus.getMenuControl() should return the expected control', function() {