Changeset 57287

Timestamp:

01/15/2024 07:03:27 PM (7 months ago)

Author:

swissspidy

Message:

I18N: Cache list of language file paths in WP_Textdomain_Registry.

Loading a list of language file paths using glob() can be expensive if involving thousands of files.

Expands scope of WP_Textdomain_Registry to cache list of language file paths in object cache and provides a way to invalidate that cache upon translation updates. Plugins can clear the cache using calls such as wp_cache_delete( 'cached_mo_files_' . md5( $path ), 'translations' );

Props mreishus, swissspidy
Fixes #58919

Location:

trunk

Files:

• src/wp-includes/class-wp-textdomain-registry.php (modified) (6 diffs)
• src/wp-includes/l10n.php (modified) (2 diffs)
• src/wp-settings.php (modified) (1 diff)
• tests/phpunit/tests/l10n/wpTextdomainRegistry.php (modified) (6 diffs)

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

@@ -52 +52 @@
      *
      * @since 6.1.0
+
      *
      * @var array
+
+
      */
     protected $cached_mo_files = array();
@@ -65 +68 @@
      */
     protected $domains_with_translations = array();
+
+
+
+
+
+
+
+
+
+
+
+
 
     /**
@@ -136 +151 @@
 
     /**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      * Returns possible language directory paths for a given text domain.
      *
@@ -157 +272 @@
 
     /**
-     * Gets the path to the language 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
@@ -176 +291 @@
 
         foreach ( $locations as $location ) {
-            if ( ! isset( $this->cached_mo_files[ $location ] ) ) {
-                $this->set_cached_mo_files( $location );
-            }
+            $files = $this->get_language_files_from_path( $location );
 
             $path = "$location/$domain-$locale.mo";
 
-            foreach ( $this->cached_mo_files[ $location ] as $mo_path ) {
+            foreach ( $ as $mo_path ) {
                 if (
                     ! in_array( $domain, $this->domains_with_translations, true ) &&
@@ -216 +329 @@
         return false;
     }
-
-    /**
-     * Reads and caches all available MO files from a given directory.
-     *
-     * @since 6.1.0
-     *
-     * @param string $path Language directory path.
-     */
-    private function set_cached_mo_files( $path ) {
-        $this->cached_mo_files[ $path ] = array();
-
-        $mo_files = glob( $path . '/*.mo' );
-
-        if ( $mo_files ) {
-            $this->cached_mo_files[ $path ] = $mo_files;
-        }
-    }
 }

trunk/src/wp-includes/l10n.php

@@ -1399 +1399 @@
  * @since 4.7.0 The results are now filterable with the {@see 'get_available_languages'} filter.
  *
+
+
  * @param string $dir A directory to search for language files.
  *                    Default WP_LANG_DIR.
@@ -1405 +1407 @@
  */
 function get_available_languages( $dir = null ) {
+
+
     $languages = array();
 
-    $lang_files = glob( ( is_null( $dir ) ? WP_LANG_DIR : $dir ) . '/*.mo' );
+    $path       = is_null( $dir ) ? WP_LANG_DIR : $dir;
+    $lang_files = $wp_textdomain_registry->get_language_files_from_path( $path );
+
     if ( $lang_files ) {
         foreach ( $lang_files as $lang_file ) {

trunk/src/wp-settings.php

@@ -381 +381 @@
  */
 $GLOBALS['wp_textdomain_registry'] = new WP_Textdomain_Registry();
+
 
 // Load multisite-specific files.

trunk/tests/phpunit/tests/l10n/wpTextdomainRegistry.php

@@ -19 +19 @@
     }
 
+
+
+
+
+
+
+
+
+
     /**
      * @covers ::has
@@ -25 +34 @@
      */
     public function test_set_custom_path() {
-        $reflection          = new ReflectionClass( $this->instance );
-        $reflection_property = $reflection->getProperty( 'cached_mo_files' );
-        $reflection_property->setAccessible( true );
-
-        $this->assertEmpty(
-            $reflection_property->getValue( $this->instance ),
-            'Cache not empty by default'
-        );
-
         $this->instance->set_custom_path( 'foo', WP_LANG_DIR . '/bar' );
 
@@ -49 +49 @@
             'Custom path for textdomain not returned'
         );
-        $this->assertArrayHasKey(
-            WP_LANG_DIR . '/bar',
-            $reflection_property->getValue( $this->instance ),
-            'Custom path missing from cache'
+        $this->assertNotFalse(
+            wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . 'bar/' ), 'translations' ),
+            'List of files in custom path not cached'
         );
     }
@@ -61 +60 @@
      */
     public function test_get( $domain, $locale, $expected ) {
-        $reflection          = new ReflectionClass( $this->instance );
-        $reflection_property = $reflection->getProperty( 'cached_mo_files' );
-        $reflection_property->setAccessible( true );
-
         $actual = $this->instance->get( $domain, $locale );
         $this->assertSame(
@@ -70 +65 @@
             $actual,
             'Expected languages directory path not matching actual one'
-        );
-
-        $this->assertArrayHasKey(
-            WP_LANG_DIR . '/plugins',
-            $reflection_property->getValue( $this->instance ),
-            'Default plugins path missing from cache'
         );
     }
@@ -90 +79 @@
             $this->instance->get( 'foo-plugin', 'de_DE' )
         );
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     }