Changeset 39112

Timestamp:

11/03/2016 05:06:17 AM (8 years ago)

Author:

westonruter

Message:

Customize: Prevent syncing unmodified settings from controls into preview to guard against triggering an infinite reload due to selective refresh fallback behavior.

If a value is sanitized in PHP and differs from the JS value in the pane, a change event for the setting is triggered upon refresh. This should be avoided since the value just came from the server as being sanitized. This also fixes periodic issue where selective refresh happens immediately after a full refresh.

Fixes #37032.

Location:

trunk/src

Files:

• wp-admin/js/customize-controls.js (modified) (3 diffs)
• wp-includes/js/customize-preview.js (modified) (1 diff)

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

@@ -4300 +4300 @@
 
             synced.settings = api.get();
+            synced['settings-modified-while-loading'] = previewer.settingsModifiedWhileLoading;
             if ( 'resolved' !== previewer.deferred.active.state() || previewer.loading ) {
                 synced.scroll = previewer.scroll;
@@ -4422 +4423 @@
          */
         refresh: function() {
-            var previewer = this;
+            var previewer = this, onSettingChange;
 
             // Display loading indicator
@@ -4435 +4436 @@
                 container:  previewer.container
             });
+
+            previewer.settingsModifiedWhileLoading = {};
+            onSettingChange = function( setting ) {
+                previewer.settingsModifiedWhileLoading[ setting.id ] = true;
+            };
+            api.bind( 'change', onSettingChange );
+            previewer.loading.always( function() {
+                api.unbind( 'change', onSettingChange );
+            } );
 
             previewer.loading.done( function( readyData ) {

trunk/src/wp-includes/js/customize-preview.js

@@ -655 +655 @@
 
         api.preview.bind( 'sync', function( events ) {
+
+            /*
+             * Delete any settings that already exist locally which haven't been
+             * modified in the controls while the preview was loading. This prevents
+             * situations where the JS value being synced from the pane may differ
+             * from the PHP-sanitized JS value in the preview which causes the
+             * non-sanitized JS value to clobber the PHP-sanitized value. This
+             * is particularly important for selective refresh partials that
+             * have a fallback refresh behavior since infinite refreshing would
+             * result.
+             */
+            if ( events.settings && events['settings-modified-while-loading'] ) {
+                _.each( _.keys( events.settings ), function( syncedSettingId ) {
+                    if ( api.has( syncedSettingId ) && ! events['settings-modified-while-loading'][ syncedSettingId ] ) {
+                        delete events.settings[ syncedSettingId ];
+                    }
+                } );
+            }
+
             $.each( events, function( event, args ) {
                 api.preview.trigger( event, args );