<!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>[40312] trunk: Customize: Show notice in Widgets panel when there are additional widget areas not rendered in preview.</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/40312">40312</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/40312","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-03-22 19:02:26 +0000 (Wed, 22 Mar 2017)</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'>Customize: Show notice in Widgets panel when there are additional widget areas not rendered in preview.
This extends the existing behavior which only showed a message only when there were no widget areas rendered in the preview. The number of non-rendered widget areas is indicated. Also removes needles deletion of `wp.customize.Widgets.data.l10n` property which hindered plugins.
See <a href="https://core.trac.wordpress.org/ticket/33567">#33567</a>, <a href="https://core.trac.wordpress.org/ticket/33052">#33052</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/39087">#39087</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadmincsscustomizecontrolscss">trunk/src/wp-admin/css/customize-controls.css</a></li>
<li><a href="#trunksrcwpadminjscustomizewidgetsjs">trunk/src/wp-admin/js/customize-widgets.js</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizewidgetsphp">trunk/src/wp-includes/class-wp-customize-widgets.php</a></li>
<li><a href="#trunktestsqunitfixturescustomizewidgetsjs">trunk/tests/qunit/fixtures/customize-widgets.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadmincsscustomizecontrolscss"></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/css/customize-controls.css</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/css/customize-controls.css 2017-03-22 03:51:07 UTC (rev 40311)
+++ trunk/src/wp-admin/css/customize-controls.css 2017-03-22 19:02:26 UTC (rev 40312)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -163,6 +163,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> #customize-controls .customize-info .customize-panel-description.open + .no-widget-areas-rendered-notice {
</span><span class="cx" style="display: block; padding: 0 10px"> border-top: none;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+.no-widget-areas-rendered-notice {
+ font-style: italic;
+}
+.no-widget-areas-rendered-notice p:first-child {
+ margin-top: 0;
+}
+.no-widget-areas-rendered-notice p:last-child {
+ margin-bottom: 0;
+}
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> #customize-controls .customize-info .customize-section-description {
</span><span class="cx" style="display: block; padding: 0 10px"> margin-bottom: 15px;
</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 2017-03-22 03:51:07 UTC (rev 40311)
+++ trunk/src/wp-admin/js/customize-widgets.js 2017-03-22 19:02:26 UTC (rev 40312)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13,7 +13,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Link settings
</span><span class="cx" style="display: block; padding: 0 10px"> api.Widgets.data = _wpCustomizeWidgetsSettings || {};
</span><span class="cx" style="display: block; padding: 0 10px"> l10n = api.Widgets.data.l10n;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- delete api.Widgets.data.l10n;
</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"> * wp.customize.Widgets.WidgetModel
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1577,36 +1576,84 @@
</span><span class="cx" style="display: block; padding: 0 10px"> api.Panel.prototype.ready.call( panel );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> panel.deferred.embedded.done(function() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var panelMetaContainer, noRenderedAreasNotice, shouldShowNotice;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var panelMetaContainer, noticeContainer, updateNotice, getActiveSectionCount, shouldShowNotice;
</ins><span class="cx" style="display: block; padding: 0 10px"> panelMetaContainer = panel.container.find( '.panel-meta' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- noRenderedAreasNotice = $( '<div></div>', {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // @todo This should use the Notifications API introduced to panels. See <https://core.trac.wordpress.org/ticket/38794>.
+ noticeContainer = $( '<div></div>', {
</ins><span class="cx" style="display: block; padding: 0 10px"> 'class': 'no-widget-areas-rendered-notice'
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- noRenderedAreasNotice.append( $( '<em></em>', {
- text: l10n.noAreasRendered
- } ) );
- panelMetaContainer.append( noRenderedAreasNotice );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ panelMetaContainer.append( noticeContainer );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- shouldShowNotice = function() {
- return ( 0 === _.filter( panel.sections(), function( section ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Get the number of active sections in the panel.
+ *
+ * @return {number} Number of active sidebar sections.
+ */
+ getActiveSectionCount = function() {
+ return _.filter( panel.sections(), function( section ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return section.active();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } ).length );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } ).length;
</ins><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">+ /**
+ * Determine whether or not the notice should be displayed.
+ *
+ * @return {boolean}
+ */
+ shouldShowNotice = function() {
+ var activeSectionCount = getActiveSectionCount();
+ if ( 0 === activeSectionCount ) {
+ return true;
+ } else {
+ return activeSectionCount !== api.Widgets.data.registeredSidebars.length;
+ }
+ };
+
+ /**
+ * Update the notice.
+ *
+ * @returns {void}
+ */
+ updateNotice = function() {
+ var activeSectionCount = getActiveSectionCount(), message, nonRenderedAreaCount, registeredAreaCount;
+ noticeContainer.empty();
+
+ registeredAreaCount = api.Widgets.data.registeredSidebars.length;
+ if ( activeSectionCount !== registeredAreaCount ) {
+
+ if ( 0 !== activeSectionCount ) {
+ nonRenderedAreaCount = registeredAreaCount - activeSectionCount;
+ message = ( 1 === nonRenderedAreaCount ? l10n.someAreasShown.singular : l10n.someAreasShown.plural ).replace( '%d', nonRenderedAreaCount );
+ } else {
+ message = ( 1 === registeredAreaCount ? l10n.noAreasShown.singular : l10n.noAreasShown.plural ).replace( '%d', registeredAreaCount );
+ }
+
+ noticeContainer.append( $( '<p></p>', {
+ text: message
+ } ) );
+ noticeContainer.append( $( '<p></p>', {
+ text: l10n.navigatePreview
+ } ) );
+ }
+ };
+ updateNotice();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Set the initial visibility state for rendered notice.
</span><span class="cx" style="display: block; padding: 0 10px"> * Update the visibility of the notice whenever a reflow happens.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- noRenderedAreasNotice.toggle( shouldShowNotice() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ noticeContainer.toggle( shouldShowNotice() );
</ins><span class="cx" style="display: block; padding: 0 10px"> api.previewer.deferred.active.done( function () {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- noRenderedAreasNotice.toggle( shouldShowNotice() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ noticeContainer.toggle( shouldShowNotice() );
</ins><span class="cx" style="display: block; padding: 0 10px"> });
</span><span class="cx" style="display: block; padding: 0 10px"> api.bind( 'pane-contents-reflowed', function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var duration = ( 'resolved' === api.previewer.deferred.active.state() ) ? 'fast' : 0;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ updateNotice();
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( shouldShowNotice() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- noRenderedAreasNotice.slideDown( duration );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ noticeContainer.slideDown( duration );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- noRenderedAreasNotice.slideUp( duration );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ noticeContainer.slideUp( duration );
</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></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 2017-03-22 03:51:07 UTC (rev 40311)
+++ trunk/src/wp-includes/class-wp-customize-widgets.php 2017-03-22 19:02:26 UTC (rev 40312)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -732,10 +732,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'error' => __( 'An error has occurred. Please reload the page and try again.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'widgetMovedUp' => __( 'Widget moved up' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'widgetMovedDown' => __( 'Widget moved down' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'noAreasRendered' => __( 'There are no widget areas on the page shown, however other pages in this theme do have them.' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'navigatePreview' => __( 'You can navigate to other pages on your site while using the Customizer to view and edit the widgets displayed on those pages.' ),
+ 'someAreasShown' => wp_array_slice_assoc(
+ /* translators: placeholder is the number of other widget areas registered */
+ _n_noop(
+ 'Your theme has %d other widget area, but this particular page doesn\'t display it.',
+ 'Your theme has %d other widget areas, but this particular page doesn\'t display them.'
+ ),
+ array( 'singular', 'plural' )
+ ),
+ 'noAreasShown' => wp_array_slice_assoc(
+ /* translators: placeholder is the total number of widget areas registered */
+ _n_noop(
+ 'Your theme has %d widget area, but this particular page doesn\'t display it.',
+ 'Your theme has %d widget areas, but this particular page doesn\'t display them.'
+ ),
+ array( 'singular', 'plural' )
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'reorderModeOn' => __( 'Reorder mode enabled' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'reorderModeOff' => __( 'Reorder mode closed' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'reorderLabelOn' => esc_attr__( 'Reorder widgets' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* translators: placeholder is the count for the number of widgets found */
</ins><span class="cx" style="display: block; padding: 0 10px"> 'widgetsFound' => __( 'Number of widgets found: %d' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'noWidgetsFound' => __( 'No widgets found.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span></span></pre></div>
<a id="trunktestsqunitfixturescustomizewidgetsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/customize-widgets.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/customize-widgets.js 2017-03-22 03:51:07 UTC (rev 40311)
+++ trunk/tests/qunit/fixtures/customize-widgets.js 2017-03-22 19:02:26 UTC (rev 40312)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -46,13 +46,27 @@
</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"> 'l10n': {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'error': 'An error has occurred. Please reload the page and try again.',
+ 'navigatePreview': 'You can navigate to other pages on your site while using the Customizer to view and edit the widgets displayed on those pages.',
+ 'noAreasShown': {
+ 'plural': 'Your theme has %d widget areas, but this particular page doesn\'t display them.',
+ 'singular': 'Your theme has %d widget area, but this particular page doesn\'t display it.'
+ },
+ 'noWidgetsFound': 'No widgets found.',
+ 'removeBtnLabel': 'Remove',
+ 'removeBtnTooltip': 'Trash widget by moving it to the inactive widgets sidebar.',
+ 'reorderLabelOn': 'Reorder widgets',
+ 'reorderModeOff': 'Reorder mode closed',
+ 'reorderModeOn': 'Reorder mode enabled',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'saveBtnLabel': 'Apply',
</span><span class="cx" style="display: block; padding: 0 10px"> 'saveBtnTooltip': 'Save and preview changes before publishing them.',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'removeBtnLabel': 'Remove',
- 'removeBtnTooltip': 'Trash widget by moving it to the inactive widgets sidebar.',
- 'error': 'An error has occurred. Please reload the page and try again.',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'someAreasShown': {
+ 'plural': 'Your theme has %d other widget areas, but this particular page doesn\'t display them.',
+ 'singular': 'Your theme has %d other widget area, but this particular page doesn\'t display it.'
+ },
+ 'widgetMovedDown': 'Widget moved down',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'widgetMovedUp': 'Widget moved up',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'widgetMovedDown': 'Widget moved down'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'widgetsFound': 'Number of widgets found: %d'
</ins><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> 'tpl': {
</span><span class="cx" style="display: block; padding: 0 10px"> 'widgetReorderNav': '<div class="widget-reorder-nav"><span class="move-widget" tabindex="0">Move to another area…</span><span class="move-widget-down" tabindex="0">Move down</span><span class="move-widget-up" tabindex="0">Move up</span></div>',
</span></span></pre>
</div>
</div>
</body>
</html>