Changeset 41872

Timestamp:

10/16/2017 06:45:09 AM (9 years ago)

Author:

westonruter

Message:

Widgets: Update preview for Gallery widget when one of its attachments is modified in the media modal, outside the customized state.

• Ensure that changes to captions are shown in preview when modified in media modal.
• Also keep wp.customize.widgetsPreview.renderedWidgets updated when widgets are added or removed.

See #41914, #37887, #40403.
Fixes #41979.

Location:

trunk/src

Files:

• wp-admin/js/widgets/media-gallery-widget.js (modified) (1 diff)
• wp-includes/js/customize-preview-widgets.js (modified) (3 diffs)

trunk/src/wp-admin/js/widgets/media-gallery-widget.js

@@ -101 +101 @@
                         control.selectedAttachments.on( 'reset', control.renderPreview );
                         control.updateSelectedAttachments();
+
+                        /*
+                         * Refresh a Gallery widget partial when the user modifies one of the selected attachments.
+                         * This ensures that when an attachment's caption is updated in the media modal the Gallery
+                         * widget in the preview will then be refreshed to show the change. Normally doing this
+                         * would not be necessary because all of the state should be contained inside the changeset,
+                         * as everything done in the Customizer should not make a change to the site unless the
+                         * changeset itself is published. Attachments are a current exception to this rule.
+                         * For a proposal to include attachments in the customized state, see #37887.
+                         */
+                        if ( wp.customize && wp.customize.previewer ) {
+                                control.selectedAttachments.on( 'change', function() {
+                                        wp.customize.previewer.send( 'refresh-widget-partial', control.model.get( 'widget_id' ) );
+                                } );
+                        }
                 },
 

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

@@ -39 +39 @@
                 api.preview.bind( 'active', function() {
                         self.highlightControls();
+                } );
+
+                /*
+                 * Refresh a partial when the controls pane requests it. This is used currently just by the
+                 * Gallery widget so that when an attachment's caption is updated in the media modal,
+                 * the widget in the preview will then be refreshed to show the change. Normally doing this
+                 * would not be necessary because all of the state should be contained inside the changeset,
+                 * as everything done in the Customizer should not make a change to the site unless the
+                 * changeset itself is published. Attachments are a current exception to this rule.
+                 * For a proposal to include attachments in the customized state, see #37887.
+                 */
+                api.preview.bind( 'refresh-widget-partial', function( widgetId ) {
+                        var partialId = 'widget[' + widgetId + ']';
+                        if ( api.selectiveRefresh.partial.has( partialId ) ) {
+                                api.selectiveRefresh.partial( partialId ).refresh();
+                        } else if ( self.renderedWidgets[ widgetId ] ) {
+                                api.preview.send( 'refresh' ); // Fallback in case theme does not support 'customize-selective-refresh-widgets'.
+                        }
                 } );
         };
@@ -452 +470 @@
                                         } );
                                 }
+                                delete self.renderedWidgets[ removedWidgetId ];
                         } );
 
@@ -459 +478 @@
                                 var widgetPartial = sidebarPartial.ensureWidgetPlacementContainers( addedWidgetId );
                                 addedWidgetPartials.push( widgetPartial );
+                                self.renderedWidgets[ addedWidgetId ] = true;
                         } );