<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[30329] trunk/src: Customizer: Improve ability to filter active state for widget area Customizer sections.</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/30329">30329</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/30329","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ocean90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-11-13 12:18:01 +0000 (Thu, 13 Nov 2014)</dd>
</dl>

<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/30235">#30235</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjscustomizecontrolsjs">trunk/src/wp-admin/js/customize-controls.js</a></li>
<li><a href="#trunksrcwpadminjscustomizewidgetsjs">trunk/src/wp-admin/js/customize-widgets.js</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizecontrolphp">trunk/src/wp-includes/class-wp-customize-control.php</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizemanagerphp">trunk/src/wp-includes/class-wp-customize-manager.php</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizesectionphp">trunk/src/wp-includes/class-wp-customize-section.php</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizewidgetsphp">trunk/src/wp-includes/class-wp-customize-widgets.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjscustomizecontrolsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/js/customize-controls.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/customize-controls.js       2014-11-13 12:14:15 UTC (rev 30328)
+++ trunk/src/wp-admin/js/customize-controls.js 2014-11-13 12:18:01 UTC (rev 30329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1348,23 +1348,22 @@
</span><span class="cx" style="display: block; padding: 0 10px">                                        return;
</span><span class="cx" style="display: block; padding: 0 10px">                                }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                                /*
+                                * Walk over all panels, sections, and controls and set their
+                                * respective active states to true if the preview explicitly
+                                * indicates as such.
+                                */
</ins><span class="cx" style="display: block; padding: 0 10px">                                 var constructs = {
</span><span class="cx" style="display: block; padding: 0 10px">                                        panel: data.activePanels,
</span><span class="cx" style="display: block; padding: 0 10px">                                        section: data.activeSections,
</span><span class="cx" style="display: block; padding: 0 10px">                                        control: data.activeControls
</span><span class="cx" style="display: block; padding: 0 10px">                                };
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-                               $.each( constructs, function ( type, activeConstructs ) {
-                                       if ( activeConstructs ) {
-                                               $.each( activeConstructs, function ( id, active ) {
-                                                       var construct = api[ type ]( id );
-                                                       if ( construct ) {
-                                                               construct.active( active );
-                                                       }
-                                               } );
-                                       }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         _( constructs ).each( function ( activeConstructs, type ) {
+                                       api[ type ].each( function ( construct, id ) {
+                                               var active = !! ( activeConstructs && activeConstructs[ id ] );
+                                               construct.active( active );
+                                       } );
</ins><span class="cx" style="display: block; padding: 0 10px">                                 } );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px">                         } );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                        this.request = $.ajax( this.previewUrl(), {
</span></span></pre></div>
<a id="trunksrcwpadminjscustomizewidgetsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/js/customize-widgets.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/customize-widgets.js        2014-11-13 12:14:15 UTC (rev 30328)
+++ trunk/src/wp-admin/js/customize-widgets.js  2014-11-13 12:18:01 UTC (rev 30329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1368,11 +1368,54 @@
</span><span class="cx" style="display: block; padding: 0 10px">        } );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         * 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 );
+               }
+       });
+
+       /**
</ins><span class="cx" style="display: block; padding: 0 10px">          * wp.customize.Widgets.SidebarControl
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * Customizer control for widgets.
</span><span class="cx" style="display: block; padding: 0 10px">         * Note that 'sidebar_widgets' must match the WP_Widget_Area_Customize_Control::$type
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         * @since 3.9.0
+        *
</ins><span class="cx" style="display: block; padding: 0 10px">          * @constructor
</span><span class="cx" style="display: block; padding: 0 10px">         * @augments wp.customize.Control
</span><span class="cx" style="display: block; padding: 0 10px">         */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1395,8 +1438,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                 * Update ordering of widget control forms when the setting is updated
</span><span class="cx" style="display: block; padding: 0 10px">                 */
</span><span class="cx" style="display: block; padding: 0 10px">                _setupModel: function() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        var self = this,
-                               registeredSidebar = api.Widgets.registeredSidebars.get( this.params.sidebar_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 var self = this;
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                        this.setting.bind( function( newWidgetIds, oldWidgetIds ) {
</span><span class="cx" style="display: block; padding: 0 10px">                                var widgetFormControls, removedWidgetIds, priority;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1499,13 +1541,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                                } );
</span><span class="cx" style="display: block; padding: 0 10px">                        } );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-                       // 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() );
</del><span class="cx" style="display: block; padding: 0 10px">                 },
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1816,10 +1851,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">                }
</span><span class="cx" style="display: block; padding: 0 10px">        } );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        /**
-        * Extends wp.customizer.controlConstructor with control constructor for
-        * widget_form and sidebar_widgets.
-        */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Register models for custom section and control types
+       $.extend( api.sectionConstructor, {
+               sidebar: api.Widgets.SidebarSection
+       });
</ins><span class="cx" style="display: block; padding: 0 10px">         $.extend( api.controlConstructor, {
</span><span class="cx" style="display: block; padding: 0 10px">                widget_form: api.Widgets.WidgetControl,
</span><span class="cx" style="display: block; padding: 0 10px">                sidebar_widgets: api.Widgets.SidebarControl
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizecontrolphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-customize-control.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-control.php      2014-11-13 12:14:15 UTC (rev 30328)
+++ trunk/src/wp-includes/class-wp-customize-control.php        2014-11-13 12:18:01 UTC (rev 30329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1115,17 +1115,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">                <?php
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        /**
-        * 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 );
-       }
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizemanagerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-customize-manager.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-manager.php      2014-11-13 12:14:15 UTC (rev 30328)
+++ trunk/src/wp-includes/class-wp-customize-manager.php        2014-11-13 12:18:01 UTC (rev 30329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -515,6 +515,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">                }
</span><span class="cx" style="display: block; padding: 0 10px">                foreach ( $this->panels as $id => $panel ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        $settings['activePanels'][ $id ] = $panel->active();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                        foreach ( $panel->sections as $id => $section ) {
+                               $settings['activeSections'][ $id ] = $section->active();
+                       }
</ins><span class="cx" style="display: block; padding: 0 10px">                 }
</span><span class="cx" style="display: block; padding: 0 10px">                foreach ( $this->sections as $id => $section ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        $settings['activeSections'][ $id ] = $section->active();
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizesectionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-customize-section.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-section.php      2014-11-13 12:14:15 UTC (rev 30328)
+++ trunk/src/wp-includes/class-wp-customize-section.php        2014-11-13 12:18:01 UTC (rev 30329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -310,3 +310,54 @@
</span><span class="cx" style="display: block; padding: 0 10px">                <?php
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * 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 );
+       }
+}
</ins></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizewidgetsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-customize-widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-widgets.php      2014-11-13 12:14:15 UTC (rev 30328)
+++ trunk/src/wp-includes/class-wp-customize-widgets.php        2014-11-13 12:18:01 UTC (rev 30329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -468,6 +468,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                                                'description' => $GLOBALS['wp_registered_sidebars'][ $sidebar_id ]['description'],
</span><span class="cx" style="display: block; padding: 0 10px">                                                'priority' => array_search( $sidebar_id, array_keys( $wp_registered_sidebars ) ),
</span><span class="cx" style="display: block; padding: 0 10px">                                                'panel' => 'widgets',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                                                'sidebar_id' => $sidebar_id,
</ins><span class="cx" style="display: block; padding: 0 10px">                                         );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                                        /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -481,7 +482,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">                                         */
</span><span class="cx" style="display: block; padding: 0 10px">                                        $section_args = apply_filters( 'customizer_widgets_section_args', $section_args, $section_id, $sidebar_id );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                        $this->manager->add_section( $section_id, $section_args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                                 $section = new WP_Customize_Sidebar_Section( $this->manager, $section_id, $section_args );
+                                       $this->manager->add_section( $section );
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                                        $control = new WP_Widget_Area_Customize_Control( $this->manager, $setting_id, array(
</span><span class="cx" style="display: block; padding: 0 10px">                                                'section'    => $section_id,
</span></span></pre>
</div>
</div>

</body>
</html>