Ticket #39693: 39693.2.diff

src/wp-includes/theme.php

@@ -679 +679 @@
 function switch_theme( $stylesheet ) {
         global $wp_theme_directories, $wp_customize, $sidebars_widgets;
 
-        $_sidebars_widgets = null;
-        if ( 'wp_ajax_customize_save' === current_action() ) {
-                $_sidebars_widgets = $wp_customize->post_value( $wp_customize->get_setting( 'old_sidebars_widgets_data' ) );
-        } elseif ( is_array( $sidebars_widgets ) ) {
-                $_sidebars_widgets = $sidebars_widgets;
-        }
-
-        if ( is_array( $_sidebars_widgets ) ) {
-                set_theme_mod( 'sidebars_widgets', array( 'time' => time(), 'data' => $_sidebars_widgets ) );
-        }
-
         $nav_menu_locations = get_theme_mod( 'nav_menu_locations' );
         add_option( 'theme_switch_menu_locations', $nav_menu_locations );
 
@@ -716 +705 @@
 
         update_option( 'current_theme', $new_name );
 
+        $_sidebars_widgets = null;
+        if ( 'wp_ajax_customize_save' === current_action() ) {
+                $_sidebars_widgets = $wp_customize->post_value( $wp_customize->get_setting( 'old_sidebars_widgets_data' ) );
+        } elseif ( is_array( $sidebars_widgets ) ) {
+                $_sidebars_widgets = $sidebars_widgets;
+        }
+
+        if ( is_array( $_sidebars_widgets ) ) {
+                set_theme_mod( 'sidebars_widgets', array( 'time' => time(), 'data' => $_sidebars_widgets ) );
+        }
+
         // Migrate from the old mods_{name} option to theme_mods_{slug}.
         if ( is_admin() && false === get_option( 'theme_mods_' . $stylesheet ) ) {
                 $default_theme_mods = (array) get_option( 'mods_' . $new_name );

src/wp-includes/widgets.php

@@ -1107 +1107 @@
  *
  * @param string|bool $theme_changed Whether the theme was changed as a boolean. A value
  *                                   of 'customize' defers updates for the Customizer.
- * @return array|void
+ * @return array
  */
 function retrieve_widgets( $theme_changed = false ) {
         global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets;
 
-        $registered_sidebar_keys = array_keys( $wp_registered_sidebars );
-        $orphaned = 0;
+        $registered_sidebars_keys = array_keys( $wp_registered_sidebars );
+        $registered_widgets_ids   = array_keys( $wp_registered_widgets );
+        $old_sidebars_widgets     = get_theme_mod( 'sidebars_widgets' );
 
-        $old_sidebars_widgets = get_theme_mod( 'sidebars_widgets' );
         if ( is_array( $old_sidebars_widgets ) ) {
                 // time() that sidebars were stored is in $old_sidebars_widgets['time']
-                $_sidebars_widgets = $old_sidebars_widgets['data'];
+                $sidebars_widgets = $old_sidebars_widgets['data'];
 
                 if ( 'customize' !== $theme_changed ) {
                         remove_theme_mod( 'sidebars_widgets' );
                 }
+        } else {
+                if ( empty( $sidebars_widgets ) ) {
+                        return array();
+                }
 
-                foreach ( $_sidebars_widgets as $sidebar => $widgets ) {
-                        if ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) {
-                                continue;
-                        }
+                unset( $sidebars_widgets['array_version'] );
 
-                        if ( !in_array( $sidebar, $registered_sidebar_keys ) ) {
-                                $_sidebars_widgets['orphaned_widgets_' . ++$orphaned] = $widgets;
-                                unset( $_sidebars_widgets[$sidebar] );
-                        }
+                $sidebars_widgets_keys = array_keys( $sidebars_widgets );
+                sort( $sidebars_widgets_keys );
+                sort( $registered_sidebars_keys );
+
+                if ( $sidebars_widgets_keys == $registered_sidebars_keys ) {
+                        $sidebars_widgets = _wp_remove_unregistered_widgets( $sidebars_widgets, $registered_widgets_ids );
+
+                        return $sidebars_widgets;
                 }
-        } else {
-                if ( empty( $sidebars_widgets ) )
-                        return;
+        }
 
-                unset( $sidebars_widgets['array_version'] );
+        // Discard invalid, theme-specific widgets from sidebars.
+        $sidebars_widgets = _wp_remove_unregistered_widgets( $sidebars_widgets, $registered_widgets_ids );
+        $sidebars_widgets = _wp_map_sidebars( $sidebars_widgets );
 
-                $old = array_keys($sidebars_widgets);
-                sort($old);
-                sort($registered_sidebar_keys);
-
-                if ( $old == $registered_sidebar_keys )
-                        return;
-
-                $_sidebars_widgets = array(
-                        'wp_inactive_widgets' => !empty( $sidebars_widgets['wp_inactive_widgets'] ) ? $sidebars_widgets['wp_inactive_widgets'] : array()
-                );
-
-                unset( $sidebars_widgets['wp_inactive_widgets'] );
-
-                foreach ( $wp_registered_sidebars as $id => $settings ) {
-                        if ( $theme_changed ) {
-                                $_sidebars_widgets[$id] = array_shift( $sidebars_widgets );
-                        } else {
-                                // no theme change, grab only sidebars that are currently registered
-                                if ( isset( $sidebars_widgets[$id] ) ) {
-                                        $_sidebars_widgets[$id] = $sidebars_widgets[$id];
-                                        unset( $sidebars_widgets[$id] );
-                                }
-                        }
+        // Find hidden/lost multi-widget instances.
+        $shown_widgets = call_user_func_array( 'array_merge', array_filter( $sidebars_widgets ) );
+        $lost_widgets  = array_diff( $registered_widgets_ids, $shown_widgets );
+
+        foreach ( $lost_widgets as $key => $widget_id ) {
+                $number = preg_replace( '/.+?-([0-9]+)$/', '$1', $widget_id );
+
+                if ( (int) $number < 2 ) {
+                        unset( $lost_widgets[ $key ] );
                 }
+        }
+        $sidebars_widgets['wp_inactive_widgets'] = array_merge( $lost_widgets, (array) $sidebars_widgets['wp_inactive_widgets'] );
+
+        if ( 'customize' !== $theme_changed ) {
+                wp_set_sidebars_widgets( $sidebars_widgets );
+        }
+
+        return $sidebars_widgets;
+}
 
-                foreach ( $sidebars_widgets as $val ) {
-                        if ( is_array($val) && ! empty( $val ) )
-                                $_sidebars_widgets['orphaned_widgets_' . ++$orphaned] = $val;
+/**
+ * Compares a list of sidebars with their widgets against a whitelist.
+ *
+ * @since 4.9.0
+ *
+ * @param array $old_sidebars_widgets List of sidebars and their widget instance IDs.
+ * @return array Mapped sidebars widgets.
+ */
+function _wp_map_sidebars( $old_sidebars_widgets ) {
+        global $wp_registered_sidebars;
+
+        $new_sidebars_widgets = array();
+
+        // Short-circuit if there are no sidebars to map.
+        if ( empty( $old_sidebars_widgets ) ) {
+                return $new_sidebars_widgets;
+        }
+
+        foreach ( $old_sidebars_widgets as $sidebar => $widgets ) {
+                if ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) {
+                        $new_sidebars_widgets[ $sidebar ] = $widgets;
+                        unset( $old_sidebars_widgets[ $sidebar ] );
                 }
         }
 
-        // discard invalid, theme-specific widgets from sidebars
-        $shown_widgets = array();
+        // If old and new theme have just one sidebar, map it and we're done.
+        if ( 1 === count( $old_sidebars_widgets ) && 1 === count( $wp_registered_sidebars ) ) {
+                $new_sidebars_widgets[ key( $wp_registered_sidebars ) ] = array_pop( $old_sidebars_widgets );
+
+                return $new_sidebars_widgets;
+        }
 
-        foreach ( $_sidebars_widgets as $sidebar => $widgets ) {
-                if ( !is_array($widgets) )
-                        continue;
+        // Map locations with the same slug.
+        $old_sidebars = array_keys( $old_sidebars_widgets );
 
-                $_widgets = array();
-                foreach ( $widgets as $widget ) {
-                        if ( isset($wp_registered_widgets[$widget]) )
-                                $_widgets[] = $widget;
+        foreach ( $wp_registered_sidebars as $sidebar => $name ) {
+                if ( in_array( $sidebar, $old_sidebars, true ) ) {
+                        $new_sidebars_widgets[ $sidebar ] = $old_sidebars_widgets[ $sidebar ];
+                        unset( $old_sidebars_widgets[ $sidebar ] );
+                } else {
+                        $new_sidebars_widgets[ $sidebar ] = array();
                 }
+        }
 
-                $_sidebars_widgets[$sidebar] = $_widgets;
-                $shown_widgets = array_merge($shown_widgets, $_widgets);
+        // If there are no old sidebars left, then we're done.
+        if ( empty( $old_sidebars_widgets ) ) {
+                return $new_sidebars_widgets;
         }
 
-        $sidebars_widgets = $_sidebars_widgets;
-        unset($_sidebars_widgets, $_widgets);
+        /*
+         * 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( 'footer', 'bottom' ),
+                array( 'header', 'top' ),
+        );
+
+        // Go through each group...
+        foreach ( $common_slug_groups as $slug_group ) {
+
+                // ...and see if any of these slugs...
+                foreach ( $slug_group as $slug ) {
+
+                        // ...and any of the new sidebars...
+                        foreach ( $wp_registered_sidebars as $new_sidebar => $args ) {
+
+                                // ...actually match!
+                                if ( false === stripos( $new_sidebar, $slug ) && false === stripos( $slug, $new_sidebar ) ) {
+                                        continue;
+                                }
 
-        // find hidden/lost multi-widget instances
-        $lost_widgets = array();
-        foreach ( $wp_registered_widgets as $key => $val ) {
-                if ( in_array($key, $shown_widgets, true) )
-                        continue;
+                                // Then see if any of the old sidebars...
+                                foreach ( $old_sidebars_widgets as $sidebar => $widgets ) {
 
-                $number = preg_replace('/.+?-([0-9]+)$/', '$1', $key);
+                                        // ...and any slug in the same group...
+                                        foreach ( $slug_group as $slug ) {
 
-                if ( 2 > (int) $number )
-                        continue;
+                                                // ... have a match as well.
+                                                if ( false === stripos( $sidebar, $slug ) && false === stripos( $slug, $sidebar ) ) {
+                                                        continue;
+                                                }
+
+                                                // Make sure this sidebar wasn't mapped and removed previously.
+                                                if ( ! empty( $old_sidebars_widgets[ $sidebar ] ) ) {
+
+                                                        // We have a match that can be mapped!
+                                                        $new_sidebars_widgets[ $new_sidebar ] = array_merge( $new_sidebars_widgets[ $new_sidebar ], $old_sidebars_widgets[ $sidebar ] );
+
+                                                        // Remove the mapped sidebar so it can't be mapped again.
+                                                        unset( $old_sidebars_widgets[ $sidebar ] );
+
+                                                        // Go back and check the next new sidebar.
+                                                        continue 3;
+                                                }
+                                        } // endforeach ( $slug_group as $slug )
+                                } // endforeach ( $old_sidebars_widgets as $sidebar => $menu_id )
+                        } // endforeach foreach ( $wp_registered_sidebars as $new_sidebar => $name )
+                } // endforeach ( $slug_group as $slug )
+        } // endforeach ( $common_slug_groups as $slug_group )
 
-                $lost_widgets[] = $key;
+        $orphaned = 0;
+        foreach ( $old_sidebars_widgets as $widgets ) {
+                if ( is_array( $widgets ) && ! empty( $widgets ) ) {
+                        $new_sidebars_widgets[ 'orphaned_widgets_' . ++$orphaned ] = $widgets;
+                }
         }
 
-        $sidebars_widgets['wp_inactive_widgets'] = array_merge($lost_widgets, (array) $sidebars_widgets['wp_inactive_widgets']);
-        if ( 'customize' !== $theme_changed ) {
-                wp_set_sidebars_widgets( $sidebars_widgets );
+        return $new_sidebars_widgets;
+}
+
+/**
+ * Compares a list of sidebars with their widgets against a whitelist.
+ *
+ * @since 4.9.0
+ *
+ * @param array $sidebars_widgets List of sidebars and their widget instance IDs.
+ * @param array $whitelist        List of widget IDs to compare against.
+ * @return array Sidebars with whitelisted widgets.
+ */
+function _wp_remove_unregistered_widgets( $sidebars_widgets, $whitelist ) {
+        foreach ( $sidebars_widgets as $sidebar => $widgets ) {
+                if ( is_array( $widgets ) ) {
+                        $sidebars_widgets[ $sidebar ] = array_intersect( $widgets, $whitelist );
+                }
         }
 
         return $sidebars_widgets;

tests/phpunit/tests/widgets.php

@@ -678 +678 @@
 
         }
 
+        function test_retrieve_widgets_with_theme_mod() {
+                global $sidebars_widgets, $_wp_sidebars_widgets;
+
+                wp_widgets_init();
+
+                register_sidebar( array(
+                        'name' => 'Primary Sidebar',
+                        'id'   => 'sidebar-1',
+                ) );
+                register_sidebar( array(
+                        'name' => 'Content Sidebar',
+                        'id'   => 'sidebar-2',
+                ) );
+                register_sidebar( array(
+                        'name' => 'Footer Widget Area',
+                        'id'   => 'sidebar-3',
+                ) );
+                register_sidebar( array( 'id' => 'wp_inactive_widgets' ) );
+
+                set_theme_mod( 'sidebars_widgets', array(
+                        'time' => time(),
+                        'data' => array(
+                                'sidebar-1' => array( 'tag_cloud-1' ),
+                                'sidebar-2' => array( 'text-1' ),
+                                'sidebar-3' => array( 'unregistered_widget-1' ),
+                                'fantasy'   => array( 'archives-2' ),
+                                'wp_inactive_widgets' => array(),
+                        ),
+                ) );
+
+                $result = retrieve_widgets( true );
+
+                $_wp_sidebars_widgets = array();
+                $this->assertInternalType( 'array', $result );
+                $this->assertEquals( $result, $sidebars_widgets );
+                $this->assertContains( 'tag_cloud-1', $sidebars_widgets['sidebar-1'] );
+                $this->assertContains( 'text-1', $sidebars_widgets['sidebar-2'] );
+                $this->assertContains( 'archives-2', $sidebars_widgets['orphaned_widgets_1'] );
+
+                // Unregistered widget should be filtered out.
+                $this->assertEmpty( $sidebars_widgets['sidebar-3'] );
+
+                // 6 default widgets - 1 active text widget = 5.
+                $this->assertCount( 5, $sidebars_widgets['wp_inactive_widgets'] );
+
+                // Theme mode with previous widgets was removed.
+                $this->assertFalse( get_theme_mod( 'sidebars_widgets' ) );
+
+                // Sidebar_widgets option was updated.
+                $this->assertEquals( $sidebars_widgets, wp_get_sidebars_widgets() );
+        }
+
+        function test_retrieve_widgets_with_sidebars_widgets_matching_registered_sidebars() {
+                global $sidebars_widgets;
+
+                wp_widgets_init();
+
+                register_sidebar( array(
+                        'name' => 'Primary Sidebar',
+                        'id'   => 'sidebar-1',
+                ) );
+                register_sidebar( array(
+                        'name' => 'Content Sidebar',
+                        'id'   => 'sidebar-2',
+                ) );
+                register_sidebar( array(
+                        'name' => 'Footer Widget Area',
+                        'id'   => 'sidebar-3',
+                ) );
+                register_sidebar( array( 'id' => 'wp_inactive_widgets' ) );
+
+                $sidebars_widgets = array(
+                        'sidebar-1' => array( 'tag_cloud-1' ),
+                        'sidebar-2' => array( 'text-1' ),
+                        'sidebar-3' => array( 'custom_widget-1' ),
+                        'wp_inactive_widgets' => array(),
+                );
+
+                $result = retrieve_widgets( true );
+
+                // $sidebars_widgets matches registered sidebars.
+                $this->assertInternalType( 'array', $result );
+                $this->assertEquals( $result, $sidebars_widgets );
+                $this->assertContains( 'tag_cloud-1', $sidebars_widgets['sidebar-1'] );
+                $this->assertContains( 'text-1', $sidebars_widgets['sidebar-2'] );
+
+                // Invalid widget removed, even when $sidebars_widgets matches registered sidebars.
+                $this->assertEmpty( $sidebars_widgets['sidebar-3'] );
+
+                // No lost widgets when $sidebars_widgets matches registered sidebars.
+                $this->assertEmpty( $sidebars_widgets['wp_inactive_widgets'] );
+        }
+
+        function test_retrieve_widgets_with_sidebars_widgets_not_matching_registered_sidebars() {
+                global $sidebars_widgets, $_wp_sidebars_widgets;
+
+                wp_widgets_init();
+
+                register_sidebar( array(
+                        'name' => 'Primary Sidebar',
+                        'id'   => 'sidebar-1',
+                ) );
+                register_sidebar( array(
+                        'name' => 'Content Sidebar',
+                        'id'   => 'sidebar-2',
+                ) );
+                register_sidebar( array(
+                        'name' => 'Footer Widget Area',
+                        'id'   => 'sidebar-3',
+                ) );
+                register_sidebar( array( 'id' => 'wp_inactive_widgets' ) );
+
+                $sidebars_widgets = array(
+                        'sidebar-1' => array( 'tag_cloud-1' ),
+                        'sidebar-2' => array( 'text-1' ),
+                        'fantasy'   => array( 'unregistered_widget-1' ),
+                        'wp_inactive_widgets' => array(),
+                );
+
+                // Theme changed.
+                $result = retrieve_widgets( true );
+
+                $_wp_sidebars_widgets = array();
+                $this->assertInternalType( 'array', $result );
+                $this->assertEquals( $result, $sidebars_widgets );
+
+                // Current theme doesn't have a fantasy-sidebar.
+                $this->assertArrayNotHasKey( 'fantasy', $sidebars_widgets );
+                $this->assertArrayHasKey( 'sidebar-3', $sidebars_widgets );
+
+                $this->assertContains( 'tag_cloud-1', $sidebars_widgets['sidebar-1'] );
+                $this->assertContains( 'text-1', $sidebars_widgets['sidebar-2'] );
+
+                // We should not have orphaned widgets, because widget was not registered.
+                $this->assertArrayNotHasKey( 'orphaned_widgets_1', $sidebars_widgets );
+
+                // 6 default widgets.
+                $this->assertCount( 6, $sidebars_widgets['wp_inactive_widgets'] );
+
+                // Sidebar_widgets option was updated.
+                $this->assertEquals( $sidebars_widgets, wp_get_sidebars_widgets() );
+
+                // Reset.
+                $sidebars_widgets = array(
+                        'sidebar-1' => array( 'tag_cloud-1' ),
+                        'sidebar-2' => array( 'text-1' ),
+                        'fantasy'   => array( 'archives-2' ),
+                        'wp_inactive_widgets' => array(),
+                );
+
+                // Theme did not change.
+                $result = retrieve_widgets();
+
+                $_wp_sidebars_widgets = array();
+                $this->assertInternalType( 'array', $result );
+                $this->assertEquals( $result, $sidebars_widgets );
+
+                // This sidebar is not registered anymore.
+                $this->assertArrayNotHasKey( 'fantasy-sidebar', $sidebars_widgets );
+                $this->assertArrayHasKey( 'sidebar-3', $sidebars_widgets );
+
+                // archives-2 ends up as an orphan because of the above behavior.
+                $this->assertContains( 'archives-2', $sidebars_widgets['orphaned_widgets_1'] );
+                $this->assertContains( 'tag_cloud-1', $sidebars_widgets['sidebar-1'] );
+                $this->assertContains( 'text-1', $sidebars_widgets['sidebar-2'] );
+
+                // 6 default widgets - 1 active text widget = 5.
+                $this->assertCount( 5, $sidebars_widgets['wp_inactive_widgets'] );
+
+                // Sidebar_widgets option was updated.
+                $this->assertEquals( $sidebars_widgets, wp_get_sidebars_widgets() );
+        }
+
+        function test_retrieve_widgets_for_customizer() {
+                global $sidebars_widgets, $_wp_sidebars_widgets;
+
+                wp_widgets_init();
+
+                register_sidebar( array(
+                        'name' => 'Primary Sidebar',
+                        'id'   => 'sidebar-1',
+                ) );
+                register_sidebar( array(
+                        'name' => 'Content Sidebar',
+                        'id'   => 'sidebar-2',
+                ) );
+                register_sidebar( array(
+                        'name' => 'Footer Widget Area',
+                        'id'   => 'sidebar-3',
+                ) );
+                register_sidebar( array( 'id' => 'wp_inactive_widgets' ) );
+
+                $old_sidebars_widgets = array(
+                        'time' => time(),
+                        'data' => array(
+                                'sidebar-1' => array( 'tag_cloud-1' ),
+                                'sidebar-2' => array( 'text-1' ),
+                                'sidebar-3' => array( 'unregistered_widget-1' ),
+                                'fantasy'   => array( 'archives-2' ),
+                                'wp_inactive_widgets' => array(),
+                        ),
+                );
+                set_theme_mod( 'sidebars_widgets', $old_sidebars_widgets );
+
+                $result = retrieve_widgets( 'customize' );
+
+                $_wp_sidebars_widgets = array();
+                $this->assertInternalType( 'array', $result );
+                $this->assertEquals( $result, $sidebars_widgets );
+                $this->assertContains( 'tag_cloud-1', $sidebars_widgets['sidebar-1'] );
+                $this->assertContains( 'text-1', $sidebars_widgets['sidebar-2'] );
+                $this->assertContains( 'archives-2', $sidebars_widgets['orphaned_widgets_1'] );
+                $this->assertEmpty( $sidebars_widgets['sidebar-3'] );
+                $this->assertCount( 5, $sidebars_widgets['wp_inactive_widgets'] );
+
+                // Theme mod with previous widgets was not removed.
+                $this->assertEqualSets( $old_sidebars_widgets, get_theme_mod( 'sidebars_widgets' ) );
+
+                // Sidebar_widgets option was not updated.
+                $this->assertNotEquals( $sidebars_widgets, wp_get_sidebars_widgets() );
+        }
 }