<!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>[39169] trunk: I18N: Add ability to change user's locale back to site's locale.</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/39169">39169</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/39169","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-11-08 23:00:38 +0000 (Tue, 08 Nov 2016)</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'>I18N: Add ability to change user's locale back to site's locale.
Previously there was no way to remove the user locale setting again, even though that might be desirable.
This adds a new 'Site Default' option to the user-specific language setting by introducing a new `show_site_locale_default` argument to `wp_dropdown_languages()`.
Props ocean90.
See <a href="https://core.trac.wordpress.org/ticket/29783">#29783</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/38632">#38632</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesuserphp">trunk/src/wp-admin/includes/user.php</a></li>
<li><a href="#trunksrcwpadminusereditphp">trunk/src/wp-admin/user-edit.php</a></li>
<li><a href="#trunksrcwpincludesl10nphp">trunk/src/wp-includes/l10n.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestuserscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php</a></li>
<li><a href="#trunktestsphpunittestsl10nphp">trunk/tests/phpunit/tests/l10n.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestuserscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-users-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesuserphp"></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/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/user.php 2016-11-08 22:40:28 UTC (rev 39168)
+++ trunk/src/wp-admin/includes/user.php 2016-11-08 23:00:38 UTC (rev 39169)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -98,11 +98,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $_POST['locale'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $locale = sanitize_text_field( $_POST['locale'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! in_array( $locale, get_available_languages(), true ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'site-default' === $locale ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $locale = '';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( ! in_array( $locale, get_available_languages(), true ) ) {
+ $locale = 'en_US';
</ins><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">- $user->locale = ( '' === $locale ) ? 'en_US' : $locale;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user->locale = $locale;
</ins><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></span></pre></div>
<a id="trunksrcwpadminusereditphp"></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/user-edit.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/user-edit.php 2016-11-08 22:40:28 UTC (rev 39168)
+++ trunk/src/wp-admin/user-edit.php 2016-11-08 23:00:38 UTC (rev 39169)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -284,9 +284,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $user_locale = $profileuser->locale;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'en_US' === $user_locale ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user_locale = false;
- } elseif ( ! in_array( $user_locale, $languages, true ) ) {
- $user_locale = get_locale();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_locale = '';
+ } elseif ( '' === $user_locale || ! in_array( $user_locale, $languages, true ) ) {
+ $user_locale = 'site-default';
</ins><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"> wp_dropdown_languages( array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -294,7 +294,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'id' => 'locale',
</span><span class="cx" style="display: block; padding: 0 10px"> 'selected' => $user_locale,
</span><span class="cx" style="display: block; padding: 0 10px"> 'languages' => $languages,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'show_available_translations' => false
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'show_available_translations' => false,
+ 'show_site_locale_default' => true
</ins><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"> </td>
</span></span></pre></div>
<a id="trunksrcwpincludesl10nphp"></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/l10n.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/l10n.php 2016-11-08 22:40:28 UTC (rev 39168)
+++ trunk/src/wp-includes/l10n.php 2016-11-08 23:00:38 UTC (rev 39169)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1048,6 +1048,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.3.0 Introduced the `echo` argument.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0 Introduced the `show_site_locale_default` argument.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see get_available_languages()
</span><span class="cx" style="display: block; padding: 0 10px"> * @see wp_get_available_translations()
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1065,6 +1066,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool|int $echo Whether to echo the generated markup. Accepts 0, 1, or their
</span><span class="cx" style="display: block; padding: 0 10px"> * boolean equivalents. Default 1.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $show_available_translations Whether to show available translations. Default true.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type bool $show_site_locale_default Whether to show an option to fall back to the site's locale. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string HTML content
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1078,8 +1080,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'selected' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'echo' => 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'show_available_translations' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'show_site_locale_default' => false,
</ins><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">+ // English (United States) uses an empty string for the value attribute.
+ if ( 'en_US' === $args['selected'] ) {
+ $args['selected'] = '';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $translations = $args['translations'];
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $translations ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> require_once( ABSPATH . 'wp-admin/includes/translation-install.php' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1122,7 +1130,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $translations_available ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $structure[] = '<optgroup label="' . esc_attr_x( 'Installed', 'translations' ) . '">';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $structure[] = '<option value="" lang="en" data-installed="1">English (United States)</option>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( $args['show_site_locale_default'] ) {
+ $structure[] = sprintf(
+ '<option value="site-default" data-installed="1"%s>%s</option>',
+ selected( 'site-default', $args['selected'], false ),
+ _x( 'Site Default', 'default site language' )
+ );
+ }
+
+ $structure[] = sprintf(
+ '<option value="" lang="en" data-installed="1"%s>English (United States)</option>',
+ selected( '', $args['selected'], false )
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $languages as $language ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $structure[] = sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<option value="%s" lang="%s"%s data-installed="1">%s</option>',
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestuserscontrollerphp"></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/rest-api/endpoints/class-wp-rest-users-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 2016-11-08 22:40:28 UTC (rev 39168)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 2016-11-08 23:00:38 UTC (rev 39169)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1074,7 +1074,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'locale' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Locale for the resource.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'enum' => array_merge( array( 'en_US' ), get_available_languages() ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'enum' => array_merge( array( '', 'en_US' ), get_available_languages() ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'edit' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'nickname' => array(
</span></span></pre></div>
<a id="trunktestsphpunittestsl10nphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/l10n.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/l10n.php 2016-11-08 22:40:28 UTC (rev 39168)
+++ trunk/tests/phpunit/tests/l10n.php 2016-11-08 23:00:38 UTC (rev 39169)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,6 +100,50 @@
</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">+ * @ticket 38632
+ */
+ function test_wp_dropdown_languages_site_default() {
+ $args = array(
+ 'id' => 'foo',
+ 'name' => 'bar',
+ 'languages' => array( 'de_DE' ),
+ 'translations' => $this->wp_dropdown_languages_filter(),
+ 'selected' => 'de_DE',
+ 'echo' => false,
+ 'show_site_locale_default' => true,
+ );
+ $actual = wp_dropdown_languages( $args );
+
+ $this->assertContains( 'id="foo"', $actual );
+ $this->assertContains( 'name="bar"', $actual );
+ $this->assertContains( '<option value="site-default" data-installed="1">Site Default</option>', $actual );
+ $this->assertContains( '<option value="" lang="en" data-installed="1">English (United States)</option>', $actual );
+ $this->assertContains( '<option value="de_DE" lang="de" selected=\'selected\' data-installed="1">Deutsch</option>', $actual );
+ $this->assertContains( '<option value="it_IT" lang="it">Italiano</option>', $actual );
+ }
+
+ /**
+ * @ticket 38632
+ */
+ function test_wp_dropdown_languages_en_US_selected() {
+ $args = array(
+ 'id' => 'foo',
+ 'name' => 'bar',
+ 'languages' => array( 'de_DE' ),
+ 'translations' => $this->wp_dropdown_languages_filter(),
+ 'selected' => 'en_US',
+ 'echo' => false,
+ );
+ $actual = wp_dropdown_languages( $args );
+
+ $this->assertContains( 'id="foo"', $actual );
+ $this->assertContains( 'name="bar"', $actual );
+ $this->assertContains( '<option value="" lang="en" data-installed="1" selected=\'selected\'>English (United States)</option>', $actual );
+ $this->assertContains( '<option value="de_DE" lang="de" data-installed="1">Deutsch</option>', $actual );
+ $this->assertContains( '<option value="it_IT" lang="it">Italiano</option>', $actual );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * We don't want to call the API when testing.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestuserscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-users-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-users-controller.php 2016-11-08 22:40:28 UTC (rev 39168)
+++ trunk/tests/phpunit/tests/rest-api/rest-users-controller.php 2016-11-08 23:00:38 UTC (rev 39169)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -879,6 +879,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'en_US', $user->locale );
</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">+ /**
+ * @ticket 38632
+ */
+ public function test_update_item_empty_locale() {
+ $user_id = $this->factory->user->create( array( 'user_login' => 'test_json_user', 'user_email' => 'testjson@example.com', 'locale' => 'de_DE' ) );
+ $this->allow_user_to_manage_multisite();
+ wp_set_current_user( self::$user );
+
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/users/' . $user_id );
+ $request->set_param( 'locale', '' );
+ $response = $this->server->dispatch( $request );
+ $this->check_add_edit_user_response( $response, true );
+
+ $data = $response->get_data();
+ $this->assertEquals( get_locale(), $data['locale'] );
+ $user = get_userdata( $user_id );
+ $this->assertEquals( '', $user->locale );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_update_item_username_attempt() {
</span><span class="cx" style="display: block; padding: 0 10px"> $user1 = $this->factory->user->create( array( 'user_login' => 'test_json_user', 'user_email' => 'testjson@example.com' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $user2 = $this->factory->user->create( array( 'user_login' => 'test_json_user2', 'user_email' => 'testjson2@example.com' ) );
</span></span></pre>
</div>
</div>
</body>
</html>