Changeset 54682 for branches/6.1/src/wp-includes/class-wp-textdomain-registry.php

Timestamp:

10/24/2022 06:35:30 PM (4 years ago)

Author:

ocean90

Message:

I18N: Change how WP_Textdomain_Registry stores the default languages path.

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

Said change has inadvertently caused a performance regression exactly when usingload_*_textdomain(), which still often is the case, where the cached information was not further used or even overridden.

This change addresses that issue by storing the default languages paths in a separate way, while at the same time making WP_Textdomain_Registry easier to maintain and adding new tests to catch future regressions.

Props flixos90, spacedmonkey, ocean90, SergeyBiryukov, costdev.
Merges [54669] to the 6.1 branch.
See #39210.

Location:

branches/6.1

Files:

• . (modified) (1 prop)
• src/wp-includes/class-wp-textdomain-registry.php (modified) (6 diffs)

branches/6.1/src/wp-includes/class-wp-textdomain-registry.php

@@ -34 +34 @@
 
         /**
+         * List of domains and their custom language directory paths.
+         *
+         * @see load_plugin_textdomain()
+         * @see load_theme_textdomain()
+         *
+         * @since 6.1.0
+         *
+         * @var array
+         */
+        protected $custom_paths = array();
+
+        /**
          * Holds a cached list of available .mo files to improve performance.
          *
@@ -43 +55 @@
 
         /**
-         * Returns the MO file path for a specific domain and locale.
+         * Returns the languages directory path for a specific domain and locale.
          *
          * @since 6.1.0
@@ -63 +75 @@
          * Determines whether any MO file paths are available for the domain.
          *
+         * This is the case if a path has been set for the current locale,
+         * or if there is no information stored yet, in which case
+         * {@see _load_textdomain_just_in_time()} will fetch the information first.
+         *
          * @since 6.1.0
          *
@@ -69 +85 @@
          */
         public function has( $domain ) {
-                return ! empty( $this->all[ $domain ] );
+                return ! empty( $this->current[ $domain ] ) || empty( $this->all[ $domain ] );
         }
 
         /**
-         * Returns the current (most recent) MO file path for a specific domain.
-         *
-         * @since 6.1.0
-         *
-         * @param string $domain Text domain.
-         * @return string|false Current MO file path or false if there is none available.
-         */
-        public function get_current( $domain ) {
-                if ( isset( $this->current[ $domain ] ) ) {
-                        return $this->current[ $domain ];
-                }
-
-                return false;
-        }
-
-        /**
-         * Sets the MO file path for a specific domain and locale.
+         * Sets the language directory path for a specific domain and locale.
          *
          * Also sets the 'current' property for direct access
@@ -106 +106 @@
 
         /**
-         * Resets the registry state.
+         * Sets the custom path to the plugin's/theme's languages directory.
          *
-         * @since 6.1.0
+         * Used by {@see load_plugin_textdomain()} and {@see load_theme_textdomain()}.
+         *
+         * @param string $domain Text domain.
+         * @param string $path   Language directory path.
          */
-        public function reset() {
-                $this->cached_mo_files = null;
-                $this->all             = array();
-                $this->current         = array();
+        public function set_custom_path( $domain, $path ) {
+                $this->custom_paths[ $domain ] = untrailingslashit( $path );
         }
 
         /**
-         * Gets the path to a translation file in the languages directory for the current locale.
+         * 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 MO file path or false if there is none available.
+         * @return string|false Language directory path or false if there is none available.
          */
         private function get_path_from_lang_dir( $domain, $locale ) {
-                if ( null === $this->cached_mo_files ) {
-                        $this->set_cached_mo_files();
+                $locations = array(
+                        WP_LANG_DIR . '/plugins',
+                        WP_LANG_DIR . '/themes',
+                );
+
+                if ( isset( $this->custom_paths[ $domain ] ) ) {
+                        $locations[] = $this->custom_paths[ $domain ];
                 }
 
-                $mofile = "{$domain}-{$locale}.mo";
+                $mofile = "$domain-$locale.mo";
 
-                $path = WP_LANG_DIR . '/plugins/' . $mofile;
+                foreach ( $locations as $location ) {
+                        if ( ! isset( $this->cached_mo_files[ $location ] ) ) {
+                                $this->set_cached_mo_files( $location );
+                        }
 
-                if ( in_array( $path, $this->cached_mo_files, true ) ) {
-                        $path = WP_LANG_DIR . '/plugins/';
-                        $this->set( $domain, $locale, $path );
+                        $path = $location . '/' . $mofile;
 
-                        return $path;
+                        if ( in_array( $path, $this->cached_mo_files[ $location ], true ) ) {
+                                $this->set( $domain, $locale, $location );
+
+                                return trailingslashit( $location );
+                        }
                 }
 
-                $path = WP_LANG_DIR . '/themes/' . $mofile;
-                if ( in_array( $path, $this->cached_mo_files, true ) ) {
-                        $path = WP_LANG_DIR . '/themes/';
+                // If no path is found for the given locale and a custom path has been set
+                // 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;
-                }
-
-                // If no path is found for the given locale, check if an entry for the default
-                // en_US locale exists. This is the case when e.g. using load_plugin_textdomain
-                // with a custom path.
-                if ( 'en_US' !== $locale && isset( $this->all[ $domain ]['en_US'] ) ) {
-                        $this->set( $domain, $locale, $this->all[ $domain ]['en_US'] );
-                        return $this->all[ $domain ]['en_US'];
                 }
 
@@ -163 +171 @@
 
         /**
-         * Reads and caches all available MO files from the plugins and themes language directories.
+         * Reads and caches all available MO files from a given directory.
          *
          * @since 6.1.0
+         *
+         * @param string $path Language directory path.
          */
-        protected function set_cached_mo_files() {
-                $this->cached_mo_files = array();
+        private function set_cached_mo_files( $path ) {
+                $this->cached_mo_files[ $path ] = array();
 
-                $locations = array(
-                        WP_LANG_DIR . '/plugins',
-                        WP_LANG_DIR . '/themes',
-                );
+                $mo_files = glob( $path . '/*.mo' );
 
-                foreach ( $locations as $location ) {
-                        $mo_files = glob( $location . '/*.mo' );
-
-                        if ( $mo_files ) {
-                                $this->cached_mo_files = array_merge( $this->cached_mo_files, $mo_files );
-                        }
+                if ( $mo_files ) {
+                        $this->cached_mo_files[ $path ] = $mo_files;
                 }
         }