Changeset 30329

Timestamp:

11/13/2014 12:18:01 PM (10 years ago)

Author:

ocean90

Message:

Customizer: Improve ability to filter active state for widget area Customizer sections.

• Mark panels, sections, controls as active if preview explicitly indicates.
• Introduce WP_Customize_Sidebar_Section PHP class, and SidebarSection JS class.
• Move logic for determining whether a sidebar section is active from the SidebarControl to SidebarSection.

props westonruter.
fixes #30235.

Location:

trunk/src

Files:

• wp-admin/js/customize-controls.js (modified) (2 diffs)
• wp-admin/js/customize-widgets.js (modified) (5 diffs)
• wp-includes/class-wp-customize-control.php (modified) (1 diff)
• wp-includes/class-wp-customize-manager.php (modified) (1 diff)
• wp-includes/class-wp-customize-section.php (modified) (1 diff)
• wp-includes/class-wp-customize-widgets.php (modified) (2 diffs)

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

@@ -1349 +1349 @@
                 }
 
+                /*
+                 * Walk over all panels, sections, and controls and set their
+                 * respective active states to true if the preview explicitly
+                 * indicates as such.
+                 */
                 var constructs = {
                     panel: data.activePanels,
@@ -1354 +1359 @@
                     control: data.activeControls
                 };
-
-                $.each( constructs, function ( type, activeConstructs ) {
-                    if ( activeConstructs ) {
-                        $.each( activeConstructs, function ( id, active ) {
-                            var construct = api[ type ]( id );
-                            if ( construct ) {
-                                construct.active( active );
-                            }
-                        } );
-                    }
+                _( constructs ).each( function ( activeConstructs, type ) {
+                    api[ type ].each( function ( construct, id ) {
+                        var active = !! ( activeConstructs && activeConstructs[ id ] );
+                        construct.active( active );
+                    } );
                 } );
-
             } );
 

trunk/src/wp-admin/js/customize-widgets.js

@@ -1369 +1369 @@
 
     /**
+     * wp.customize.Widgets.SidebarSection
+     *
+     * Customizer section representing a widget area widget
+     *
+     * @since 4.1.0
+     */
+    api.Widgets.SidebarSection = api.Section.extend({
+
+        /**
+         * Sync the section's active state back to the Backbone model's is_rendered attribute
+         */
+        ready: function () {
+            var section = this, registeredSidebar;
+            api.Section.prototype.ready.call( this );
+            registeredSidebar = api.Widgets.registeredSidebars.get( section.params.sidebarId );
+            section.active.bind( function ( active ) {
+                registeredSidebar.set( 'is_rendered', active );
+            });
+            registeredSidebar.set( 'is_rendered', section.active() );
+        },
+
+        /**
+         * Override Section.isContextuallyActive() to skip considering
+         * SidebarControl  as opposed to a WidgetControl.
+         *
+         * @returns {boolean}
+         */
+        isContextuallyActive: function () {
+            var section, activeCount;
+            section = this;
+            activeCount = 0;
+            _( section.controls() ).each( function ( control ) {
+                if ( control.active() && ! control.extended( api.Widgets.SidebarControl ) ) {
+                    activeCount += 1;
+                }
+            });
+            return ( activeCount !== 0 );
+        }
+    });
+
+    /**
      * wp.customize.Widgets.SidebarControl
      *
@@ -1374 +1415 @@
      * Note that 'sidebar_widgets' must match the WP_Widget_Area_Customize_Control::$type
      *
+     * @since 3.9.0
+     *
      * @constructor
      * @augments wp.customize.Control
@@ -1396 +1439 @@
          */
         _setupModel: function() {
-            var self = this,
-                registeredSidebar = api.Widgets.registeredSidebars.get( this.params.sidebar_id );
+            var self = this;
 
             this.setting.bind( function( newWidgetIds, oldWidgetIds ) {
@@ -1500 +1542 @@
                 } );
             } );
-
-            // Update the model with whether or not the sidebar is rendered
-            self.active.bind( function ( active ) {
-                registeredSidebar.set( 'is_rendered', active );
-                api.section( self.section.get() ).active( active );
-            } );
-            api.section( self.section.get() ).active( self.active() );
         },
 
@@ -1817 +1852 @@
     } );
 
-    /**
-     * Extends wp.customizer.controlConstructor with control constructor for
-     * widget_form and sidebar_widgets.
-     */
+    // Register models for custom section and control types
+    $.extend( api.sectionConstructor, {
+        sidebar: api.Widgets.SidebarSection
+    });
     $.extend( api.controlConstructor, {
         widget_form: api.Widgets.WidgetControl,

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

@@ -1116 +1116 @@
     }
 
-    /**
-     * Whether the current sidebar is rendered on the page.
-     *
-     * @since 4.0.0
-     * @access public
-     *
-     * @return bool Whether sidebar is rendered.
-     */
-    public function active_callback() {
-        return $this->manager->widgets->is_sidebar_rendered( $this->sidebar_id );
-    }
 }
 

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

@@ -516 +516 @@
         foreach ( $this->panels as $id => $panel ) {
             $settings['activePanels'][ $id ] = $panel->active();
+            foreach ( $panel->sections as $id => $section ) {
+                $settings['activeSections'][ $id ] = $section->active();
+            }
         }
         foreach ( $this->sections as $id => $section ) {

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

@@ -311 +311 @@
     }
 }
+
+/**
+ * Customizer section representing widget area (sidebar).
+ *
+ * @package WordPress
+ * @subpackage Customize
+ * @since 4.1.0
+ */
+class WP_Customize_Sidebar_Section extends WP_Customize_Section {
+
+    /**
+     * @since 4.1.0
+     * @access public
+     * @var string
+     */
+    public $type = 'sidebar';
+
+    /**
+     * Unique identifier.
+     *
+     * @since 4.1.0
+     * @access public
+     * @var string
+     */
+    public $sidebar_id;
+
+    /**
+     * Gather the parameters passed to client JavaScript via JSON.
+     *
+     * @since 4.1.0
+     *
+     * @return array The array to be exported to the client as JSON
+     */
+    public function json() {
+        $json = parent::json();
+        $json['sidebarId'] = $this->sidebar_id;
+        return $json;
+    }
+
+    /**
+     * Whether the current sidebar is rendered on the page.
+     *
+     * @since 4.1.0
+     * @access public
+     *
+     * @return bool Whether sidebar is rendered.
+     */
+    public function active_callback() {
+        return $this->manager->widgets->is_sidebar_rendered( $this->sidebar_id );
+    }
+}

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

@@ -469 +469 @@
                         'priority' => array_search( $sidebar_id, array_keys( $wp_registered_sidebars ) ),
                         'panel' => 'widgets',
+                        'sidebar_id' => $sidebar_id,
                     );
 
@@ -482 +483 @@
                     $section_args = apply_filters( 'customizer_widgets_section_args', $section_args, $section_id, $sidebar_id );
 
-                    $this->manager->add_section( $section_id, $section_args );
+                    $section = new WP_Customize_Sidebar_Section( $this->manager, $section_id, $section_args );
+                    $this->manager->add_section( $section );
 
                     $control = new WP_Widget_Area_Customize_Control( $this->manager, $setting_id, array(