Ticket #27767: 27767-09.patch

src/wp-admin/js/customize-widgets.js

@@ -942 +942 @@
                         params.action = 'update-widget';
                         params.wp_customize = 'on';
                         params.nonce = api.Widgets.data.nonce;
+                        params.theme = api.settings.theme.stylesheet;
 
                         data = $.param( params );
                         $inputs = this._getInputs( $widgetContent );
@@ -1614 +1615 @@
                                 widgetNumber = widget.get( 'multi_number' );
                         }
 
-                        controlHtml = $( '#widget-tpl-' + widget.get( 'id' ) ).html();
+                        controlHtml = $.trim( $( '#widget-tpl-' + widget.get( 'id' ) ).html() );
                         if ( widget.get( 'is_multi' ) ) {
                                 controlHtml = controlHtml.replace( /<[^<>]+>/g, function( m ) {
                                         return m.replace( /__i__|%i%/g, widgetNumber );

src/wp-includes/class-wp-customize-manager.php

@@ -575 +575 @@
                         // to operate properly.
                         $this->stop_previewing_theme();
                         switch_theme( $this->get_stylesheet() );
+                        update_option( 'theme_switched_via_customizer', true );
                         $this->start_previewing_theme();
                 }
 

src/wp-includes/class-wp-customize-widgets.php

@@ -61 +61 @@
         protected $rendered_widgets = array();
 
         /**
+         * @since 3.9.0
+         * @access protected
+         * @var array
+         */
+        protected $old_sidebars_widgets = array();
+
+        /**
          * Initial loader.
          *
          * @since 3.9.0
@@ -71 +78 @@
         public function __construct( $manager ) {
                 $this->manager = $manager;
 
+                add_action( 'widgets_init',                            array( $this, 'handle_theme_switch' ), 10000 );
                 add_action( 'after_setup_theme',                       array( $this, 'setup_widget_addition_previews' ) );
                 add_action( 'customize_controls_init',                 array( $this, 'customize_controls_init' ) );
                 add_action( 'customize_register',                      array( $this, 'schedule_customize_register' ), 1 );
@@ -115 +123 @@
          * @since 3.9.0
          *
          * @access public
-         * @global WP_Customize_Manager $wp_customize Customizer instance.
          */
         public function setup_widget_addition_previews() {
                 $is_customize_preview = false;
@@ -279 +286 @@
         }
 
         /**
+         * Handle theme switch.
+         *
+         * When switching a theme via the customizer, supply any previously-configured
+         * sidebars_widgets from the target theme as the initial sidebars_widgets
+         * setting. Also store the old theme's existing settings so that they can
+         * be passed along for storing in the sidebars_widgets theme_mod when the
+         * theme gets switched.
+         *
+         * @since 3.9.0
+         * @access public
+         */
+        public function handle_theme_switch() {
+                if ( 'customize.php' === $GLOBALS['pagenow'] && ! $this->manager->is_theme_active() ) {
+                        $this->old_sidebars_widgets = wp_get_sidebars_widgets();
+                        add_filter( 'customize_value_old_sidebars_widgets_data', array( $this, 'filter_customize_value_old_sidebars_widgets_data' ) );
+
+                        $GLOBALS['sidebars_widgets'] = $this->old_sidebars_widgets; // retrieve_widgets() looks at the global $sidebars_widgets
+                        $GLOBALS['sidebars_widgets'] = retrieve_widgets( true, false );
+                        add_filter( 'option_sidebars_widgets', array( $this, 'filter_option_sidebars_widgets_for_theme_switch' ), 1 );
+                }
+        }
+
+        /**
+         * Filter old_sidebars_widgets_data customizer setting.
+         *
+         * When switching themes, filter the Customizer setting
+         * old_sidebars_widgets_data to supply initial $sidebars_widgets before they
+         * were overridden by retrieve_widgets(). The value for
+         * old_sidebars_widgets_data gets set in the old theme's sidebars_widgets
+         * theme_mod.
+         *
+         * @see WP_Customize_Widgets::handle_theme_switch()
+         * @since 3.9.0
+         * @access public
+         *
+         * @param array $sidebars_widgets
+         */
+        public function filter_customize_value_old_sidebars_widgets_data( $old_sidebars_widgets ) {
+                $old_sidebars_widgets = $this->old_sidebars_widgets;
+                return $old_sidebars_widgets;
+        }
+
+        /**
+         * Filter sidebars_widgets option for theme switch.
+         *
+         * When switching themes, the retrieve_widgets() function is run when the
+         * Customizer initializes, and then the new sidebars_widgets here get
+         * supplied as the default value for the sidebars_widgets option.
+         *
+         * @see WP_Customize_Widgets::handle_theme_switch()
+         * @since 3.9.0
+         * @access public
+         *
+         * @param array $sidebars_widgets
+         */
+        public function filter_option_sidebars_widgets_for_theme_switch( $sidebars_widgets ) {
+                $sidebars_widgets = $GLOBALS['sidebars_widgets'];
+                $sidebars_widgets['array_version'] = 3;
+                return $sidebars_widgets;
+        }
+
+        /**
          * Make sure all widgets get loaded into the Customizer.
          *
          * Note: these actions are also fired in wp_ajax_update_widget().
@@ -349 +418 @@
                         $new_setting_ids[] = $setting_id;
                 }
 
+                /*
+                 * Add a setting which will be supplied for the theme's sidebars_widgets
+                 * theme_mod when the the theme is switched.
+                 */
+                if ( ! $this->manager->is_theme_active() ) {
+                        $setting_id = 'old_sidebars_widgets_data';
+                        $setting_args = $this->get_setting_args( $setting_id, array(
+                                'type' => 'global_variable',
+                        ) );
+                        $this->manager->add_setting( $setting_id, $setting_args );
+                }
+
                 foreach ( $sidebars_widgets as $sidebar_id => $sidebar_widget_ids ) {
                         if ( empty( $sidebar_widget_ids ) ) {
                                 $sidebar_widget_ids = array();

src/wp-includes/theme.php

@@ -752 +752 @@
  * @param string $stylesheet Stylesheet name
  */
 function switch_theme( $stylesheet ) {
-        global $wp_theme_directories, $sidebars_widgets;
+        global $wp_theme_directories, $wp_customize, $sidebars_widgets;
 
-        if ( is_array( $sidebars_widgets ) )
-                set_theme_mod( 'sidebars_widgets', array( 'time' => time(), 'data' => $sidebars_widgets ) );
+        $_sidebars_widgets = null;
+        if ( current_action() === 'wp_ajax_customize_save' ) {
+                $_sidebars_widgets = $wp_customize->post_value( $wp_customize->get_setting( 'old_sidebars_widgets_data' ) );
+        } else if ( is_array( $sidebars_widgets ) ) {
+                $_sidebars_widgets = $sidebars_widgets;
+        }
+        if ( is_array( $_sidebars_widgets ) ) {
+                set_theme_mod( 'sidebars_widgets', array( 'time' => time(), 'data' => $_sidebars_widgets ) );
+        }
 
         $old_theme  = wp_get_theme();
         $new_theme = wp_get_theme( $stylesheet );
@@ -785 +792 @@
         if ( is_admin() && false === get_option( 'theme_mods_' . $stylesheet ) ) {
                 $default_theme_mods = (array) get_option( 'mods_' . $new_name );
                 add_option( "theme_mods_$stylesheet", $default_theme_mods );
+        } else {
+                // Since retrieve_widgets() is called when initializing the customizer theme, we need to remove the theme mods to avoid overwriting changes made via the widget customizer when accessing /wp-admin/widgets.php
+                if ( current_action() === 'wp_ajax_customize_save' ) {
+                        remove_theme_mod( 'sidebars_widgets' );
+                }
         }
 
         update_option( 'theme_switched', $old_theme->get_stylesheet() );
@@ -1791 +1803 @@
         if ( $stylesheet = get_option( 'theme_switched' ) ) {
                 $old_theme = wp_get_theme( $stylesheet );
 
+                // Prevent retrieve_widgets() from running since Customizer already called it up front
+                if ( get_option( 'theme_switched_via_customizer' ) ) {
+                        remove_action( 'after_switch_theme', '_wp_sidebars_changed' );
+                        update_option( 'theme_switched_via_customizer', false );
+                }
+
                 if ( $old_theme->exists() ) {
                         /**
                          * Fires on the first WP load after a theme switch if the old theme still exists.
@@ -1918 +1936 @@
                 }());
         </script>
         <?php
-}
- No newline at end of file
+}

src/wp-includes/widgets.php

@@ -1401 +1401 @@
         retrieve_widgets(true);
 }
 
-// look for "lost" widgets, this has to run at least on each theme change
-function retrieve_widgets($theme_changed = false) {
+/**
+ * Look for "lost" widgets, this has to run at least on each theme change.
+ *
+ * @since 2.8.0
+ *
+ * @param bool $theme_changed  Whether the theme was changed.
+ * @param bool $update  Whether to update the theme_mods. False is used for deferred update in Customizer.
+ *
+ * @return array
+ */
+function retrieve_widgets( $theme_changed = false, $update = true ) {
         global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets;
 
         $registered_sidebar_keys = array_keys( $wp_registered_sidebars );
@@ -1412 +1421 @@
         if ( is_array( $old_sidebars_widgets ) ) {
                 // time() that sidebars were stored is in $old_sidebars_widgets['time']
                 $_sidebars_widgets = $old_sidebars_widgets['data'];
-                remove_theme_mod( 'sidebars_widgets' );
+
+                if ( $update ) {
+                        remove_theme_mod( 'sidebars_widgets' );
+                }
 
                 foreach ( $_sidebars_widgets as $sidebar => $widgets ) {
                         if ( 'wp_inactive_widgets' == $sidebar || 'orphaned_widgets' == substr( $sidebar, 0, 16 ) )
@@ -1495 +1507 @@
         }
 
         $sidebars_widgets['wp_inactive_widgets'] = array_merge($lost_widgets, (array) $sidebars_widgets['wp_inactive_widgets']);
-        wp_set_sidebars_widgets($sidebars_widgets);
+        if ( $update ) {
+                wp_set_sidebars_widgets( $sidebars_widgets );
+        }
 
         return $sidebars_widgets;
 }