Changeset 55010 for trunk/src/wp-includes/class-wp-textdomain-registry.php

Timestamp:

12/20/2022 03:10:35 PM (22 months ago)

Author:

swissspidy

Message:

I18N: Change how WP_Textdomain_Registry caches translation information.

WP_Textdomain_Registry was introduced in [53874] and later adjusted in [54682] to store text domains and their language directory paths, addressing issues with just-in-time loading of textdomains when using locale switching and load_*_textdomain() functions.

This change improves how the class stores information about all existing MO files on the site, addressing an issue where translations are not loaded after calling switch_to_locale().

Props johnbillion, ocean90, SergeyBiryukov.
Fixes #57116.

File:

• trunk/src/wp-includes/class-wp-textdomain-registry.php (modified) (7 diffs)

trunk/src/wp-includes/class-wp-textdomain-registry.php

@@ -52 +52 @@
      * @var array
      */
-    protected $cached_mo_files;
+    protected $cached_mo_files = array();
+
+    /**
+     * Holds a cached list of domains with translations to improve performance.
+     *
+     * @since 6.1.2
+     *
+     * @var string[]
+     */
+    protected $domains_with_translations = array();
 
     /**
@@ -85 +94 @@
      */
     public function has( $domain ) {
-        return ! empty( $this->current[ $domain ] ) || empty( $this->all[ $domain ] );
+        return (
+            ! empty( $this->current[ $domain ] ) ||
+            empty( $this->all[ $domain ] ) ||
+            in_array( $domain, $this->domains_with_translations, true )
+        );
     }
 
@@ -110 +123 @@
      * Used by {@see load_plugin_textdomain()} and {@see load_theme_textdomain()}.
      *
+     * @since 6.1.0
+     *
      * @param string $domain Text domain.
      * @param string $path   Language directory path.
@@ -118 +133 @@
 
     /**
-     * Gets the path to the language directory for the current locale.
-     *
-     * Checks the plugins and themes language directories as well as any
-     * custom directory set via {@see load_plugin_textdomain()} or {@see load_theme_textdomain()}.
-     *
-     * @since 6.1.0
-     *
-     * @see _get_path_to_translation_from_lang_dir()
-     *
-     * @param string $domain Text domain.
-     * @param string $locale Locale.
-     * @return string|false Language directory path or false if there is none available.
-     */
-    private function get_path_from_lang_dir( $domain, $locale ) {
+     * Returns possible language directory paths for a given text domain.
+     *
+     * @since 6.1.2
+     *
+     * @param string $domain Text domain.
+     * @return string[] Array of language directory paths.
+     */
+    private function get_paths_for_domain( $domain ) {
         $locations = array(
             WP_LANG_DIR . '/plugins',
@@ -141 +150 @@
         }
 
-        $mofile = "$domain-$locale.mo";
+        return $locations;
+    }
+
+    /**
+     * Gets the path to the language directory for the current locale.
+     *
+     * Checks the plugins and themes language directories as well as any
+     * custom directory set via {@see load_plugin_textdomain()} or {@see load_theme_textdomain()}.
+     *
+     * @since 6.1.0
+     *
+     * @see _get_path_to_translation_from_lang_dir()
+     *
+     * @param string $domain Text domain.
+     * @param string $locale Locale.
+     * @return string|false Language directory path or false if there is none available.
+     */
+    private function get_path_from_lang_dir( $domain, $locale ) {
+        $locations = $this->get_paths_for_domain( $domain );
+
+        $found_location = false;
 
         foreach ( $locations as $location ) {
@@ -148 +177 @@
             }
 
-            $path = $location . '/' . $mofile;
-
-            if ( in_array( $path, $this->cached_mo_files[ $location ], true ) ) {
-                $this->set( $domain, $locale, $location );
-
-                return trailingslashit( $location );
+            $path = "$location/$domain-$locale.mo";
+
+            foreach ( $this->cached_mo_files[ $location ] as $mo_path ) {
+                if (
+                    ! in_array( $domain, $this->domains_with_translations, true ) &&
+                    str_starts_with( str_replace( "$location/", '', $mo_path ), "$domain-" )
+                ) {
+                    $this->domains_with_translations[] = $domain;
+                }
+
+                if ( $mo_path === $path ) {
+                    $found_location = trailingslashit( $location );
+                }
             }
+        }
+
+        if ( $found_location ) {
+            $this->set( $domain, $locale, $found_location );
+
+            return $found_location;
         }
 
@@ -160 +202 @@
         // using load_plugin_textdomain/load_theme_textdomain, use that one.
         if ( 'en_US' !== $locale && isset( $this->custom_paths[ $domain ] ) ) {
-            $path = trailingslashit( $this->custom_paths[ $domain ] );
-            $this->set( $domain, $locale, $path );
-            return $path;
+            $fallback_location = trailingslashit( $this->custom_paths[ $domain ] );
+            $this->set( $domain, $locale, $fallback_location );
+            return $fallback_location;
         }