Changeset 57516 for trunk/src/wp-includes/class-wp-textdomain-registry.php

Timestamp:

02/01/2024 07:03:55 PM (16 months ago)

Author:

swissspidy

Message:

I18N: Support loading .l10n.php translation files on their own.

Adjusts the translation file lookup in WP_Textdomain_Registry so that just-in-time translation loading
works even if there is only a .l10n.php translation file without a corresponding .mo file.

While language packs continue to contain both file types, this makes it easier to use translations in a project
without having to deal with .mo or .po files.

Props Chrystl.
See #59656.

File:

• trunk/src/wp-includes/class-wp-textdomain-registry.php (modified) (5 diffs)

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

@@ -151 +151 @@
 
     /**
-     * Retrieves .mo files from the specified path.
+     * Retrieves translation files from the specified path.
      *
      * Allows early retrieval through the {@see 'pre_get_mo_files_from_path'} filter to optimize
@@ -158 +158 @@
      * @since 6.5.0
      *
-     * @param string $path The directory path to search for .mo files.
-     * @return array Array of .mo file paths.
+     * @param string $path The directory path to search for translation files.
+     * @return array Array of translation file paths. Can contain .mo and .l10n.php files.
      */
     public function get_language_files_from_path( $path ) {
@@ -165 +165 @@
 
         /**
-         * Filters the .mo files retrieved from a specified path before the actual lookup.
+         * Filters the translation files retrieved from a specified path before the actual lookup.
          *
          * Returning a non-null value from the filter will effectively short-circuit
@@ -175 +175 @@
          * @since 6.5.0
          *
-         * @param null|array $mo_files List of .mo files. Default null.
-         * @param string $path The path from which .mo files are being fetched.
+         * @param null|array $files List of translation files. Default null.
+         * @param string $path The path from which translation files are being fetched.
          **/
-        $mo_files = apply_filters( 'pre_get_language_files_from_path', null, $path );
-
-        if ( null !== $mo_files ) {
-            return $mo_files;
+        $files = apply_filters( 'pre_get_language_files_from_path', null, $path );
+
+        if ( null !== $files ) {
+            return $files;
         }
 
         $cache_key = 'cached_mo_files_' . md5( $path );
-        $mo_files  = wp_cache_get( $cache_key, 'translations' );
-
-        if ( false === $mo_files ) {
-            $mo_files = glob( $path . '*.mo' );
-            if ( false === $mo_files ) {
-                $mo_files = array();
+        $files     = wp_cache_get( $cache_key, 'translations' );
+
+        if ( false === $files ) {
+            $files = glob( $path . '*.mo' );
+            if ( false === $files ) {
+                $files = array();
             }
-            wp_cache_set( $cache_key, $mo_files, 'translations' );
-        }
-
-        return $mo_files;
+
+            $php_files = glob( $path . '*.l10n.php' );
+            if ( is_array( $php_files ) ) {
+                $files = array_merge( $files, $php_files );
+            }
+
+            wp_cache_set( $cache_key, $files, 'translations' );
+        }
+
+        return $files;
     }
 
@@ -296 +302 @@
             $files = $this->get_language_files_from_path( $location );
 
-            $path = "$location/$domain-$locale.mo";
-
-            foreach ( $files as $mo_path ) {
+            $mo_path  = "$location/$domain-$locale.mo";
+            $php_path = "$location/$domain-$locale.l10n.php";
+
+            foreach ( $files as $file_path ) {
                 if (
                     ! in_array( $domain, $this->domains_with_translations, true ) &&
-                    str_starts_with( str_replace( "$location/", '', $mo_path ), "$domain-" )
+                    str_starts_with( str_replace( "$location/", '', $file_path ), "$domain-" )
                 ) {
                     $this->domains_with_translations[] = $domain;
                 }
 
-                if ( $mo_path === $path ) {
+                if ( $file_path === $mo_path || $file_path === $php_path ) {
                     $found_location = rtrim( $location, '/' ) . '/';
                 }