Changeset 35307

Timestamp:

10/20/2015 10:15:11 PM (11 years ago)

Author:

westonruter

Message:

Customizer: Introduce customize_loaded_components filter to allow core components to be disabled.

Also move style rule from customize-nav-menus.css to customize-controls.css so that widgets button is properly styled when nav_menus component is excluded from loading. See [35304]. See #33327.

Props westonruter, DrewAPicture.
Fixes #33552.

Location:

trunk

Files:

• src/wp-admin/css/customize-controls.css (modified) (1 diff)
• src/wp-admin/css/customize-nav-menus.css (modified) (1 diff)
• src/wp-includes/class-wp-customize-manager.php (modified) (1 diff)
• tests/phpunit/tests/customize/manager.php (modified) (1 diff)

trunk/src/wp-admin/css/customize-controls.css

@@ -2 +2 @@
         overflow: hidden;
         -webkit-text-size-adjust: 100%;
+}
+
+button.not-a-button {
+        background: transparent;
+        border: none;
+        -webkit-box-shadow: none;
+        box-shadow: none;
+        -webkit-border-radius: 0;
+        border-radius: 0;
+        outline: 0;
+        padding: 0;
+        margin: 0;
 }
 

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

@@ -613 +613 @@
 }
 
-button.not-a-button {
-        background: transparent;
-        border: none;
-        -webkit-box-shadow: none;
-        box-shadow: none;
-        -webkit-border-radius: 0;
-        border-radius: 0;
-        outline: 0;
-        padding: 0;
-        margin: 0;
-}
-
 #available-menu-items .accordion-section-title button {
         display: block;

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

@@ -192 +192 @@
                 require_once( ABSPATH . WPINC . '/class-wp-customize-section.php' );
                 require_once( ABSPATH . WPINC . '/class-wp-customize-control.php' );
-                require_once( ABSPATH . WPINC . '/class-wp-customize-widgets.php' );
-                require_once( ABSPATH . WPINC . '/class-wp-customize-nav-menus.php' );
-
-                $this->widgets = new WP_Customize_Widgets( $this );
-                $this->nav_menus = new WP_Customize_Nav_Menus( $this );
+
+                /**
+                 * Filter the core Customizer components to load.
+                 *
+                 * This allows Core components to be excluded from being instantiated by
+                 * filtering them out of the array. Note that this filter generally runs
+                 * during the <code>plugins_loaded</code> action, so it cannot be added
+                 * in a theme.
+                 *
+                 * @since 4.4.0
+                 *
+                 * @see WP_Customize_Manager::__construct()
+                 *
+                 * @param array                $components List of core components to load.
+                 * @param WP_Customize_Manager $this       WP_Customize_Manager instance.
+                 */
+                $components = apply_filters( 'customize_loaded_components', array( 'widgets', 'nav_menus' ), $this );
+
+                if ( in_array( 'widgets', $components ) ) {
+                        require_once( ABSPATH . WPINC . '/class-wp-customize-widgets.php' );
+                        $this->widgets = new WP_Customize_Widgets( $this );
+                }
+                if ( in_array( 'nav_menus', $components ) ) {
+                        require_once( ABSPATH . WPINC . '/class-wp-customize-nav-menus.php' );
+                        $this->nav_menus = new WP_Customize_Nav_Menus( $this );
+                }
 
                 add_filter( 'wp_die_handler', array( $this, 'wp_die_handler' ) );

trunk/tests/phpunit/tests/customize/manager.php

@@ -328 +328 @@
                 $this->assertArrayHasKey( 'preview', $data['nonce'] );
         }
+
+        /**
+         * @ticket 33552
+         */
+        function test_customize_loaded_components_filter() {
+                $manager = new WP_Customize_Manager();
+                $this->assertInstanceOf( 'WP_Customize_Widgets', $manager->widgets );
+                $this->assertInstanceOf( 'WP_Customize_Nav_Menus', $manager->nav_menus );
+
+                add_filter( 'customize_loaded_components', array( $this, 'return_array_containing_widgets' ), 10, 2 );
+                $manager = new WP_Customize_Manager();
+                $this->assertInstanceOf( 'WP_Customize_Widgets', $manager->widgets );
+                $this->assertEmpty( $manager->nav_menus );
+                remove_all_filters( 'customize_loaded_components' );
+
+                add_filter( 'customize_loaded_components', array( $this, 'return_array_containing_nav_menus' ), 10, 2 );
+                $manager = new WP_Customize_Manager();
+                $this->assertInstanceOf( 'WP_Customize_Nav_Menus', $manager->nav_menus );
+                $this->assertEmpty( $manager->widgets );
+                remove_all_filters( 'customize_loaded_components' );
+
+                add_filter( 'customize_loaded_components', '__return_empty_array' );
+                $manager = new WP_Customize_Manager();
+                $this->assertEmpty( $manager->widgets );
+                $this->assertEmpty( $manager->nav_menus );
+                remove_all_filters( 'customize_loaded_components' );
+        }
+
+        /**
+         * @see Tests_WP_Customize_Manager::test_customize_loaded_components_filter()
+         *
+         * @param array                $components         Components.
+         * @param WP_Customize_Manager $customize_manager  Manager.
+         *
+         * @return array Components.
+         */
+        function return_array_containing_widgets( $components, $customize_manager ) {
+                $this->assertInternalType( 'array', $components );
+                $this->assertContains( 'widgets', $components );
+                $this->assertContains( 'nav_menus', $components );
+                $this->assertInternalType( 'array', $components );
+                $this->assertInstanceOf( 'WP_Customize_Manager', $customize_manager );
+                return array( 'widgets' );
+        }
+
+        /**
+         * @see Tests_WP_Customize_Manager::test_customize_loaded_components_filter()
+         *
+         * @param array                $components         Components.
+         * @param WP_Customize_Manager $customize_manager  Manager.
+         *
+         * @return array Components.
+         */
+        function return_array_containing_nav_menus( $components, $customize_manager ) {
+                $this->assertInternalType( 'array', $components );
+                $this->assertContains( 'widgets', $components );
+                $this->assertContains( 'nav_menus', $components );
+                $this->assertInternalType( 'array', $components );
+                $this->assertInstanceOf( 'WP_Customize_Manager', $customize_manager );
+                return array( 'nav_menus' );
+        }
 }