Changeset 31705

Timestamp:

03/10/2015 10:38:30 PM (10 years ago)

Author:

ocean90

Message:

Customizer: Fix previewing and applying widgets when previewing another theme.

• Unset wp_get_sidebars_widgets()' non-admin cache var $_wp_sidebars_widgets in Customize theme preview.
• Add WP_Customize_Setting::$dirty so that settings can be initially-dirty when the Customizer loads.
• Mark old_sidebars_widgets_data setting initially-dirty.
• Mark all sidebars_widgets settings as initially-dirty during theme switch.

props westonruter.
see #31484.

Location:

trunk

Files:

• src/wp-admin/customize.php (modified) (1 diff)
• src/wp-admin/js/customize-controls.js (modified) (2 diffs)
• src/wp-includes/class-wp-customize-setting.php (modified) (1 diff)
• src/wp-includes/class-wp-customize-widgets.php (modified) (3 diffs)
• tests/phpunit/tests/customize/setting.php (modified) (1 diff)

trunk/src/wp-admin/customize.php

@@ -251 +251 @@
             'value'     => $setting->js_value(),
             'transport' => $setting->transport,
+            'dirty'     => $setting->dirty,
         );
     }

trunk/src/wp-admin/js/customize-controls.js

@@ -18 +18 @@
             this.id = id;
             this.transport = this.transport || 'refresh';
+            this._dirty = options.dirty || false;
 
             this.bind( this.preview );
@@ -2517 +2518 @@
             api.create( id, id, data.value, {
                 transport: data.transport,
-                previewer: api.previewer
+                previewer: api.previewer,
+                dirty: !! data.dirty
             } );
         });

trunk/src/wp-includes/class-wp-customize-setting.php

@@ -60 +60 @@
     public $sanitize_callback    = '';
     public $sanitize_js_callback = '';
+
+    /**
+     * Whether or not the setting is initially dirty when created.
+     *
+     * This is used to ensure that a setting will be sent from the pane to the
+     * preview when loading the Customizer. Normally a setting only is synced to
+     * the preview if it has been changed. This allows the setting to be sent
+     * from the start.
+     *
+     * @since 4.2.0
+     * @access public
+     * @var bool
+     */
+    public $dirty = false;
 
     protected $id_data = array();

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

@@ -217 +217 @@
         $sidebars_widgets = retrieve_widgets( 'customize' );
         add_filter( 'option_sidebars_widgets', array( $this, 'filter_option_sidebars_widgets_for_theme_switch' ), 1 );
+        unset( $GLOBALS['_wp_sidebars_widgets'] ); // reset global cache var used by wp_get_sidebars_widgets()
     }
 
@@ -333 +334 @@
             $setting_args = $this->get_setting_args( $setting_id, array(
                 'type' => 'global_variable',
+                'dirty' => true,
             ) );
             $this->manager->add_setting( $setting_id, $setting_args );
@@ -357 +359 @@
                 $setting_args = $this->get_setting_args( $setting_id );
                 if ( ! $this->manager->get_setting( $setting_id ) ) {
+                    if ( ! $this->manager->is_theme_active() ) {
+                        $setting_args['dirty'] = true;
+                    }
                     $this->manager->add_setting( $setting_id, $setting_args );
                 }

trunk/tests/phpunit/tests/customize/setting.php

@@ -45 +45 @@
         $this->assertFalse( has_filter( "customize_sanitize_{$setting->id}" ) );
         $this->assertFalse( has_filter( "customize_sanitize_js_{$setting->id}" ) );
+        $this->assertEquals( false, $setting->dirty );
     }