<!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>[55224] trunk: I18N: Improve method names in `WP_Locale_Switcher()`.</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 { white-space: pre-line; 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/55224">55224</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/55224","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>2023-02-04 20:45:36 +0000 (Sat, 04 Feb 2023)</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: Improve method names in `WP_Locale_Switcher()`.
This is a follow-up to <a href="https://core.trac.wordpress.org/changeset/55161">[55161]</a> to rename `::get_current_locale()` to `::get_switched_locale()` and `::get_current_user_id()` to `::get_switched_user_id()` for improved clarity.
Also:
* Fix docblock for `switch_locale` filter. The User ID is `false` if missing, not `null`.
* Add additional test involving `restore_previous_locale()` and improve test cleanup.
And most importantly: happy birthday ocean90! {U+01F382}
Props johnjamesjacoby, ocean90.
See <a href="https://core.trac.wordpress.org/ticket/57123">#57123</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswplocaleswitcherphp">trunk/src/wp-includes/class-wp-locale-switcher.php</a></li>
<li><a href="#trunktestsphpunittestsl10nwpLocaleSwitcherphp">trunk/tests/phpunit/tests/l10n/wpLocaleSwitcher.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswplocaleswitcherphp"></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/class-wp-locale-switcher.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-locale-switcher.php 2023-02-04 15:35:29 UTC (rev 55223)
+++ trunk/src/wp-includes/class-wp-locale-switcher.php 2023-02-04 20:45:36 UTC (rev 55224)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -92,8 +92,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0 The `$user_id` parameter was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $locale The new locale.
- * @param null|int $user_id User ID for context if available.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $locale The new locale.
+ * @param false|int $user_id User ID for context if available.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'switch_locale', $locale, $user_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -186,7 +186,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string|false Locale if the locale has been switched, false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function get_current_locale() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function get_switched_locale() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $entry = end( $this->stack );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $entry ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -203,7 +203,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int|false User ID if set and if the locale has been switched, false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function get_current_user_id() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function get_switched_user_id() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $entry = end( $this->stack );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $entry ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -222,7 +222,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The locale currently being switched to.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function filter_locale( $locale ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $switched_locale = $this->get_current_locale();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $switched_locale = $this->get_switched_locale();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $switched_locale ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $switched_locale;
</span></span></pre></div>
<a id="trunktestsphpunittestsl10nwpLocaleSwitcherphp"></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/wpLocaleSwitcher.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/l10n/wpLocaleSwitcher.php 2023-02-04 15:35:29 UTC (rev 55223)
+++ trunk/tests/phpunit/tests/l10n/wpLocaleSwitcher.php 2023-02-04 20:45:36 UTC (rev 55224)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,6 +54,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_textdomain_registry = new WP_Textdomain_Registry();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Clean up after any tests that don't restore the locale afterwards,
+ // before resetting $wp_locale_switcher.
+ restore_current_locale();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'locale', array( $wp_locale_switcher, 'filter_locale' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_locale_switcher = new WP_Locale_Switcher();
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_locale_switcher->init();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -598,8 +602,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::switch_to_locale
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::switch_to_user_locale
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers WP_Locale_Switcher::get_current_locale
- * @covers WP_Locale_Switcher::get_current_user_id
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers WP_Locale_Switcher::get_switched_locale
+ * @covers WP_Locale_Switcher::get_switched_user_id
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_returns_current_locale_and_user_after_switching() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_locale_switcher;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -611,28 +615,28 @@
</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">- $locale_1 = $wp_locale_switcher->get_current_locale();
- $user_id_1 = $wp_locale_switcher->get_current_user_id();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $locale_1 = $wp_locale_switcher->get_switched_locale();
+ $user_id_1 = $wp_locale_switcher->get_switched_user_id();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> switch_to_user_locale( self::$user_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $locale_2 = $wp_locale_switcher->get_current_locale();
- $user_id_2 = $wp_locale_switcher->get_current_user_id();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $locale_2 = $wp_locale_switcher->get_switched_locale();
+ $user_id_2 = $wp_locale_switcher->get_switched_user_id();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> switch_to_locale( 'en_GB' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $locale_3 = $wp_locale_switcher->get_current_locale();
- $user_id_3 = $wp_locale_switcher->get_current_user_id();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $locale_3 = $wp_locale_switcher->get_switched_locale();
+ $user_id_3 = $wp_locale_switcher->get_switched_user_id();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> switch_to_user_locale( $user_2 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $locale_4 = $wp_locale_switcher->get_current_locale();
- $user_id_4 = $wp_locale_switcher->get_current_user_id();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $locale_4 = $wp_locale_switcher->get_switched_locale();
+ $user_id_4 = $wp_locale_switcher->get_switched_user_id();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> restore_current_locale();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $locale_5 = $wp_locale_switcher->get_current_locale();
- $user_id_5 = $wp_locale_switcher->get_current_user_id();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $locale_5 = $wp_locale_switcher->get_switched_locale();
+ $user_id_5 = $wp_locale_switcher->get_switched_user_id();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( $locale_1, 'Locale should be false before switching' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( $user_id_1, 'User ID should be false before switching' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -648,7 +652,48 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( $locale_5, 'Locale should be false after restoring' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( $user_id_5, 'User ID should be false after restoring' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 57123
+ *
+ * @covers ::switch_to_locale
+ * @covers ::switch_to_user_locale
+ * @covers WP_Locale_Switcher::get_switched_locale
+ * @covers WP_Locale_Switcher::get_switched_user_id
+ */
+ public function test_returns_previous_locale_and_user_after_switching() {
+ global $wp_locale_switcher;
+
+ $locale_1 = $wp_locale_switcher->get_switched_locale();
+ $user_id_1 = $wp_locale_switcher->get_switched_user_id();
+
+ switch_to_user_locale( self::$user_id );
+
+ $locale_2 = $wp_locale_switcher->get_switched_locale();
+ $user_id_2 = $wp_locale_switcher->get_switched_user_id();
+
+ switch_to_locale( 'en_GB' );
+
+ $locale_3 = $wp_locale_switcher->get_switched_locale();
+ $user_id_3 = $wp_locale_switcher->get_switched_user_id();
+
+ restore_previous_locale();
+
+ $locale_4 = $wp_locale_switcher->get_switched_locale();
+ $user_id_4 = $wp_locale_switcher->get_switched_user_id();
+
+ $this->assertFalse( $locale_1, 'Locale should be false before switching' );
+ $this->assertFalse( $user_id_1, 'User ID should be false before switching' );
+
+ $this->assertSame( 'de_DE', $locale_2, 'The locale was not changed to de_DE' );
+ $this->assertSame( self::$user_id, $user_id_2, 'User ID should match the main admin ID' );
+
+ $this->assertSame( 'en_GB', $locale_3, 'The locale was not changed to en_GB' );
+ $this->assertFalse( $user_id_3, 'User ID should be false after normal locale switching' );
+
+ $this->assertSame( 'de_DE', $locale_4, 'The locale was not changed back to de_DE' );
+ $this->assertSame( self::$user_id, $user_id_4, 'User ID should match the main admin ID again' );
</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"> public function filter_locale() {
</span></span></pre>
</div>
</div>
</body>
</html>