Changeset 40776

Timestamp:

05/18/2017 02:33:04 PM (7 years ago)

Author:

obenland

Message:

Dashboard: Properly localize data for events

Moves localization to script-loader and removes dependency for two strings.

Props dd32, iandunn.
See #40702.

Location:

trunk/src

Files:

• wp-admin/includes/dashboard.php (modified) (7 diffs)
• wp-admin/index.php (modified) (1 diff)
• wp-admin/network/index.php (modified) (1 diff)
• wp-includes/default-filters.php (modified) (1 diff)
• wp-includes/script-loader.php (modified) (1 diff)

trunk/src/wp-admin/includes/dashboard.php

@@ -128 +128 @@
     /** This action is documented in wp-admin/edit-form-advanced.php */
     do_action( 'do_meta_boxes', $screen->id, 'side', '' );
-}
-
-/**
- * Gets the community events data that needs to be passed to dashboard.js.
- *
- * @since 4.8.0
- *
- * @return array The script data.
- */
-function wp_get_community_events_script_data() {
-    require_once( ABSPATH . 'wp-admin/includes/class-wp-community-events.php' );
-
-    $user_id       = get_current_user_id();
-    $user_location = get_user_option( 'community-events-location', $user_id );
-    $events_client = new WP_Community_Events( $user_id, $user_location );
-
-    $script_data = 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 occured. Please try again.' ),
-
-            /*
-             * 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 in your locale, but test that they match the expected location before including them. Use endonyms (native locale names) whenever 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 is the name of a city. */
-            'city_updated' => __( 'City updated. Listing events near %s.' ),
-        )
-    );
-
-    return $script_data;
 }
 
@@ -1171 +1131 @@
  */
 function wp_print_community_events_markup() {
-    $script_data = wp_get_community_events_script_data();
-
     ?>
 
     <div class="community-events-errors notice notice-error inline hide-if-js">
         <p class="hide-if-js">
-            <?php _e( 'This widget requires JavaScript.'); ?>
+            <?php _e( 'This widget requires JavaScript.' ); ?>
         </p>
 
         <p class="community-events-error-occurred" aria-hidden="true">
-            <?php echo $script_data['l10n']['error_occurred_please_try_again']; ?>
+            <?php _e( 'An error occurred. Please try again.' ); ?>
         </p>
 
@@ -1188 +1146 @@
 
     <div class="community-events-loading hide-if-no-js">
-        <?php _e( 'Loading&hellip;'); ?>
+        <?php _e( 'Loading&hellip;' ); ?>
     </div>
 
@@ -1202 +1160 @@
                 <span id="community-events-location-message"></span>
 
-                <button class="button-link community-events-toggle-location" aria-label="<?php _e( 'Edit city'); ?>" aria-expanded="false">
+                <button class="button-link community-events-toggle-location" aria-label="<?php esc_attr_e( 'Edit city' ); ?>" aria-expanded="false">
                     <span class="dashicons dashicons-edit"></span>
                 </button>
@@ -1212 +1170 @@
                 </label>
                 <?php /* translators: Replace with the name of a city in your locale that shows events. Use only the city name itself, without any region or country. Use the endonym instead of the English name. */ ?>
-                <input id="community-events-location" class="regular-text" type="text" name="community-events-location" placeholder="<?php _e( 'Cincinnati' ); ?>" />
+                <input id="community-events-location" class="regular-text" type="text" name="community-events-location" placeholder="<?php esc_attr_e( 'Cincinnati' ); ?>" />
 
                 <?php submit_button( __( 'Submit' ), 'secondary', 'community-events-submit', false ); ?>
@@ -1236 +1194 @@
  */
 function wp_print_community_events_templates() {
-    $script_data = wp_get_community_events_script_data();
-
     ?>
 
@@ -1250 +1206 @@
     <script id="tmpl-community-events-could-not-locate" type="text/template">
         <?php printf(
-            $script_data['l10n']['could_not_locate_city'],
+            /* translators: %s is the name of the city we couldn't locate. Replace the examples with cities in your locale, but test that they match the expected location before including them. Use endonyms (native locale names) whenever possible. */
+            __( 'We couldn&#8217;t locate %s. Please try another nearby city. For example: Kansas City; Springfield; Portland.' ),
             '<em>{{data.unknownCity}}</em>'
         ); ?>

trunk/src/wp-admin/index.php

@@ -16 +16 @@
 
 wp_enqueue_script( 'dashboard' );
-wp_localize_script( 'dashboard', 'communityEventsData', wp_get_community_events_script_data() );
 
 if ( current_user_can( 'edit_theme_options' ) )

trunk/src/wp-admin/network/index.php

@@ -55 +55 @@
 
 wp_enqueue_script( 'dashboard' );
-wp_localize_script( 'dashboard', 'communityEventsData', wp_get_community_events_script_data() );
 wp_enqueue_script( 'plugin-install' );
 add_thickbox();

trunk/src/wp-includes/default-filters.php

@@ -435 +435 @@
 add_action( 'wp_enqueue_scripts', 'wp_localize_jquery_ui_datepicker', 1000 );
 add_action( 'admin_enqueue_scripts', 'wp_localize_jquery_ui_datepicker', 1000 );
+add_action( 'admin_print_scripts-index.php', 'wp_localize_community_events' );
 add_filter( 'wp_print_scripts', 'wp_just_in_time_script_localization' );
 add_filter( 'print_scripts_array', 'wp_prototype_before_jquery' );

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

@@ -1002 +1002 @@
 
 /**
+ * Localizes community events data that needs to be passed to dashboard.js.
+ *
+ * @since 4.8.0
+ */
+function wp_localize_community_events() {
+    if ( ! wp_script_is( 'dashboard' ) ) {
+        return;
+    }
+
+    require_once( ABSPATH . 'wp-admin/includes/class-wp-community-events.php' );
+
+    $user_id       = get_current_user_id();
+    $user_location = get_user_option( 'community-events-location', $user_id );
+    $events_client = new WP_Community_Events( $user_id, $user_location );
+
+    wp_localize_script( 'dashboard', 'communityEventsData', 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.' ),
+
+            /*
+             * 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 in your locale, but test that they match the expected location before including them. Use endonyms (native locale names) whenever 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 is the name of a city. */
+            'city_updated' => __( 'City updated. Listing events near %s.' ),
+        )
+    ) );
+}
+
+/**
  * Administration Screen CSS for changing the styles.
  *