<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[40776] trunk/src: Dashboard: Properly localize data for events</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/40776">40776</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/40776","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>obenland</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-05-18 14:33:04 +0000 (Thu, 18 May 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Dashboard: Properly localize data for events
Moves localization to script-loader and removes dependency for two strings.
Props dd32, iandunn.
See <a href="https://core.trac.wordpress.org/ticket/40702">#40702</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesdashboardphp">trunk/src/wp-admin/includes/dashboard.php</a></li>
<li><a href="#trunksrcwpadminindexphp">trunk/src/wp-admin/index.php</a></li>
<li><a href="#trunksrcwpadminnetworkindexphp">trunk/src/wp-admin/network/index.php</a></li>
<li><a href="#trunksrcwpincludesdefaultfiltersphp">trunk/src/wp-includes/default-filters.php</a></li>
<li><a href="#trunksrcwpincludesscriptloaderphp">trunk/src/wp-includes/script-loader.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesdashboardphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/dashboard.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/dashboard.php 2017-05-18 11:05:09 UTC (rev 40775)
+++ trunk/src/wp-admin/includes/dashboard.php 2017-05-18 14:33:04 UTC (rev 40776)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -130,46 +130,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 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;
-}
-
-/**
</del><span class="cx" style="display: block; padding: 0 10px"> * Adds a new dashboard widget.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1170,24 +1130,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_print_community_events_markup() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $script_data = wp_get_community_events_script_data();
-
</del><span class="cx" style="display: block; padding: 0 10px"> ?>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="community-events-errors notice notice-error inline hide-if-js">
</span><span class="cx" style="display: block; padding: 0 10px"> <p class="hide-if-js">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php _e( 'This widget requires JavaScript.'); ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php _e( 'This widget requires JavaScript.' ); ?>
</ins><span class="cx" style="display: block; padding: 0 10px"> </p>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <p class="community-events-error-occurred" aria-hidden="true">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php echo $script_data['l10n']['error_occurred_please_try_again']; ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php _e( 'An error occurred. Please try again.' ); ?>
</ins><span class="cx" style="display: block; padding: 0 10px"> </p>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <p class="community-events-could-not-locate" aria-hidden="true"></p>
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="community-events-loading hide-if-no-js">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php _e( 'Loading…'); ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php _e( 'Loading…' ); ?>
</ins><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1201,7 +1159,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <p>
</span><span class="cx" style="display: block; padding: 0 10px"> <span id="community-events-location-message"></span>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <button class="button-link community-events-toggle-location" aria-label="<?php _e( 'Edit city'); ?>" aria-expanded="false">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <button class="button-link community-events-toggle-location" aria-label="<?php esc_attr_e( 'Edit city' ); ?>" aria-expanded="false">
</ins><span class="cx" style="display: block; padding: 0 10px"> <span class="dashicons dashicons-edit"></span>
</span><span class="cx" style="display: block; padding: 0 10px"> </button>
</span><span class="cx" style="display: block; padding: 0 10px"> </p>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1211,7 +1169,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php _e( 'City:' ); ?>
</span><span class="cx" style="display: block; padding: 0 10px"> </label>
</span><span class="cx" style="display: block; padding: 0 10px"> <?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. */ ?>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <input id="community-events-location" class="regular-text" type="text" name="community-events-location" placeholder="<?php _e( 'Cincinnati' ); ?>" />
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <input id="community-events-location" class="regular-text" type="text" name="community-events-location" placeholder="<?php esc_attr_e( 'Cincinnati' ); ?>" />
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <?php submit_button( __( 'Submit' ), 'secondary', 'community-events-submit', false ); ?>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1235,8 +1193,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_print_community_events_templates() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $script_data = wp_get_community_events_script_data();
-
</del><span class="cx" style="display: block; padding: 0 10px"> ?>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <script id="tmpl-community-events-attend-event-near" type="text/template">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1249,7 +1205,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <script id="tmpl-community-events-could-not-locate" type="text/template">
</span><span class="cx" style="display: block; padding: 0 10px"> <?php printf(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $script_data['l10n']['could_not_locate_city'],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* 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’t locate %s. Please try another nearby city. For example: Kansas City; Springfield; Portland.' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> '<em>{{data.unknownCity}}</em>'
</span><span class="cx" style="display: block; padding: 0 10px"> ); ?>
</span><span class="cx" style="display: block; padding: 0 10px"> </script>
</span></span></pre></div>
<a id="trunksrcwpadminindexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/index.php 2017-05-18 11:05:09 UTC (rev 40775)
+++ trunk/src/wp-admin/index.php 2017-05-18 14:33:04 UTC (rev 40776)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,7 +15,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_dashboard_setup();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_script( 'dashboard' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-wp_localize_script( 'dashboard', 'communityEventsData', wp_get_community_events_script_data() );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( current_user_can( 'edit_theme_options' ) )
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_script( 'customize-loader' );
</span></span></pre></div>
<a id="trunksrcwpadminnetworkindexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/network/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/network/index.php 2017-05-18 11:05:09 UTC (rev 40775)
+++ trunk/src/wp-admin/network/index.php 2017-05-18 14:33:04 UTC (rev 40776)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,7 +54,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_dashboard_setup();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_script( 'dashboard' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-wp_localize_script( 'dashboard', 'communityEventsData', wp_get_community_events_script_data() );
</del><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_script( 'plugin-install' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_thickbox();
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesdefaultfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-filters.php 2017-05-18 11:05:09 UTC (rev 40775)
+++ trunk/src/wp-includes/default-filters.php 2017-05-18 14:33:04 UTC (rev 40776)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -434,6 +434,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_default_scripts', 'wp_default_scripts' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_enqueue_scripts', 'wp_localize_jquery_ui_datepicker', 1000 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'admin_enqueue_scripts', 'wp_localize_jquery_ui_datepicker', 1000 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_action( 'admin_print_scripts-index.php', 'wp_localize_community_events' );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_print_scripts', 'wp_just_in_time_script_localization' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'print_scripts_array', 'wp_prototype_before_jquery' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'customize_controls_print_styles', 'wp_resource_hints', 1 );
</span></span></pre></div>
<a id="trunksrcwpincludesscriptloaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/script-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/script-loader.php 2017-05-18 11:05:09 UTC (rev 40775)
+++ trunk/src/wp-includes/script-loader.php 2017-05-18 14:33:04 UTC (rev 40776)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1001,6 +1001,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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.' ),
+ )
+ ) );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Administration Screen CSS for changing the styles.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If installing the 'wp-admin/' directory will be replaced with './'.
</span></span></pre>
</div>
</div>
</body>
</html>