Changeset 41389

Timestamp:

09/19/2017 12:45:23 AM (7 years ago)

Author:

westonruter

Message:

Customize: Show notification error with "Your homepage displays" control when homepage and posts page are set to be the same (but not empty).

• Show global error notiafication when saving is blocked due to client-side setting invalidity.
• Refactor wp.customize.Notifications#render() to ensure a notification re-renders if its message or data changes but its code does not.

Props MatheusGimenez, sixhours, westonruter, karmatosed, aocean90, zoonini, michelleweber, melchoyce.
See #35210.
Fixes #21492.

Location:

trunk/src

Files:

• wp-admin/css/customize-controls.css (modified) (1 diff)
• wp-admin/js/customize-controls.js (modified) (6 diffs)
• wp-includes/script-loader.php (modified) (1 diff)

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

@@ -842 +842 @@
 
 /**
+ * Static front page
+ */
+
+#customize-control-show_on_front.has-error {
+    margin-bottom: 0;
+}
+#customize-control-show_on_front.has-error .customize-control-notifications-container {
+    margin-top:12px;
+}
+
+/**
  * Dropdowns
  */

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

@@ -147 +147 @@
             var collection = this,
                 notifications,
-                renderedNotificationContainers,
-                prevRenderedCodes,
-                nextRenderedCodes,
-                addedCodes,
-                removedCodes,
+                previousNotificationsByCode = {},
                 listElement;
 
@@ -158 +154 @@
                 return;
             }
+
+            notifications = collection.get( { sort: true } );
+            collection.container.toggle( 0 !== notifications.length );
+
+            // Short-circuit if there are no changes to the notifications.
+            if ( _.isEqual( notifications, collection.previousNotifications ) ) {
+                return;
+            }
+
+            // Make sure list is part of the container.
             listElement = collection.container.children( 'ul' ).first();
             if ( ! listElement.length ) {
@@ -164 +170 @@
             }
 
-            notifications = collection.get( { sort: true } );
-
-            renderedNotificationContainers = {};
-            listElement.find( '> [data-code]' ).each( function() {
-                renderedNotificationContainers[ $( this ).data( 'code' ) ] = $( this );
-            });
-
-            collection.container.toggle( 0 !== notifications.length );
-
-            nextRenderedCodes = _.pluck( notifications, 'code' );
-            prevRenderedCodes = _.keys( renderedNotificationContainers );
-
-            // Short-circuit if there are no notifications added.
-            if ( _.isEqual( nextRenderedCodes, prevRenderedCodes ) ) {
-                return;
-            }
-
-            addedCodes = _.difference( nextRenderedCodes, prevRenderedCodes );
-            removedCodes = _.difference( prevRenderedCodes, nextRenderedCodes );
-
-            // Remove notifications that have been removed.
-            _.each( renderedNotificationContainers, function( renderedContainer, code ) {
-                if ( -1 !== _.indexOf( removedCodes, code ) ) {
-                    renderedContainer.remove(); // @todo Consider slideUp as enhancement.
-                }
+            // Remove all notifications prior to re-rendering.
+            listElement.find( '> [data-code]' ).remove();
+
+            _.each( collection.previousNotifications, function( notification ) {
+                previousNotificationsByCode[ notification.code ] = notification;
             });
 
             // Add all notifications in the sorted order.
             _.each( notifications, function( notification ) {
-                var notificationContainer = renderedNotificationContainers[ notification.code ];
-                if ( notificationContainer ) {
-                    listElement.append( notificationContainer );
-                } else {
-                    notificationContainer = $( notification.render() );
-                    listElement.append( notificationContainer ); // @todo Consider slideDown() as enhancement.
-                    if ( wp.a11y ) {
-                        wp.a11y.speak( notification.message, 'assertive' );
-                    }
-                }
-            });
-
+                if ( wp.a11y && ( ! previousNotificationsByCode[ notification.code ] || ! _.isEqual( notification.message, previousNotificationsByCode[ notification.code ].message ) ) ) {
+                    wp.a11y.speak( notification.message, 'assertive' );
+                }
+                listElement.append( $( notification.render() ) ); // @todo Consider slideDown() as enhancement.
+            });
+
+            collection.previousNotifications = notifications;
             collection.trigger( 'rendered' );
         }
@@ -4645 +4626 @@
 
                 submit = function () {
-                    var request, query, settingInvalidities = {}, latestRevision = api._latestRevision;
+                    var request, query, settingInvalidities = {}, latestRevision = api._latestRevision, errorCode = 'client_side_error';
 
                     api.bind( 'change', captureSettingModifiedDuringSave );
+                    api.notifications.remove( errorCode );
 
                     /*
@@ -4669 +4651 @@
                         _.values( invalidControls )[0][0].focus();
                         api.unbind( 'change', captureSettingModifiedDuringSave );
+
+                        api.notifications.add( errorCode, new api.Notification( errorCode, {
+                            message: ( 1 === invalidSettings.length ? api.l10n.saveBlockedError.singular : api.l10n.saveBlockedError.plural ).replace( /%s/g, String( invalidSettings.length ) ),
+                            type: 'error',
+                            dismissible: true,
+                            saveFailure: true
+                        } ) );
+
                         deferred.rejectWith( previewer, [
                             { setting_invalidities: settingInvalidities }
@@ -5611 +5601 @@
         });
 
-        // Change previewed URL to the homepage when changing the page_on_front.
-        api( 'show_on_front', 'page_on_front', function( showOnFront, pageOnFront ) {
-            var updatePreviewUrl = function() {
-                if ( showOnFront() === 'page' && parseInt( pageOnFront(), 10 ) > 0 ) {
-                    api.previewer.previewUrl.set( api.settings.url.home );
+        // Add behaviors to the static front page controls.
+        api( 'show_on_front', 'page_on_front', 'page_for_posts', function( showOnFront, pageOnFront, pageForPosts ) {
+            var handleChange = function() {
+                var setting = this, pageOnFrontId, pageForPostsId, errorCode = 'show_on_front_page_collision';
+                pageOnFrontId = parseInt( pageOnFront(), 10 );
+                pageForPostsId = parseInt( pageForPosts(), 10 );
+
+                if ( 'page' === showOnFront() ) {
+
+                    // Change previewed URL to the homepage when changing the page_on_front.
+                    if ( setting === pageOnFront && pageOnFrontId > 0 ) {
+                        api.previewer.previewUrl.set( api.settings.url.home );
+                    }
+
+                    // Change the previewed URL to the selected page when changing the page_for_posts.
+                    if ( setting === pageForPosts && pageForPostsId > 0 ) {
+                        api.previewer.previewUrl.set( api.settings.url.home + '?page_id=' + pageForPostsId );
+                    }
+                }
+
+                // Toggle notification when the homepage and posts page are both set and the same.
+                if ( 'page' === showOnFront() && pageOnFrontId && pageForPostsId && pageOnFrontId === pageForPostsId ) {
+                    showOnFront.notifications.add( errorCode, new api.Notification( errorCode, {
+                        type: 'error',
+                        message: api.l10n.pageOnFrontError
+                    } ) );
+                } else {
+                    showOnFront.notifications.remove( errorCode );
                 }
             };
-            showOnFront.bind( updatePreviewUrl );
-            pageOnFront.bind( updatePreviewUrl );
-        });
-
-        // Change the previewed URL to the selected page when changing the page_for_posts.
-        api( 'page_for_posts', function( setting ) {
-            setting.bind(function( pageId ) {
-                pageId = parseInt( pageId, 10 );
-                if ( pageId > 0 ) {
-                    api.previewer.previewUrl.set( api.settings.url.home + '?page_id=' + pageId );
-                }
+            showOnFront.bind( handleChange );
+            pageOnFront.bind( handleChange );
+            pageForPosts.bind( handleChange );
+            handleChange.call( showOnFront, showOnFront() ); // Make sure initial notification is added after loading existing changeset.
+
+            // Move notifications container to the bottom.
+            api.control( 'show_on_front', function( showOnFrontControl ) {
+                showOnFrontControl.deferred.embedded.done( function() {
+                    showOnFrontControl.container.append( showOnFrontControl.getNotificationsContainerElement() );
+                });
             });
         });

trunk/src/wp-includes/script-loader.php

@@ -571 +571 @@
             array( 'singular', 'plural' )
         ),
+        'pageOnFrontError' => __( 'Homepage and posts page must be different.' ),
+        'saveBlockedError' => wp_array_slice_assoc(
+            /* translators: placeholder is error count */
+            _n_noop( 'Unable to save due to %s invalid setting.', 'Unable to save due to %s invalid settings.' ),
+            array( 'singular', 'plural' )
+        ),
     ) );
     $scripts->add( 'customize-selective-refresh', "/wp-includes/js/customize-selective-refresh$suffix.js", array( 'jquery', 'wp-util', 'customize-preview' ), false, 1 );