Changeset 57639

Timestamp:

02/16/2024 10:26:14 AM (10 months ago)

Author:

swissspidy

Message:

I18N: Prevent incorrect language dropdown entries when there are .l10n.php files.

In [57516], the just-in-time translation loading logic was enhanced to support cases where only .l10n.php translation exist but no .mo or .po files. This caused a slight regression in get_available_languages(), which uses the list of files to populate the language dropdown list on the settings page.

To address this, the new file extension is now properly stripped off, and the resulting file list is de-duplicated. New test files are added to allow the existing tests to cover this new scenario.

See #59656.
Fixes #60553.

Location:

trunk

Files:

• src/wp-includes/class-wp-textdomain-registry.php (modified) (1 diff)
• src/wp-includes/l10n.php (modified) (5 diffs)
• tests/phpunit/data/languages/admin-en_GB.l10n.php (added)
• tests/phpunit/data/languages/admin-es_ES.l10n.php (added)
• tests/phpunit/data/languages/admin-network-en_GB.l10n.php (added)
• tests/phpunit/data/languages/admin-network-es_ES.l10n.php (added)
• tests/phpunit/data/languages/continents-cities-es_ES.l10n.php (added)
• tests/phpunit/data/languages/de_DE.l10n.php (added)
• tests/phpunit/data/languages/en_GB.l10n.php (added)
• tests/phpunit/data/languages/es_ES.l10n.php (added)
• tests/phpunit/data/languages/ja_JP.l10n.php (added)

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

@@ -315 +315 @@
                 if ( $file_path === $mo_path || $file_path === $php_path ) {
                     $found_location = rtrim( $location, '/' ) . '/';
+                    break 2;
                 }
             }

trunk/src/wp-includes/l10n.php

@@ -1436 +1436 @@
 
 /**
- * Gets all available languages based on the presence of *.mo files in a given directory.
+ * Gets all available languages based on the presence of *.mo and *.l10n.php files in a given directory.
  *
  * The default directory is WP_LANG_DIR.
@@ -1442 +1442 @@
  * @since 3.0.0
  * @since 4.7.0 The results are now filterable with the {@see 'get_available_languages'} filter.
+ * @since 6.5.0 The initial file list is now cached and also takes into account *.l10n.php files.
  *
  * @global WP_Textdomain_Registry $wp_textdomain_registry WordPress Textdomain Registry.
@@ -1448 +1449 @@
  *                    Default WP_LANG_DIR.
  * @return string[] An array of language codes or an empty array if no languages are present.
- *                  Language codes are formed by stripping the .mo extension from the language file names.
+ *                  Language codes are formed by stripping the file extension from the language file names.
  */
 function get_available_languages( $dir = null ) {
@@ -1461 +1462 @@
         foreach ( $lang_files as $lang_file ) {
             $lang_file = basename( $lang_file, '.mo' );
+            $lang_file = basename( $lang_file, '.l10n.php' );
+
             if ( ! str_starts_with( $lang_file, 'continents-cities' ) && ! str_starts_with( $lang_file, 'ms-' ) &&
                 ! str_starts_with( $lang_file, 'admin-' ) ) {
@@ -1476 +1479 @@
      * @param string   $dir       The directory where the language files were found.
      */
-    return apply_filters( 'get_available_languages', $languages, $dir );
+    return apply_filters( 'get_available_languages', array_unique( $languages ), $dir );
 }