Changeset 55224 for trunk/src/wp-includes/class-wp-locale-switcher.php

Timestamp:

02/04/2023 08:45:36 PM (21 months ago)

Author:

swissspidy

Message:

I18N: Improve method names in WP_Locale_Switcher().

This is a follow-up to [55161] 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! 🎂

Props johnjamesjacoby, ocean90.
See #57123.

File:

• trunk/src/wp-includes/class-wp-locale-switcher.php (modified) (4 diffs)

trunk/src/wp-includes/class-wp-locale-switcher.php

@@ -93 +93 @@
          * @since 6.2.0 The `$user_id` parameter was added.
          *
-         * @param string   $locale  The new locale.
-         * @param null|int $user_id User ID for context if available.
+         * @param string    $locale  The new locale.
+         * @param false|int $user_id User ID for context if available.
          */
         do_action( 'switch_locale', $locale, $user_id );
@@ -187 +187 @@
      * @return string|false Locale if the locale has been switched, false otherwise.
      */
-    public function get_current_locale() {
+    public function get_switched_locale() {
         $entry = end( $this->stack );
 
@@ -204 +204 @@
      * @return int|false User ID if set and if the locale has been switched, false otherwise.
      */
-    public function get_current_user_id() {
+    public function get_switched_user_id() {
         $entry = end( $this->stack );
 
@@ -223 +223 @@
      */
     public function filter_locale( $locale ) {
-        $switched_locale = $this->get_current_locale();
+        $switched_locale = $this->get_switched_locale();
 
         if ( $switched_locale ) {