Changeset 57337 for trunk/src/wp-includes/l10n.php

Timestamp:

01/23/2024 01:32:34 PM (23 months ago)

Author:

swissspidy

Message:

I18N: Introduce a more performant localization library.

This introduces a more lightweight library for loading .mo translation files which offers increased speed and lower memory usage.
It also supports loading multiple locales at the same time, which makes locale switching faster too.

For plugins interacting with the $l10n global variable in core, a shim is added to retain backward compatibility with the existing pomo library.

In addition to that, this library supports translations contained in PHP files, avoiding a binary file format and leveraging OPCache if available.
If an .mo translation file has a corresponding .l10n.php file, the latter will be loaded instead.
This behavior can be adjusted using the new translation_file_format and load_translation_file filters.

PHP translation files will be typically created by downloading language packs, but can also be generated by plugins.
See ​https://make.wordpress.org/core/2023/11/08/merging-performant-translations-into-core/ for more context.

Props dd32, swissspidy, flixos90, joemcgill, westonruter, akirk, SergeyBiryukov.
Fixes #59656.

File:

• trunk/src/wp-includes/l10n.php (modified) (3 diffs)

trunk/src/wp-includes/l10n.php

@@ -798 +798 @@
     }
 
-    $mo = new MO();
-    if ( ! $mo->import_from_file( $mofile ) ) {
-        $wp_textdomain_registry->set( $domain, $locale, false );
-
-        return false;
-    }
-
-    if ( isset( $l10n[ $domain ] ) ) {
-        $mo->merge_with( $l10n[ $domain ] );
-    }
-
-    unset( $l10n_unloaded[ $domain ] );
-
-    $l10n[ $domain ] = &$mo;
-
-    $wp_textdomain_registry->set( $domain, $locale, dirname( $mofile ) );
+    $i18n_controller = WP_Translation_Controller::instance();
+
+    // Ensures the correct locale is set as the current one, in case it was filtered.
+    $i18n_controller->set_locale( $locale );
+
+    /**
+     * Filters the preferred file format for translation files.
+     *
+     * Can be used to disable the use of PHP files for translations.
+     *
+     * @since 6.5.0
+     *
+     * @param string $preferred_format Preferred file format. Possible values: 'php', 'mo'. Default: 'php'.
+     * @param string $domain           The text domain.
+     */
+    $preferred_format = apply_filters( 'translation_file_format', 'php', $domain );
+    if ( ! in_array( $preferred_format, array( 'php', 'mo' ), true ) ) {
+        $preferred_format = 'php';
+    }
+
+    $translation_files = array( $mofile );
+    if ( 'mo' !== $preferred_format ) {
+        array_unshift(
+            $translation_files,
+            substr_replace( $mofile, '.l10n.', - strlen( $preferred_format ) )
+        );
+    }
+
+    foreach ( $translation_files as $file ) {
+        /**
+         * Filters the file path for loading translations for the given text domain.
+         *
+         * Similar to the {@see 'load_textdomain_mofile'} filter with the difference that
+         * the file path could be for an MO or PHP file.
+         *
+         * @since 6.5.0
+         *
+         * @param string $file   Path to the translation file to load.
+         * @param string $domain The text domain.
+         */
+        $file = (string) apply_filters( 'load_translation_file', $file, $domain );
+
+        $success = $i18n_controller->load_file( $file, $domain, $locale );
+
+        if ( $success ) {
+            if ( isset( $l10n[ $domain ] ) && $l10n[ $domain ] instanceof MO ) {
+                $i18n_controller->load_file( $l10n[ $domain ]->get_filename(), $domain, $locale );
+            }
+
+            // Unset NOOP_Translations reference in get_translations_for_domain().
+            unset( $l10n[ $domain ] );
+
+            $l10n[ $domain ] = new WP_Translations( $i18n_controller, $domain );
+
+            $wp_textdomain_registry->set( $domain, $locale, dirname( $file ) );
+
+            return true;
+        }
+    }
 
     return true;
@@ -867 +910 @@
     do_action( 'unload_textdomain', $domain, $reloadable );
 
+    // Since multiple locales are supported, reloadable text domains don't actually need to be unloaded.
+    if ( ! $reloadable ) {
+        WP_Translation_Controller::instance()->unload_textdomain( $domain );
+    }
+
     if ( isset( $l10n[ $domain ] ) ) {
         if ( $l10n[ $domain ] instanceof NOOP_Translations ) {
@@ -905 +953 @@
 
     // Unload previously loaded strings so we can switch translations.
-    unload_textdomain( 'default' );
+    unload_textdomain( 'default', true );
 
     $return = load_textdomain( 'default', WP_LANG_DIR . "/$locale.mo", $locale );