<!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>[55862] trunk: I18N: Refactor `determine_locale()` for performance and readability.</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/55862">55862</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/55862","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-05-26 17:55:40 +0000 (Fri, 26 May 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: Refactor `determine_locale()` for performance and readability.
Refactors the function to avoid unnecessary `get_locale()` calls and slightly improve performance, while keeping it readable.
Adds tests.
Props Cybr, spacedmonkey, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/58317">#58317</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesl10nphp">trunk/src/wp-includes/l10n.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsl10ndetermineLocalephp">trunk/tests/phpunit/tests/l10n/determineLocale.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2023-05-26 17:23:49 UTC (rev 55861)
+++ trunk/src/wp-includes/l10n.php 2023-05-26 17:55:40 UTC (rev 55862)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -132,32 +132,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $determined_locale = apply_filters( 'pre_determine_locale', null );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $determined_locale ) && is_string( $determined_locale ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $determined_locale && is_string( $determined_locale ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return $determined_locale;
</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">- $determined_locale = get_locale();
-
- if ( is_admin() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ isset( $GLOBALS['pagenow'] ) && 'wp-login.php' === $GLOBALS['pagenow'] &&
+ ( ! empty( $_GET['wp_lang'] ) || ! empty( $_COOKIE['wp_lang'] ) )
+ ) {
+ if ( ! empty( $_GET['wp_lang'] ) ) {
+ $determined_locale = sanitize_locale_name( $_GET['wp_lang'] );
+ } else {
+ $determined_locale = sanitize_locale_name( $_COOKIE['wp_lang'] );
+ }
+ } else if (
+ ( isset( $_GET['_locale'] ) && 'user' === $_GET['_locale'] && wp_is_json_request() ) ||
+ is_admin()
+ ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $determined_locale = get_user_locale();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ $determined_locale = get_locale();
</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">- if ( isset( $_GET['_locale'] ) && 'user' === $_GET['_locale'] && wp_is_json_request() ) {
- $determined_locale = get_user_locale();
- }
-
- $wp_lang = '';
-
- if ( ! empty( $_GET['wp_lang'] ) ) {
- $wp_lang = sanitize_locale_name( wp_unslash( $_GET['wp_lang'] ) );
- } elseif ( ! empty( $_COOKIE['wp_lang'] ) ) {
- $wp_lang = sanitize_locale_name( wp_unslash( $_COOKIE['wp_lang'] ) );
- }
-
- if ( ! empty( $wp_lang ) && ! empty( $GLOBALS['pagenow'] ) && 'wp-login.php' === $GLOBALS['pagenow'] ) {
- $determined_locale = $wp_lang;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the locale for the current request.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunktestsphpunittestsl10ndetermineLocalephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/l10n/determineLocale.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/l10n/determineLocale.php (rev 0)
+++ trunk/tests/phpunit/tests/l10n/determineLocale.php 2023-05-26 17:55:40 UTC (rev 55862)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,260 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group l10n
+ * @group i18n
+ *
+ * @covers ::determine_locale
+ */
+class Tests_L10n_DetermineLocale extends WP_UnitTestCase {
+ protected $locale;
+ protected static $user_id;
+
+ public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
+ self::$user_id = $factory->user->create(
+ array(
+ 'role' => 'administrator',
+ 'locale' => 'userLocale',
+ )
+ );
+ }
+
+ public function tear_down() {
+ unset( $_SERVER['CONTENT_TYPE'], $_GET['_locale'], $_COOKIE['wp_lang'], $GLOBALS['pagenow'] );
+
+ parent::tear_down();
+ }
+
+ public function test_short_circuit_empty() {
+ add_filter( 'pre_determine_locale', '__return_false' );
+ $this->assertNotFalse( determine_locale() );
+ }
+
+ public function test_short_circuit_no_string() {
+ add_filter(
+ 'pre_determine_locale',
+ static function() {
+ return 1234;
+ }
+ );
+ $this->assertNotFalse( determine_locale() );
+ }
+
+ public function test_short_circuit_string() {
+ add_filter(
+ 'pre_determine_locale',
+ static function() {
+ return 'myNewLocale';
+ }
+ );
+ $this->assertSame( 'myNewLocale', determine_locale() );
+ }
+
+ public function test_defaults_to_site_locale() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ $this->assertSame( get_locale(), determine_locale() );
+ }
+
+ public function test_is_admin_no_user() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ set_current_screen( 'dashboard' );
+
+ $this->assertSame( 'siteLocale', determine_locale() );
+ }
+
+ public function test_is_admin_user_locale() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ set_current_screen( 'dashboard' );
+ wp_set_current_user( self::$user_id );
+
+ $this->assertSame( 'userLocale', determine_locale() );
+ }
+
+ public function test_json_request_user_locale() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ wp_set_current_user( self::$user_id );
+
+ $_SERVER['CONTENT_TYPE'] = 'application/json';
+ $_GET['_locale'] = 'user';
+
+ $this->assertSame( 'userLocale', determine_locale() );
+ }
+
+ public function test_json_request_user_locale_no_user() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ $_SERVER['CONTENT_TYPE'] = 'application/json';
+ $_GET['_locale'] = 'user';
+
+ $this->assertSame( 'siteLocale', determine_locale() );
+ }
+
+ public function test_json_request_missing_get_param() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ wp_set_current_user( self::$user_id );
+
+ $_SERVER['CONTENT_TYPE'] = 'application/json';
+
+ $this->assertSame( 'siteLocale', determine_locale() );
+ }
+
+ public function test_json_request_incorrect_get_param() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ wp_set_current_user( self::$user_id );
+
+ $_SERVER['CONTENT_TYPE'] = 'application/json';
+ $_GET['_locale'] = 'foo';
+
+ $this->assertSame( 'siteLocale', determine_locale() );
+ }
+
+ public function test_get_param_but_no_json_request() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ wp_set_current_user( self::$user_id );
+
+ $_GET['_locale'] = 'user';
+
+ $this->assertSame( 'siteLocale', determine_locale() );
+ }
+
+ public function test_wp_login_get_param_not_on_login_page() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ wp_set_current_user( self::$user_id );
+
+ $_GET['wp_lang'] = 'de_DE';
+
+ $this->assertSame( 'siteLocale', determine_locale() );
+ }
+
+ public function test_wp_login_get_param_on_login_page() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ wp_set_current_user( self::$user_id );
+
+ $GLOBALS['pagenow'] = 'wp-login.php';
+ $_GET['wp_lang'] = 'de_DE';
+
+ $this->assertSame( 'de_DE', determine_locale() );
+ }
+
+ public function test_wp_login_get_param_on_login_page_empty_string() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ wp_set_current_user( self::$user_id );
+
+ $GLOBALS['pagenow'] = 'wp-login.php';
+ $_GET['wp_lang'] = '';
+
+ $this->assertSame( 'siteLocale', determine_locale() );
+ }
+
+ public function test_wp_login_cookie_not_on_login_page() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ wp_set_current_user( self::$user_id );
+
+ $_COOKIE['wp_lang'] = 'de_DE';
+
+ $this->assertSame( 'siteLocale', determine_locale() );
+ }
+
+ public function test_wp_login_cookie_on_login_page() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ wp_set_current_user( self::$user_id );
+
+ $GLOBALS['pagenow'] = 'wp-login.php';
+ $_COOKIE['wp_lang'] = 'de_DE';
+
+ $this->assertSame( 'de_DE', determine_locale() );
+ }
+
+ public function test_wp_login_cookie_on_login_page_empty_string() {
+ add_filter(
+ 'locale',
+ static function() {
+ return 'siteLocale';
+ }
+ );
+
+ wp_set_current_user( self::$user_id );
+
+ $GLOBALS['pagenow'] = 'wp-login.php';
+ $_COOKIE['wp_lang'] = '';
+
+ $this->assertSame( 'siteLocale', determine_locale() );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/l10n/determineLocale.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>