Changeset 53024

Timestamp:

03/29/2022 07:07:15 PM (4 years ago)

Author:

audrasjb

Message:

Customizer: When a block theme is active, add an information about Site Editor in the Customizer.

This change adds an information notice to the customizer when a block theme is active and the customizer is also available (for example when a plugin activates it), to encourage people to use the Site Editor for the best full site customization experience.

Props ironprogrammer, antonvlasenko, Clorith, audrasjb, psmits1567, tobifjellner, costdev, webcommsat.
Fixes #54939.

Location:

trunk/src

Files:

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

trunk/src/js/_enqueues/wp/customize/controls.js

@@ -8336 +8336 @@
 
                         /**
+                         * Displays a Site Editor notification when a block theme is activated.
+                         *
+                         * @since 4.9.0
+                         *
+                         * @param {string} [notification] - A notification to display.
+                         * @return {void}
+                         */
+                        function addSiteEditorNotification( notification ) {
+                                api.notifications.add( new api.Notification( 'site_editor_block_theme_notice', {
+                                        message: notification,
+                                        type: 'info',
+                                        dismissible: false,
+                                        render: function() {
+                                                var notification = api.Notification.prototype.render.call( this ),
+                                                        button = notification.find( 'button.switch-to-editor' );
+
+                                                button.on( 'click', function( event ) {
+                                                        event.preventDefault();
+                                                        location.assign( button.data( 'action' ) );
+                                                } );
+
+                                                return notification;
+                                        }
+                                } ) );
+                        }
+
+                        /**
                          * Dismiss autosave.
                          *
@@ -8408 +8435 @@
                         if ( api.settings.changeset.latestAutoDraftUuid || api.settings.changeset.hasAutosaveRevision ) {
                                 addAutosaveRestoreNotification();
+                        }
+                        var shouldDisplayBlockThemeNotification = !! parseInt( $( '#customize-info' ).data( 'block-theme' ), 10 );
+                        if (shouldDisplayBlockThemeNotification) {
+                                addSiteEditorNotification( api.l10n.blockThemeNotification );
                         }
                 })();

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

@@ -1731 +1731 @@
         top: 50%;
         margin-top: -14px;
+        font-weight: 400;
+}
+
+#customize-notifications-area .notification-message button.switch-to-editor {
+        display: block;
+        margin-top: 6px;
         font-weight: 400;
 }

trunk/src/wp-admin/customize.php

@@ -223 +223 @@
                         </div>
                         <div class="wp-full-overlay-sidebar-content" tabindex="-1">
-                                <div id="customize-info" class="accordion-section customize-info">
+                                <div id="customize-info" class="accordion-section customize-info" data-block-theme="<?php echo (int) wp_is_block_theme(); ?>">
                                         <div class="accordion-section-title">
                                                 <span class="preview-notice">
@@ -236 +236 @@
                                                 <p>
                                                         <?php
-                                                        _e( 'The Customizer allows you to preview changes to your site before publishing them. You can navigate to different pages on your site within the preview. Edit shortcuts are shown for some editable elements.' );
+                                                        _e( 'The Customizer allows you to preview changes to your site before publishing them. You can navigate to different pages on your site within the preview. Edit shortcuts are shown for some editable elements. The Customizer is intended for use with non-block themes.' );
                                                         ?>
                                                 </p>

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

@@ -1155 +1155 @@
         $scripts->add( 'customize-views', '/wp-includes/js/customize-views.js', array( 'jquery', 'underscore', 'imgareaselect', 'customize-models', 'media-editor', 'media-views' ), false, 1 );
         $scripts->add( 'customize-controls', "/wp-admin/js/customize-controls$suffix.js", array( 'customize-base', 'wp-a11y', 'wp-util', 'jquery-ui-core' ), false, 1 );
+        $switch_to_site_editor_label = __( 'Use Site Editor' );
         did_action( 'init' ) && $scripts->localize(
                 'customize-controls',
@@ -1222 +1223 @@
                         'invalidDate'             => __( 'Invalid date.' ),
                         'invalidValue'            => __( 'Invalid value.' ),
+                        'blockThemeNotification'  => sprintf(
+                                /* translators: 1. %s: URL to the localized version of https://wordpress.org/support/article/site-editor/, 2: HTML Button. */
+                                __( 'Hurray! Your theme supports Full Site Editing with blocks. <a href="%1$s" target="_blank">Tell me more</a>. %2$s' ),
+                                __( 'https://wordpress.org/support/article/site-editor/' ),
+                                sprintf(
+                                        /* translators: 1: URL to the Site Editor admin screen, 2: Button label, 3: Button text. */
+                                        '<button type="button" data-action="%1$s" class="button switch-to-editor" aria-label="%2$s">%3$s</button>',
+                                        esc_url( admin_url( 'site-editor.php' ) ),
+                                        $switch_to_site_editor_label,
+                                        $switch_to_site_editor_label
+                                )
+                        ),
                 )
         );