Ticket #58919: add_get_mo_files_from_path_2.diff

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

@@ -226 +226 @@
         private function set_cached_mo_files( $path ) {
                 $this->cached_mo_files[ $path ] = array();
 
-                $mo_files = glob( $path . '/*.mo' );
+                $mo_files = get_mo_files_from_path( $path );
 
                 if ( $mo_files ) {
                         $this->cached_mo_files[ $path ] = $mo_files;

src/wp-includes/default-filters.php

@@ -719 +719 @@
 // CPT wp_block custom postmeta field.
 add_action( 'init', 'wp_create_initial_post_meta' );
 
+// Localization (l10n).
+add_filter( 'pre_fetch_mo_files', 'cache_mo_files', 10, 2 );
+add_action( 'upgrader_process_complete', 'invalidate_mo_files_cache', 10, 2 );
+
 unset( $filter, $action );

src/wp-includes/l10n.php

@@ -1397 +1397 @@
 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 = get_mo_files_from_path( $path );
+
         if ( $lang_files ) {
                 foreach ( $lang_files as $lang_file ) {
                         $lang_file = basename( $lang_file, '.mo' );
@@ -1864 +1866 @@
 
         return $wp_locale->get_word_count_type();
 }
+
+/**
+ * Retrieves .mo files from the specified path.
+ *
+ * Allows early retrieval through the 'pre_fetch_mo_files' filter to optimize
+ * performance, especially in directories with many files.
+ *
+ * @since TBD
+ *
+ * @param string $path The directory path to search for .mo files.
+ * @return array Array of .mo file paths.
+ */
+function get_mo_files_from_path( $path ) {
+        /**
+        * Filters the .mo files retrieved from a specified path before the actual lookup.
+        *
+        * Returning a non-null value from the filter will effectively short-circuit
+        * the MO files lookup, returning that value instead.
+        *
+        * This can be useful in situations where the directory contains a large number of files
+        * and the default glob() function becomes expensive in terms of performance.
+        *
+        * @since TBD
+        *
+        * @param null|array $mo_files List of .mo files. Default null.
+        * @param string $path The path from which .mo files are being fetched.
+        **/
+        $mo_files = apply_filters( 'pre_fetch_mo_files', null, $path );
+        if ( null === $mo_files ) {
+                $mo_files = glob( $path . '/*.mo' );
+        }
+
+        return $mo_files;
+}
+
+/**
+ * Caches the .mo files from the specified path.
+ *
+ * This function retrieves and caches .mo files from a given path, avoiding repeated
+ * expensive filesystem lookups.
+ *
+ * @since TBD
+ *
+ * @param null|array $pre  List of .mo files. Default null.
+ * @param string     $path The directory path to search for .mo files.
+ * @return array|false Array of .mo file paths or false on failure.
+ */
+function cache_mo_files( $pre, $path ) {
+        $cache_key = 'cached_mo_files_' . md5( $path );
+        $mo_files  = wp_cache_get( $cache_key, 'translations' );
+
+        if ( false === $mo_files ) {
+                $mo_files = glob( $path . '/*.mo' );
+                wp_cache_set( $cache_key, $mo_files, 'translations' );
+                add_path_to_mo_files_cache_list( $path );
+        }
+
+        return $mo_files;
+}
+
+/**
+ * Adds a directory path to the list of paths with cached .mo files.
+ * This allows invalidate_mo_files_cache() to invalidate all cached paths.
+ *
+ * @since TBD
+ *
+ * @param string $path The directory path to add to the cached paths list.
+ */
+function add_path_to_mo_files_cache_list( $path ) {
+        $cached_paths = wp_cache_get( 'mo_files_cached_paths', 'translations' );
+
+        if ( false === $cached_paths || ! is_array( $cached_paths ) ) {
+                $cached_paths = array();
+        }
+
+        if ( ! in_array( $path, $cached_paths ) ) {
+                $cached_paths[] = $path;
+                wp_cache_set( 'mo_files_cached_paths', $cached_paths, 'translations' );
+        }
+}
+
+/**
+ * Invalidate the cache for .mo files.
+ *
+ * This function deletes the cache entries related to .mo files when triggered
+ * by specific actions, such as the completion of an upgrade process.
+ *
+ * @since TBD
+ *
+ * @param WP_Upgrader $upgrader_object The upgrader instance.
+ * @param array       $options         Array of bulk item update data.
+ */
+function invalidate_mo_files_cache( $upgrader_object, $options ) {
+        $cached_paths = wp_cache_get( 'mo_files_cached_paths', 'translations' );
+        if ( false !== $cached_paths && is_array( $cached_paths ) ) {
+                foreach ( $cached_paths as $path ) {
+                        wp_cache_delete( 'cached_mo_files_' . md5( $path ), 'translations' );
+                }
+        }
+        wp_cache_delete( 'mo_files_cached_paths', 'translations' );
+}