<!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>[42375] branches/4.9: Widgets: Always try restoring widget assignments</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/42375">42375</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/42375","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>obenland</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-12-07 02:22:55 +0000 (Thu, 07 Dec 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'>Widgets: Always try restoring widget assignments
For code-historic reasons, restoring widget assignments would not be attempted if there were no sidebars to map.
Restoring previous assignments is something unrelated to sidebar mappings however, so now it will be attempted on every theme switch.
Fixes <a href="https://core.trac.wordpress.org/ticket/42719">#42719</a>.
Merges <a href="https://core.trac.wordpress.org/changeset/42374">[42374]</a> to the 4.9 branch.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches49srcwpincludeswidgetsphp">branches/4.9/src/wp-includes/widgets.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches49">branches/4.9/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/4.9
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/4.9 2017-12-07 02:19:11 UTC (rev 42374)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/4.9 2017-12-07 02:22:55 UTC (rev 42375)
</ins><a id="branches49"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/4.9</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.1:18031
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.3:20543
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:18512,42132,42134,42136,42138,42140,42144,42146,42148,42153,42155,42157,42159,42161,42163,42169,42171,42173,42175,42177,42181,42183,42185,42187,42189,42191,42193,42199,42203,42210,42214,42220,42222,42226,42242,42244,42247,42251,42258-42261,42362,42364-42368
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:18512,42132,42134,42136,42138,42140,42144,42146,42148,42153,42155,42157,42159,42161,42163,42169,42171,42173,42175,42177,42181,42183,42185,42187,42189,42191,42193,42199,42203,42210,42214,42220,42222,42226,42242,42244,42247,42251,42258-42261,42362,42364-42368,42374
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches49srcwpincludeswidgetsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/src/wp-includes/widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/src/wp-includes/widgets.php 2017-12-07 02:19:11 UTC (rev 42374)
+++ branches/4.9/src/wp-includes/widgets.php 2017-12-07 02:22:55 UTC (rev 42375)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1180,6 +1180,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Compares a list of sidebars with their widgets against a whitelist.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.9.2 Always tries to restore widget assignments from previous data, not just if sidebars needed mapping.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $existing_sidebars_widgets List of sidebars and their widget instance IDs.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Mapped sidebars widgets.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1222,64 +1223,63 @@
</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">- // If there are no old sidebars left, then we're done.
- if ( empty( $existing_sidebars_widgets ) ) {
- return $new_sidebars_widgets;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If there are more sidebars, try to map them.
+ if ( ! empty( $existing_sidebars_widgets ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * If old and new theme both have sidebars that contain phrases
- * from within the same group, make an educated guess and map it.
- */
- $common_slug_groups = array(
- array( 'sidebar', 'primary', 'main', 'right' ),
- array( 'second', 'left' ),
- array( 'sidebar-2', 'footer', 'bottom' ),
- array( 'header', 'top' ),
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * If old and new theme both have sidebars that contain phrases
+ * from within the same group, make an educated guess and map it.
+ */
+ $common_slug_groups = array(
+ array( 'sidebar', 'primary', 'main', 'right' ),
+ array( 'second', 'left' ),
+ array( 'sidebar-2', 'footer', 'bottom' ),
+ array( 'header', 'top' ),
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Go through each group...
- foreach ( $common_slug_groups as $slug_group ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Go through each group...
+ foreach ( $common_slug_groups as $slug_group ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ...and see if any of these slugs...
- foreach ( $slug_group as $slug ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // ...and see if any of these slugs...
+ foreach ( $slug_group as $slug ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ...and any of the new sidebars...
- foreach ( $wp_registered_sidebars as $new_sidebar => $args ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // ...and any of the new sidebars...
+ foreach ( $wp_registered_sidebars as $new_sidebar => $args ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ...actually match!
- if ( false === stripos( $new_sidebar, $slug ) && false === stripos( $slug, $new_sidebar ) ) {
- continue;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // ...actually match!
+ if ( false === stripos( $new_sidebar, $slug ) && false === stripos( $slug, $new_sidebar ) ) {
+ continue;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Then see if any of the existing sidebars...
- foreach ( $existing_sidebars_widgets as $sidebar => $widgets ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Then see if any of the existing sidebars...
+ foreach ( $existing_sidebars_widgets as $sidebar => $widgets ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ...and any slug in the same group...
- foreach ( $slug_group as $slug ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // ...and any slug in the same group...
+ foreach ( $slug_group as $slug ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ... have a match as well.
- if ( false === stripos( $sidebar, $slug ) && false === stripos( $slug, $sidebar ) ) {
- continue;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // ... have a match as well.
+ if ( false === stripos( $sidebar, $slug ) && false === stripos( $slug, $sidebar ) ) {
+ continue;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Make sure this sidebar wasn't mapped and removed previously.
- if ( ! empty( $existing_sidebars_widgets[ $sidebar ] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Make sure this sidebar wasn't mapped and removed previously.
+ if ( ! empty( $existing_sidebars_widgets[ $sidebar ] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // We have a match that can be mapped!
- $new_sidebars_widgets[ $new_sidebar ] = array_merge( $new_sidebars_widgets[ $new_sidebar ], $existing_sidebars_widgets[ $sidebar ] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // We have a match that can be mapped!
+ $new_sidebars_widgets[ $new_sidebar ] = array_merge( $new_sidebars_widgets[ $new_sidebar ], $existing_sidebars_widgets[ $sidebar ] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Remove the mapped sidebar so it can't be mapped again.
- unset( $existing_sidebars_widgets[ $sidebar ] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Remove the mapped sidebar so it can't be mapped again.
+ unset( $existing_sidebars_widgets[ $sidebar ] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Go back and check the next new sidebar.
- continue 3;
- }
- } // endforeach ( $slug_group as $slug )
- } // endforeach ( $existing_sidebars_widgets as $sidebar => $widgets )
- } // endforeach foreach ( $wp_registered_sidebars as $new_sidebar => $args )
- } // endforeach ( $slug_group as $slug )
- } // endforeach ( $common_slug_groups as $slug_group )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Go back and check the next new sidebar.
+ continue 3;
+ }
+ } // endforeach ( $slug_group as $slug )
+ } // endforeach ( $existing_sidebars_widgets as $sidebar => $widgets )
+ } // endforeach foreach ( $wp_registered_sidebars as $new_sidebar => $args )
+ } // endforeach ( $slug_group as $slug )
+ } // endforeach ( $common_slug_groups as $slug_group )
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Move any left over widgets to inactive sidebar.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $existing_sidebars_widgets as $widgets ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1290,7 +1290,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Sidebars_widgets settings from when this theme was previously active.
</span><span class="cx" style="display: block; padding: 0 10px"> $old_sidebars_widgets = get_theme_mod( 'sidebars_widgets' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $old_sidebars_widgets = $old_sidebars_widgets['data'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $old_sidebars_widgets = isset( $old_sidebars_widgets['data'] ) ? $old_sidebars_widgets['data'] : false;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $old_sidebars_widgets ) ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>