<!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>[51228] trunk: Widgets: Add missing `label` and `description` to Customizer controls.</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 { white-space: pre-line; 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/51228">51228</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/51228","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-06-24 19:19:57 +0000 (Thu, 24 Jun 2021)</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'>Widgets: Add missing `label` and `description` to Customizer controls.
This fixes a bug where the {U+201C}Move To{U+201D} dialogue was empty when a theme has multiple widget areas.
Props kevin940726, noisysocks, hellofromTonya.
Fixes <a href="https://core.trac.wordpress.org/ticket/53487">#53487</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpcustomizewidgetsphp">trunk/src/wp-includes/class-wp-customize-widgets.php</a></li>
<li><a href="#trunktestsphpunittestscustomizewidgetsphp">trunk/tests/phpunit/tests/customize/widgets.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2021-06-24 19:10:32 UTC (rev 51227)
+++ trunk/src/wp-includes/class-wp-customize-widgets.php 2021-06-24 19:19:57 UTC (rev 51228)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -480,8 +480,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->manager,
</span><span class="cx" style="display: block; padding: 0 10px"> $setting_id,
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'section' => $section_id,
- 'sidebar_id' => $sidebar_id,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'section' => $section_id,
+ 'sidebar_id' => $sidebar_id,
+ 'label' => $section_args['title'],
+ 'description' => $section_args['description'],
</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"> } else {
</span></span></pre></div>
<a id="trunktestsphpunittestscustomizewidgetsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/customize/widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/customize/widgets.php 2021-06-24 19:10:32 UTC (rev 51227)
+++ trunk/tests/phpunit/tests/customize/widgets.php 2021-06-24 19:19:57 UTC (rev 51228)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,6 +145,85 @@
</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">+ * Tests the label and description controls when registering sidebars with Customizer.
+ *
+ * @ticket 53487
+ * @dataProvider data_customize_register_control_label_and_description
+ * @covers WP_Customize_Widgets::customize_register
+ */
+ public function test_customize_register_control_label_and_description( $sidebars, $use_classic_widgets, $expected ) {
+ if ( $use_classic_widgets ) {
+ add_filter( 'use_widgets_block_editor', '__return_false' );
+ }
+
+ foreach ( $sidebars as $args ) {
+ register_sidebar( $args );
+ }
+
+ $this->manager->widgets->customize_register();
+
+ $label = array();
+ $description = array();
+ foreach ( array_keys( $sidebars ) as $sidebar_id ) {
+ $control_id = "sidebars_widgets[{$sidebar_id}]";
+ $control = $this->manager->get_control( $control_id );
+ $label[] = $control->label;
+ $description[] = $control->description;
+ }
+
+ $this->assertSame( $expected['label'], $label );
+ $this->assertSame( $expected['description'], $description );
+ }
+
+ public function data_customize_register_control_label_and_description() {
+ return array(
+ 'with widgets block editor' => array(
+ 'sidebars' => array(
+ 'footer-1' => array(
+ 'id' => 'footer-1',
+ 'name' => 'Footer 1',
+ 'description' => 'This is the Footer 1 sidebar.',
+ ),
+ 'footer-2' => array(
+ 'id' => 'footer-2',
+ 'name' => 'Footer 2',
+ 'description' => 'This is the Footer 2 sidebar.',
+ ),
+ ),
+ 'use_classic_widgets' => false,
+ 'expected' => array(
+ 'label' => array( 'Footer 1', 'Footer 2' ),
+ 'description' => array( '', '' ),
+ ),
+ ),
+ 'with classic widgets' => array(
+ 'sidebars' => array(
+ 'classic-1' => array(
+ 'id' => 'classic-1',
+ 'name' => 'Classic 1',
+ 'description' => 'This is the Classic 1 sidebar.',
+ ),
+ 'classic-2' => array(
+ 'id' => 'classic-2',
+ 'name' => 'Classic 2',
+ 'description' => 'This is the Classic 2 sidebar.',
+ ),
+ 'classic-3' => array(
+ 'id' => 'classic-3',
+ 'name' => 'Classic 3',
+ 'description' => 'This is the Classic 3 sidebar.',
+ ),
+ ),
+ 'use_classic_widgets' => true,
+ 'expected' => array(
+ 'label' => array( '', '', '' ),
+ 'description' => array( '', '', '' ),
+ ),
+ ),
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Tests WP_Customize_Widgets::get_selective_refreshable_widgets().
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Customize_Widgets::get_selective_refreshable_widgets()
</span></span></pre>
</div>
</div>
</body>
</html>