Changeset 53874 for trunk/src/wp-includes/deprecated.php

Timestamp:

08/11/2022 12:37:05 PM (3 years ago)

Author:

swissspidy

Message:

I18N: Introduce WP_Textdomain_Registry to store text domains and their language directory paths.

Previously, when using switch_to_locale() all current loaded text domains were unloaded and added to the $l10n_unloaded global. This prevented the just-in-time loading for text domains after a switch. The just-in-time loading was also only possible if the translations were stored in WP_LANG_DIR. Both issues have been fixed.

• Adds WP_Textdomain_Registry to keep track of the language directory paths for all plugins and themes.
• Updates all load_*_textdomain() functions to store the path in WP_Textdomain_Registry.
• Adds $locale parameter to load_textdomain() to specify the locale the translation file is for.
• Adds $reloadable parameter to unload_textdomain() to define whether a text domain can be loaded just-in-time again. This is used by WP_Locale_Switcher::load_translations().
• Extends _load_textdomain_just_in_time() to also support text domains of plugins and themes with custom language directories.
• Fixes the incorrect test_plugin_translation_after_switching_locale_twice() test which should have caught this issue earlier.
• Adds a new test plugin and theme to test the loading of translations with a custom language directory.
• Deprecates the now unused and private _get_path_to_translation() and _get_path_to_translation_from_lang_dir() functions.

Previously added in [49236] and reverted in [49236] to investigate concerns which are now addressed here.

Props yoavf, swissspidy, dd32, ocean90.
See #26511.
Fixes #39210.

File:

• trunk/src/wp-includes/deprecated.php (modified) (1 diff)

trunk/src/wp-includes/deprecated.php

@@ -4361 +4361 @@
     return false;
 }
+
+/**
+ * Gets the path to a translation file for loading a textdomain just in time.
+ *
+ * Caches the retrieved results internally.
+ *
+ * @since 4.7.0
+ * @deprecated 6.1.0
+ * @access private
+ *
+ * @see _load_textdomain_just_in_time()
+ *
+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+ * @param bool   $reset  Whether to reset the internal cache. Used by the switch to locale functionality.
+ * @return string|false The path to the translation file or false if no translation file was found.
+ */
+function _get_path_to_translation( $domain, $reset = false ) {
+    _deprecated_function( __FUNCTION__, '6.1.0', 'WP_Textdomain_Registry' );
+
+    static $available_translations = array();
+
+    if ( true === $reset ) {
+        $available_translations = array();
+    }
+
+    if ( ! isset( $available_translations[ $domain ] ) ) {
+        $available_translations[ $domain ] = _get_path_to_translation_from_lang_dir( $domain );
+    }
+
+    return $available_translations[ $domain ];
+}
+
+/**
+ * Gets the path to a translation file in the languages directory for the current locale.
+ *
+ * Holds a cached list of available .mo files to improve performance.
+ *
+ * @since 4.7.0
+ * @deprecated 6.1.0
+ * @access private
+ *
+ * @see _get_path_to_translation()
+ *
+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+ * @return string|false The path to the translation file or false if no translation file was found.
+ */
+function _get_path_to_translation_from_lang_dir( $domain ) {
+    _deprecated_function( __FUNCTION__, '6.1.0', 'WP_Textdomain_Registry' );
+
+    static $cached_mofiles = null;
+
+    if ( null === $cached_mofiles ) {
+        $cached_mofiles = array();
+
+        $locations = array(
+            WP_LANG_DIR . '/plugins',
+            WP_LANG_DIR . '/themes',
+        );
+
+        foreach ( $locations as $location ) {
+            $mofiles = glob( $location . '/*.mo' );
+            if ( $mofiles ) {
+                $cached_mofiles = array_merge( $cached_mofiles, $mofiles );
+            }
+        }
+    }
+
+    $locale = determine_locale();
+    $mofile = "{$domain}-{$locale}.mo";
+
+    $path = WP_LANG_DIR . '/plugins/' . $mofile;
+    if ( in_array( $path, $cached_mofiles, true ) ) {
+        return $path;
+    }
+
+    $path = WP_LANG_DIR . '/themes/' . $mofile;
+    if ( in_array( $path, $cached_mofiles, true ) ) {
+        return $path;
+    }
+
+    return false;
+}