Changeset 49151

Timestamp:

10/14/2020 09:11:09 PM (4 years ago)

Author:

ocean90

Message:

I18N: Use wp.i18n for translatable strings in wp-admin/js/dashboard.js.

• Deprecate the l10n property on communityEventsData.
• Introduce version parameter for deprecateL10nObject and backfill the version for deprecated objects in 5.5.0.
• Add a noop version of deprecateL10nObject for QUnit testing.

Fixes #51498.

Location:

trunk

Files:

• src/js/_enqueues/admin/common.js (modified) (18 diffs)
• src/js/_enqueues/admin/widgets.js (modified) (1 diff)
• src/js/_enqueues/wp/dashboard.js (modified) (8 diffs)
• src/js/_enqueues/wp/theme-plugin-editor.js (modified) (1 diff)
• src/js/_enqueues/wp/updates.js (modified) (1 diff)
• src/wp-includes/script-loader.php (modified) (1 diff)
• tests/qunit/fixtures/common.js (added)
• tests/qunit/index.html (modified) (1 diff)

trunk/src/js/_enqueues/admin/common.js

@@ -56 +56 @@
  *
  * @since 5.5.1
+ * @since 5.6.0 Added the `version` parameter.
  *
  * @param {string} name       The name of the object, i.e. commonL10n.
  * @param {object} l10nObject The object to deprecate the properties on.
+ * @param {string} version    The version of WordPress that deprecated the property.
  *
  * @return {object} The object with all its properties deprecated.
  */
-function deprecateL10nObject( name, l10nObject ) {
+function deprecateL10nObject( name, l10nObject, version ) {
     var deprecatedObject = {};
 
@@ -71 +73 @@
         if ( 'object' === typeof prop ) {
             Object.defineProperty( deprecatedObject, key, { get: function() {
-                deprecatedProperty( propName, '5.5.0', prop.alternative );
+                deprecatedProperty( propName, version, prop.alternative );
                 return prop.func();
             } } );
         } else {
             Object.defineProperty( deprecatedObject, key, { get: function() {
-                deprecatedProperty( propName, '5.5.0', 'wp.i18n' );
+                deprecatedProperty( propName, version, 'wp.i18n' );
                 return prop;
             } } );
@@ -100 +102 @@
 };
 
-window.commonL10n = deprecateL10nObject( 'commonL10n', window.commonL10n );
+window.commonL10n = deprecateL10nObject( 'commonL10n', window.commonL10n, '5.5.0' );
 
 /**
@@ -112 +114 @@
 };
 
-window.wpPointerL10n = deprecateL10nObject( 'wpPointerL10n', window.wpPointerL10n );
+window.wpPointerL10n = deprecateL10nObject( 'wpPointerL10n', window.wpPointerL10n, '5.5.0' );
 
 /**
@@ -130 +132 @@
 };
 
-window.userProfileL10n = deprecateL10nObject( 'userProfileL10n', window.userProfileL10n );
+window.userProfileL10n = deprecateL10nObject( 'userProfileL10n', window.userProfileL10n, '5.5.0' );
 
 /**
@@ -149 +151 @@
 };
 
-window.privacyToolsL10n = deprecateL10nObject( 'privacyToolsL10n', window.privacyToolsL10n );
+window.privacyToolsL10n = deprecateL10nObject( 'privacyToolsL10n', window.privacyToolsL10n, '5.5.0' );
 
 /**
@@ -161 +163 @@
 };
 
-window.authcheckL10n = window.authcheckL10n || deprecateL10nObject( 'authcheckL10n', window.authcheckL10n );
+window.authcheckL10n = window.authcheckL10n || deprecateL10nObject( 'authcheckL10n', window.authcheckL10n, '5.5.0' );
 
 /**
@@ -174 +176 @@
 };
 
-window.tagsl10n = window.tagsl10n || deprecateL10nObject( 'tagsl10n', window.tagsl10n );
+window.tagsl10n = window.tagsl10n || deprecateL10nObject( 'tagsl10n', window.tagsl10n, '5.5.0' );
 
 /**
@@ -199 +201 @@
 };
 
-window.adminCommentsL10n = deprecateL10nObject( 'adminCommentsL10n', window.adminCommentsL10n );
+window.adminCommentsL10n = deprecateL10nObject( 'adminCommentsL10n', window.adminCommentsL10n, '5.5.0' );
 
 /**
@@ -215 +217 @@
 };
 
-window.tagsSuggestL10n = deprecateL10nObject( 'tagsSuggestL10n', window.tagsSuggestL10n );
+window.tagsSuggestL10n = deprecateL10nObject( 'tagsSuggestL10n', window.tagsSuggestL10n, '5.5.0' );
 
 /**
@@ -232 +234 @@
 };
 
-window.wpColorPickerL10n = deprecateL10nObject( 'wpColorPickerL10n', window.wpColorPickerL10n );
+window.wpColorPickerL10n = deprecateL10nObject( 'wpColorPickerL10n', window.wpColorPickerL10n, '5.5.0' );
 
 /**
@@ -244 +246 @@
 };
 
-window.attachMediaBoxL10n = deprecateL10nObject( 'attachMediaBoxL10n', window.attachMediaBoxL10n );
+window.attachMediaBoxL10n = deprecateL10nObject( 'attachMediaBoxL10n', window.attachMediaBoxL10n, '5.5.0' );
 
 /**
@@ -277 +279 @@
 };
 
-window.postL10n = deprecateL10nObject( 'postL10n', window.postL10n );
+window.postL10n = deprecateL10nObject( 'postL10n', window.postL10n, '5.5.0' );
 
 /**
@@ -293 +295 @@
 };
 
-window.inlineEditL10n = deprecateL10nObject( 'inlineEditL10n', window.inlineEditL10n );
+window.inlineEditL10n = deprecateL10nObject( 'inlineEditL10n', window.inlineEditL10n, '5.5.0' );
 
 /**
@@ -307 +309 @@
 };
 
-window.plugininstallL10n = deprecateL10nObject( 'plugininstallL10n', window.plugininstallL10n );
+window.plugininstallL10n = deprecateL10nObject( 'plugininstallL10n', window.plugininstallL10n, '5.5.0' );
 
 /**
@@ -322 +324 @@
 };
 
-window.navMenuL10n = deprecateL10nObject( 'navMenuL10n', window.navMenuL10n );
+window.navMenuL10n = deprecateL10nObject( 'navMenuL10n', window.navMenuL10n, '5.5.0' );
 
 /**
@@ -335 +337 @@
 };
 
-window.commentL10n = deprecateL10nObject( 'commentL10n', window.commentL10n );
+window.commentL10n = deprecateL10nObject( 'commentL10n', window.commentL10n, '5.5.0' );
 
 /**
@@ -350 +352 @@
 };
 
-window.setPostThumbnailL10n = deprecateL10nObject( 'setPostThumbnailL10n', window.setPostThumbnailL10n );
+window.setPostThumbnailL10n = deprecateL10nObject( 'setPostThumbnailL10n', window.setPostThumbnailL10n, '5.5.0' );
 
 /**

trunk/src/js/_enqueues/admin/widgets.js

@@ -761 +761 @@
 };
 
-wpWidgets.l10n = window.wp.deprecateL10nObject( 'wpWidgets.l10n', wpWidgets.l10n );
+wpWidgets.l10n = window.wp.deprecateL10nObject( 'wpWidgets.l10n', wpWidgets.l10n, '5.5.0' );

trunk/src/js/_enqueues/wp/dashboard.js

@@ -6 +6 @@
 /* global ajaxPopulateWidgets, quickPressLoad,  */
 window.wp = window.wp || {};
+window.communityEventsData = window.communityEventsData || {};
 
 /**
@@ -266 +267 @@
     'use strict';
 
-    var communityEventsData = window.communityEventsData || {},
+    var communityEventsData = window.communityEventsData,
         dateI18n = wp.date.dateI18n,
         format = wp.date.format,
@@ -467 +468 @@
             var template,
                 elementVisibility,
-                l10nPlaceholder  = /%(?:\d\$)?s/g, // Match `%s`, `%1$s`, `%2$s`, etc.
                 $toggleButton    = $( '.community-events-toggle-location' ),
                 $locationMessage = $( '#community-events-location-message' ),
@@ -506 +506 @@
                  * provide events, but not a specific location.
                  */
-                $locationMessage.text( communityEventsData.l10n.attend_event_near_generic );
+                $locationMessage.text( __( 'Attend an upcoming event near you.' ) );
 
                 if ( templateParams.events.length ) {
@@ -533 +533 @@
 
                 if ( 'user' === initiatedBy ) {
-                    wp.a11y.speak( communityEventsData.l10n.city_updated.replace( l10nPlaceholder, templateParams.location.description ), 'assertive' );
+                    wp.a11y.speak(
+                        sprintf(
+                            /* translators: %s: The name of a city. */
+                            __( 'City updated. Listing events near %s.' ),
+                            templateParams.location.description
+                        ),
+                        'assertive'
+                    );
                 }
 
@@ -543 +550 @@
                 template = wp.template( 'community-events-could-not-locate' );
                 $( '.community-events-could-not-locate' ).html( template( templateParams ) );
-                wp.a11y.speak( communityEventsData.l10n.could_not_locate_city.replace( l10nPlaceholder, templateParams.unknownCity ) );
+                wp.a11y.speak(
+                    sprintf(
+                        /*
+                         * These specific examples were chosen to highlight the fact that a
+                         * state is not needed, even for cities whose name is not unique.
+                         * It would be too cumbersome to include that in the instructions
+                         * to the user, so it's left as an implication.
+                         */
+                        /*
+                         * translators: %s is the name of the city we couldn't locate.
+                         * Replace the examples with cities related to your locale. Test that
+                         * they match the expected location and have upcoming events before
+                         * including them. If no cities related to your locale have events,
+                         * then use cities related to your locale that would be recognizable
+                         * to most users. Use only the city name itself, without any region
+                         * or country. Use the endonym (native locale name) instead of the
+                         * English name if possible.
+                         */
+                        __( 'We couldn’t locate %s. Please try another nearby city. For example: Kansas City; Springfield; Portland.' ),
+                        templateParams.unknownCity
+                    )
+                );
 
                 elementVisibility['.community-events-errors']           = true;
@@ -555 +583 @@
                  * could be confusing or unnecessarily distracting.
                  */
-                wp.a11y.speak( communityEventsData.l10n.error_occurred_please_try_again );
+                wp.a11y.speak( __( 'An error occurred. Please try again.' ) );
 
                 elementVisibility['.community-events-errors']         = true;
                 elementVisibility['.community-events-error-occurred'] = true;
             } else {
-                $locationMessage.text( communityEventsData.l10n.enter_closest_city );
+                $locationMessage.text( __( 'Enter your closest city to find nearby events.' ) );
 
                 elementVisibility['#community-events-location-message'] = true;
@@ -792 +820 @@
     }
 });
+
+/**
+ * Removed in 5.6.0, needed for back-compatibility.
+ *
+ * @since 4.8.0
+ * @deprecated 5.6.0
+ *
+ * @type {object}
+*/
+window.communityEventsData.l10n = window.communityEventsData.l10n || {
+    enter_closest_city: '',
+    error_occurred_please_try_again: '',
+    attend_event_near_generic: '',
+    could_not_locate_city: '',
+    city_updated: ''
+};
+
+window.communityEventsData.l10n = window.wp.deprecateL10nObject( 'communityEventsData.l10n', window.communityEventsData.l10n, '5.6.0' );

trunk/src/js/_enqueues/wp/theme-plugin-editor.js

@@ -1024 +1024 @@
 };
 
-wp.themePluginEditor.l10n = window.wp.deprecateL10nObject( 'wp.themePluginEditor.l10n', wp.themePluginEditor.l10n );
+wp.themePluginEditor.l10n = window.wp.deprecateL10nObject( 'wp.themePluginEditor.l10n', wp.themePluginEditor.l10n, '5.5.0' );

trunk/src/js/_enqueues/wp/updates.js

@@ -116 +116 @@
     };
 
-    wp.updates.l10n = window.wp.deprecateL10nObject( 'wp.updates.l10n', wp.updates.l10n );
+    wp.updates.l10n = window.wp.deprecateL10nObject( 'wp.updates.l10n', wp.updates.l10n, '5.5.0' );
 
     /**

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

@@ -1758 +1758 @@
             'cache'       => $events_client->get_cached_events(),
             'time_format' => get_option( 'time_format' ),
-
-            'l10n'        => array(
-                'enter_closest_city'              => __( 'Enter your closest city to find nearby events.' ),
-                'error_occurred_please_try_again' => __( 'An error occurred. Please try again.' ),
-                'attend_event_near_generic'       => __( 'Attend an upcoming event near you.' ),
-
-                /*
-                 * These specific examples were chosen to highlight the fact that a
-                 * state is not needed, even for cities whose name is not unique.
-                 * It would be too cumbersome to include that in the instructions
-                 * to the user, so it's left as an implication.
-                 */
-                /*
-                 * translators: %s is the name of the city we couldn't locate.
-                 * Replace the examples with cities related to your locale. Test that
-                 * they match the expected location and have upcoming events before
-                 * including them. If no cities related to your locale have events,
-                 * then use cities related to your locale that would be recognizable
-                 * to most users. Use only the city name itself, without any region
-                 * or country. Use the endonym (native locale name) instead of the
-                 * English name if possible.
-                 */
-                'could_not_locate_city'           => __( 'We couldn’t locate %s. Please try another nearby city. For example: Kansas City; Springfield; Portland.' ),
-
-                // This one is only used with wp.a11y.speak(), so it can/should be more brief.
-                /* translators: %s: The name of a city. */
-                'city_updated'                    => __( 'City updated. Listing events near %s.' ),
-            ),
         )
     );

trunk/tests/qunit/index.html

@@ -83 +83 @@
             <script src="fixtures/js-widgets-endpoint.js"></script>
             <script src="fixtures/wp-api.js"></script>
+            <script src="fixtures/common.js"></script>
         </div>