Skip to content

Commit

Permalink
I18N: Introduce WP_Textdomain_Registry to store text domains and th…
Browse files Browse the repository at this point in the history 
…eir language directory paths.

Previously, when using `switch_to_locale()` all current loaded text domains were unloaded and added to the `$l10n_unloaded` global. This prevented the just-in-time loading for text domains after a switch. The just-in-time loading was also only possible if the translations were stored in `WP_LANG_DIR`. Both issues have been fixed.

* Adds `WP_Textdomain_Registry` to keep track of the language directory paths for all plugins and themes.
* Updates all `load_*_textdomain()`  functions to store the path in `WP_Textdomain_Registry`.
* Adds `$locale` parameter to `load_textdomain()` to specify the locale the translation file is for.
* Adds `$reloadable` parameter to `unload_textdomain()` to define whether a text domain can be loaded just-in-time again. This is used by `WP_Locale_Switcher::load_translations()`.
* Extends `_load_textdomain_just_in_time()` to also support text domains of plugins and themes with custom language directories.
* Fixes the incorrect `test_plugin_translation_after_switching_locale_twice()` test which should have caught this issue earlier.
* Adds a new test plugin and theme to test the loading of translations with a custom language directory.
* Deprecates the now unused and private `_get_path_to_translation()` and `_get_path_to_translation_from_lang_dir()` functions.

Previously added in [49236] and reverted in [49236] to investigate concerns which are now addressed here.

Props yoavf, swissspidy, dd32, ocean90.
See #26511.
Fixes #39210.
Built from https://develop.svn.wordpress.org/trunk@53874


git-svn-id: http://core.svn.wordpress.org/trunk@53433 1a063a9b-81f0-0310-95a4-ce76da25c4cd
  • Loading branch information
@swissspidy
swissspidy committed Aug 11, 2022
1 parent 50e3e21 commit bb9f574
Show file tree
Hide file tree
Showing 6 changed files with 368 additions and 109 deletions.
10 changes: 6 additions & 4 deletions wp-includes/class-wp-locale-switcher.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,11 +196,14 @@ private function load_translations( $locale ) {
load_default_textdomain( $locale );

foreach ( $domains as $domain ) {
// The default text domain is handled by `load_default_textdomain()`.
if ( 'default' === $domain ) {
continue;
}

unload_textdomain( $domain );
// Unload current text domain but allow them to be reloaded
// after switching back or to another locale.
unload_textdomain( $domain, true );
get_translations_for_domain( $domain );
}
}
Expand All @@ -218,12 +221,11 @@ private function load_translations( $locale ) {
* @param string $locale The locale to change to.
*/
private function change_locale( $locale ) {
// Reset translation availability information.
_get_path_to_translation( null, true );
global $wp_locale;

$this->load_translations( $locale );

$GLOBALS['wp_locale'] = new WP_Locale();
$wp_locale = new WP_Locale();

/**
* Fires when the locale is switched to or restored.
Expand Down
184 changes: 184 additions & 0 deletions wp-includes/class-wp-textdomain-registry.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
<?php
/**
* Locale API: WP_Textdomain_Registry class
*
* @package WordPress
* @subpackage i18n
* @since 6.1.0
*/

/**
* Core class used for registering text domains.
*
* @since 6.1.0
*/
class WP_Textdomain_Registry {
/**
* List of domains and all their language directory paths for each locale.
*
* @since 6.1.0
*
* @var array
*/
protected $all = array();

/**
* List of domains and their language directory path for the current (most recent) locale.
*
* @since 6.1.0
*
* @var array
*/
protected $current = array();

/**
* Holds a cached list of available .mo files to improve performance.
*
* @since 6.1.0
*
* @var array
*/
protected $cached_mo_files;

/**
* Returns the MO file path for a specific domain and locale.
*
* @since 6.1.0
*
* @param string $domain Text domain.
* @param string $locale Locale.
*
* @return string|false MO file path or false if there is none available.
*/
public function get( $domain, $locale ) {
if ( isset( $this->all[ $domain ][ $locale ] ) ) {
return $this->all[ $domain ][ $locale ];
}

return $this->get_path_from_lang_dir( $domain, $locale );
}

/**
* Determines whether any MO file paths are available for the domain.
*
* @since 6.1.0
*
* @param string $domain Text domain.
* @return bool Whether any MO file paths are available for the domain.
*/
public function has( $domain ) {
return ! empty( $this->all[ $domain ] );
}

/**
* Returns the current (most recent) MO file path for a specific domain.
*
* @since 6.1.0
*
* @param string $domain Text domain.
* @return string|false Current MO file path or false if there is none available.
*/
public function get_current( $domain ) {
if ( isset( $this->current[ $domain ] ) ) {
return $this->current[ $domain ];
}

return false;
}

/**
* Sets the MO file path for a specific domain and locale.
*
* Also sets the 'current' property for direct access
* to the path for the current (most recent) locale.
*
* @since 6.1.0
*
* @param string $domain Text domain.
* @param string $locale Locale.
* @param string|false $path Language directory path or false if there is none available.
*/
public function set( $domain, $locale, $path ) {
$this->all[ $domain ][ $locale ] = $path ? trailingslashit( $path ) : false;
$this->current[ $domain ] = $this->all[ $domain ][ $locale ];
}

/**
* Resets the registry state.
*
* @since 6.1.0
*/
public function reset() {
$this->cached_mo_files = null;
$this->all = array();
$this->current = array();
}

/**
* Gets the path to a translation file in the languages directory for the current locale.
*
* @since 6.1.0
*
* @param string $domain Text domain.
* @param string $locale Locale.
* @return string|false MO file path or false if there is none available.
*/
private function get_path_from_lang_dir( $domain, $locale ) {
if ( null === $this->cached_mo_files ) {
$this->set_cached_mo_files();
}

$mofile = "{$domain}-{$locale}.mo";

$path = WP_LANG_DIR . '/plugins/' . $mofile;

if ( in_array( $path, $this->cached_mo_files, true ) ) {
$path = WP_LANG_DIR . '/plugins/';
$this->set( $domain, $locale, $path );

return $path;
}

$path = WP_LANG_DIR . '/themes/' . $mofile;
if ( in_array( $path, $this->cached_mo_files, true ) ) {
$path = WP_LANG_DIR . '/themes/';
$this->set( $domain, $locale, $path );

return $path;
}

// If no path is found for the given locale, check if an entry for the default
// en_US locale exists. This is the case when e.g. using load_plugin_textdomain
// with a custom path.
if ( 'en_US' !== $locale && isset( $this->all[ $domain ]['en_US'] ) ) {
$this->set( $domain, $locale, $this->all[ $domain ]['en_US'] );
return $this->all[ $domain ]['en_US'];
}

$this->set( $domain, $locale, false );

return false;
}

/**
* Reads and caches all available MO files from the plugins and themes language directories.
*
* @since 6.1.0
*/
protected function set_cached_mo_files() {
$this->cached_mo_files = array();

$locations = array(
WP_LANG_DIR . '/plugins',
WP_LANG_DIR . '/themes',
);

foreach ( $locations as $location ) {
$mo_files = glob( $location . '/*.mo' );

if ( $mo_files ) {
$this->cached_mo_files = array_merge( $this->cached_mo_files, $mo_files );
}
}
}
}
82 changes: 82 additions & 0 deletions wp-includes/deprecated.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4360,3 +4360,85 @@ function wp_get_attachment_thumb_file( $post_id = 0 ) {

return false;
}

/**
* Gets the path to a translation file for loading a textdomain just in time.
*
* Caches the retrieved results internally.
*
* @since 4.7.0
* @deprecated 6.1.0
* @access private
*
* @see _load_textdomain_just_in_time()
*
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @param bool $reset Whether to reset the internal cache. Used by the switch to locale functionality.
* @return string|false The path to the translation file or false if no translation file was found.
*/
function _get_path_to_translation( $domain, $reset = false ) {
_deprecated_function( __FUNCTION__, '6.1.0', 'WP_Textdomain_Registry' );

static $available_translations = array();

if ( true === $reset ) {
$available_translations = array();
}

if ( ! isset( $available_translations[ $domain ] ) ) {
$available_translations[ $domain ] = _get_path_to_translation_from_lang_dir( $domain );
}

return $available_translations[ $domain ];
}

/**
* Gets the path to a translation file in the languages directory for the current locale.
*
* Holds a cached list of available .mo files to improve performance.
*
* @since 4.7.0
* @deprecated 6.1.0
* @access private
*
* @see _get_path_to_translation()
*
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @return string|false The path to the translation file or false if no translation file was found.
*/
function _get_path_to_translation_from_lang_dir( $domain ) {
_deprecated_function( __FUNCTION__, '6.1.0', 'WP_Textdomain_Registry' );

static $cached_mofiles = null;

if ( null === $cached_mofiles ) {
$cached_mofiles = array();

$locations = array(
WP_LANG_DIR . '/plugins',
WP_LANG_DIR . '/themes',
);

foreach ( $locations as $location ) {
$mofiles = glob( $location . '/*.mo' );
if ( $mofiles ) {
$cached_mofiles = array_merge( $cached_mofiles, $mofiles );
}
}
}

$locale = determine_locale();
$mofile = "{$domain}-{$locale}.mo";

$path = WP_LANG_DIR . '/plugins/' . $mofile;
if ( in_array( $path, $cached_mofiles, true ) ) {
return $path;
}

$path = WP_LANG_DIR . '/themes/' . $mofile;
if ( in_array( $path, $cached_mofiles, true ) ) {
return $path;
}

return false;
}
Loading

0 comments on commit bb9f574

Please sign in to comment.