Ticket #51498: 51498.patch

src/js/_enqueues/admin/common.js

@@ -55 +55 @@
  * Deprecate all properties on an object.
  *
  * @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 = {};
 
         Object.keys( l10nObject ).forEach( function( key ) {
@@ -70 +72 @@
 
                 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;
                         } } );
                 }
@@ -99 +101 @@
         expandMenu: ''
 };
 
-window.commonL10n = deprecateL10nObject( 'commonL10n', window.commonL10n );
+window.commonL10n = deprecateL10nObject( 'commonL10n', window.commonL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -111 +113 @@
         dismiss: ''
 };
 
-window.wpPointerL10n = deprecateL10nObject( 'wpPointerL10n', window.wpPointerL10n );
+window.wpPointerL10n = deprecateL10nObject( 'wpPointerL10n', window.wpPointerL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -129 +131 @@
         ariaHide: ''
 };
 
-window.userProfileL10n = deprecateL10nObject( 'userProfileL10n', window.userProfileL10n );
+window.userProfileL10n = deprecateL10nObject( 'userProfileL10n', window.userProfileL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -148 +150 @@
         exportError: ''
 };
 
-window.privacyToolsL10n = deprecateL10nObject( 'privacyToolsL10n', window.privacyToolsL10n );
+window.privacyToolsL10n = deprecateL10nObject( 'privacyToolsL10n', window.privacyToolsL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -160 +162 @@
         beforeunload: ''
 };
 
-window.authcheckL10n = window.authcheckL10n || deprecateL10nObject( 'authcheckL10n', window.authcheckL10n );
+window.authcheckL10n = window.authcheckL10n || deprecateL10nObject( 'authcheckL10n', window.authcheckL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -173 +175 @@
         broken: ''
 };
 
-window.tagsl10n = window.tagsl10n || deprecateL10nObject( 'tagsl10n', window.tagsl10n );
+window.tagsl10n = window.tagsl10n || deprecateL10nObject( 'tagsl10n', window.tagsl10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -198 +200 @@
         docTitleCommentsCount: ''
 };
 
-window.adminCommentsL10n = deprecateL10nObject( 'adminCommentsL10n', window.adminCommentsL10n );
+window.adminCommentsL10n = deprecateL10nObject( 'adminCommentsL10n', window.adminCommentsL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -214 +216 @@
         termRemoved: ''
 };
 
-window.tagsSuggestL10n = deprecateL10nObject( 'tagsSuggestL10n', window.tagsSuggestL10n );
+window.tagsSuggestL10n = deprecateL10nObject( 'tagsSuggestL10n', window.tagsSuggestL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -231 +233 @@
         defaultLabel: ''
 };
 
-window.wpColorPickerL10n = deprecateL10nObject( 'wpColorPickerL10n', window.wpColorPickerL10n );
+window.wpColorPickerL10n = deprecateL10nObject( 'wpColorPickerL10n', window.wpColorPickerL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -243 +245 @@
         error: ''
 };
 
-window.attachMediaBoxL10n = deprecateL10nObject( 'attachMediaBoxL10n', window.attachMediaBoxL10n );
+window.attachMediaBoxL10n = deprecateL10nObject( 'attachMediaBoxL10n', window.attachMediaBoxL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -276 +278 @@
         permalinkSaved: ''
 };
 
-window.postL10n = deprecateL10nObject( 'postL10n', window.postL10n );
+window.postL10n = deprecateL10nObject( 'postL10n', window.postL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -292 +294 @@
         saved: ''
 };
 
-window.inlineEditL10n = deprecateL10nObject( 'inlineEditL10n', window.inlineEditL10n );
+window.inlineEditL10n = deprecateL10nObject( 'inlineEditL10n', window.inlineEditL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -306 +308 @@
         ays: ''
 };
 
-window.plugininstallL10n = deprecateL10nObject( 'plugininstallL10n', window.plugininstallL10n );
+window.plugininstallL10n = deprecateL10nObject( 'plugininstallL10n', window.plugininstallL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -321 +323 @@
         untitled: ''
 };
 
-window.navMenuL10n = deprecateL10nObject( 'navMenuL10n', window.navMenuL10n );
+window.navMenuL10n = deprecateL10nObject( 'navMenuL10n', window.navMenuL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -334 +336 @@
         dateFormat: ''
 };
 
-window.commentL10n = deprecateL10nObject( 'commentL10n', window.commentL10n );
+window.commentL10n = deprecateL10nObject( 'commentL10n', window.commentL10n, '5.5.0' );
 
 /**
  * Removed in 5.5.0, needed for back-compatibility.
@@ -349 +351 @@
         done: ''
 };
 
-window.setPostThumbnailL10n = deprecateL10nObject( 'setPostThumbnailL10n', window.setPostThumbnailL10n );
+window.setPostThumbnailL10n = deprecateL10nObject( 'setPostThumbnailL10n', window.setPostThumbnailL10n, '5.5.0' );
 
 /**
  * Removed in 3.3.0, needed for back-compatibility.

src/js/_enqueues/admin/widgets.js

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

src/js/_enqueues/wp/dashboard.js

@@ -266 +266 @@
         'use strict';
 
         var communityEventsData = window.communityEventsData || {},
+                sprintf = wp.i18n.sprintf,
+                __ = wp.i18n.__,
                 app;
 
         /**
@@ -460 +462 @@
                 renderEventsTemplate: function( templateParams, initiatedBy ) {
                         var template,
                                 elementVisibility,
-                                l10nPlaceholder  = /%(?:\d\$)?s/g, // Match `%s`, `%1$s`, `%2$s`, etc.
                                 $toggleButton    = $( '.community-events-toggle-location' ),
                                 $locationMessage = $( '#community-events-location-message' ),
                                 $results         = $( '.community-events-results' );
@@ -494 +495 @@
                                  * If the API determined the location by geolocating an IP, it will
                                  * 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 ) {
                                         template = wp.template( 'community-events-event-list' );
@@ -521 +522 @@
                                 }
 
                                 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'
+                                        );
                                 }
 
                                 elementVisibility['#community-events-location-message'] = true;
@@ -531 +539 @@
                         } else if ( templateParams.unknownCity ) {
                                 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;
                                 elementVisibility['.community-events-could-not-locate'] = true;
@@ -543 +572 @@
                                  * Showing error messages for an event that user isn't aware of
                                  * 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;
                                 elementVisibility['.community-events-toggle-location']  = true;
@@ -591 +620 @@
                 });
         }
 });
+
+/**
+ * Removed in 5.6.0, needed for back-compatibility.
+ *
+ * @since 4.9.0
+ * @deprecated 5.6.0
+ *
+ * @type {object}
+*/
+window.communityEventsData = window.communityEventsData || {};
+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' );

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

@@ -1023 +1023 @@
         }
 };
 
-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' );

src/js/_enqueues/wp/updates.js

@@ -115 +115 @@
                 autoUpdatesError: ''
         };
 
-        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' );
 
         /**
          * User nonce for ajax calls.

src/wp-includes/script-loader.php

@@ -1309 +1309 @@
                 $scripts->set_translations( 'wp-color-picker' );
 
                 $scripts->add( 'dashboard', "/wp-admin/js/dashboard$suffix.js", array( 'jquery', 'admin-comments', 'postbox', 'wp-util', 'wp-a11y' ), false, 1 );
+                $scripts->set_translations( 'dashboard' );
 
                 $scripts->add( 'list-revisions', "/wp-includes/js/wp-list-revisions$suffix.js" );
 
@@ -1755 +1756 @@
                 array(
                         'nonce' => wp_create_nonce( 'community_events' ),
                         'cache' => $events_client->get_cached_events(),
-
-                        '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.' ),
-                        ),
                 )
         );
 }