WordPress/wp-includes/class-wp-textdomain-registry.php
Dominik Schilling 173b9aa122 I18N: Introduce WP_Textdomain_Registry to store text domains and their 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 `$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 catch this issue earlier.
* Adds a new test plugin/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.

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


git-svn-id: http://core.svn.wordpress.org/trunk@48998 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-20 16:05:07 +00:00

131 lines
2.7 KiB
PHP

<?php
/**
* Locale API: WP_Textdomain_Registry class
*
* @package WordPress
* @subpackage i18n
* @since 5.6.0
*/
/**
* Core class used for registering text domains.
*
* @since 5.6.0
*/
class WP_Textdomain_Registry {
/**
* List of domains and their language directory paths.
*
* @since 5.6.0
*
* @var array
*/
protected $domains = array();
/**
* Holds a cached list of available .mo files to improve performance.
*
* @since 5.6.0
*
* @var array
*/
protected $cached_mo_files;
/**
* Returns the MO file path for a specific domain.
*
* @since 5.6.0
*
* @param string $domain Text domain.
* @return string|false MO file path or false if there is none available.
*/
public function get( $domain ) {
if ( isset( $this->domains[ $domain ] ) ) {
return $this->domains[ $domain ];
}
return $this->get_path_from_lang_dir( $domain );
}
/**
* Sets the MO file path for a specific domain.
*
* @since 5.6.0
*
* @param string $domain Text domain.
* @param string|false $path Language directory path or false if there is none available.
*/
public function set( $domain, $path ) {
$this->domains[ $domain ] = $path ? trailingslashit( $path ) : false;
}
/**
* Resets the registry state.
*
* @since 5.6.0
*/
public function reset() {
$this->cached_mo_files = null;
$this->domains = array();
}
/**
* Gets the path to a translation file in the languages directory for the current locale.
*
* @since 5.6.0
*
* @param string $domain Text domain.
* @return string|false MO file path or false if there is none available.
*/
private function get_path_from_lang_dir( $domain ) {
if ( null === $this->cached_mo_files ) {
$this->cached_mo_files = array();
$this->set_cached_mo_files();
}
$locale = determine_locale();
$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, $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, $path );
return $path;
}
$this->set( $domain, false );
return false;
}
/**
* Reads and caches all available MO files from the plugins and themes language directories.
*
* @since 5.6.0
*/
protected function set_cached_mo_files() {
$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 );
}
}
}
}