Changeset 37701

Timestamp:

06/14/2016 07:27:41 PM (9 years ago)

Author:

westonruter

Message:

Customize: Ensure MediaControl fetches the necessary attachment data for rendering when dynamically added via JS.

Fixes #36521.
Props TimothyBlynJacobs, westonruter.

File:

• trunk/src/wp-admin/js/customize-controls.js (modified) (1 diff)

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

@@ -1929 +1929 @@
                 });
 
-            control.setting.bind( function( value ) {
-
-                // Send attachment information to the preview for possible use in `postMessage` transport.
-                wp.media.attachment( value ).fetch().done( function() {
-                    wp.customize.previewer.send( control.setting.id + '-attachment-data', this.attributes );
+            /**
+             * Set attachment data and render content.
+             *
+             * Note that BackgroundImage.prototype.ready applies this ready method
+             * to itself. Since BackgroundImage is an UploadControl, the value
+             * is the attachment URL instead of the attachment ID. In this case
+             * we skip fetching the attachment data because we have no ID available,
+             * and it is the responsibility of the UploadControl to set the control's
+             * attachmentData before calling the renderContent method.
+             *
+             * @param {number|string} value Attachment
+             */
+            function setAttachmentDataAndRenderContent( value ) {
+                var hasAttachmentData = $.Deferred();
+
+                if ( control.extended( api.UploadControl ) ) {
+                    hasAttachmentData.resolve();
+                } else {
+                    value = parseInt( value, 10 );
+                    if ( _.isNaN( value ) || value <= 0 ) {
+                        delete control.params.attachment;
+                        hasAttachmentData.resolve();
+                    } else if ( control.params.attachment && control.params.attachment.id === value ) {
+                        hasAttachmentData.resolve();
+                    }
+                }
+
+                // Fetch the attachment data.
+                if ( 'pending' === hasAttachmentData.state() ) {
+                    wp.media.attachment( value ).fetch().done( function() {
+                        control.params.attachment = this.attributes;
+                        hasAttachmentData.resolve();
+
+                        // Send attachment information to the preview for possible use in `postMessage` transport.
+                        wp.customize.previewer.send( control.setting.id + '-attachment-data', this.attributes );
+                    } );
+                }
+
+                hasAttachmentData.done( function() {
+                    control.renderContent();
                 } );
-
-                // Re-render whenever the control's setting changes.
-                control.renderContent();
-            } );
+            }
+
+            // Ensure attachment data is initially set (for dynamically-instantiated controls).
+            setAttachmentDataAndRenderContent( control.setting() );
+
+            // Update the attachment data and re-render the control when the setting changes.
+            control.setting.bind( setAttachmentDataAndRenderContent );
         },