Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-09-27 06:42:56 +02:00
Code Issues Projects Releases Wiki Activity

I18N: Change how WP_Textdomain_Registry stores the default languages path.

Browse Source 
`WP_Textdomain_Registry` was introduced in [53874] to store text domains and their language directory paths, addressing issues with just-in-time loading of textdomains when using locale switching and when using`load_*_textdomain()` functions.

Said change has inadvertently caused a performance regression exactly when using`load_*_textdomain()`, which still often is the case, where the cached information was not further used or even overridden.

This change addresses that issue by storing the default languages paths in a separate way, while at the same time making `WP_Textdomain_Registry` easier to maintain and adding new tests to catch future regressions.

Props flixos90, spacedmonkey, ocean90, SergeyBiryukov, costdev.
Fixes #39210.
Built from https://develop.svn.wordpress.org/trunk@54669


git-svn-id: http://core.svn.wordpress.org/trunk@54221 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Pascal Birchler 2022-10-24 10:02:16 +00:00
parent 7240236672
commit ba19b8412d
3 changed files with 71 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

129
wp-includes/class-wp-textdomain-registry.php
View File

@ -32,6 +32,18 @@ class WP_Textdomain_Registry {
*/ */
protected $current = array(); protected $current = array();
/**
* List of domains and their custom language directory paths.
*
* @see load_plugin_textdomain()
* @see load_theme_textdomain()
*
* @since 6.1.0
*
* @var array
*/
protected $custom_paths = array();
/** /**
* Holds a cached list of available .mo files to improve performance. * Holds a cached list of available .mo files to improve performance.
* *
@ -42,7 +54,7 @@ class WP_Textdomain_Registry {
protected $cached_mo_files; protected $cached_mo_files;
/** /**
* Returns the MO file path for a specific domain and locale. * Returns the languages directory path for a specific domain and locale.
* *
* @since 6.1.0 * @since 6.1.0
* *
@ -62,33 +74,21 @@ class WP_Textdomain_Registry {
/** /**
* Determines whether any MO file paths are available for the domain. * Determines whether any MO file paths are available for the domain.
* *
* This is the case if a path has been set for the current locale,
* or if there is no information stored yet, in which case
* {@see _load_textdomain_just_in_time()} will fetch the information first.
*
* @since 6.1.0 * @since 6.1.0
* *
* @param string $domain Text domain. * @param string $domain Text domain.
* @return bool Whether any MO file paths are available for the domain. * @return bool Whether any MO file paths are available for the domain.
*/ */
public function has( $domain ) { public function has( $domain ) {
return ! empty( $this->all[ $domain ] ); return ! empty( $this->current[ $domain ] ) || empty( $this->all[ $domain ] );
} }
/** /**
* Returns the current (most recent) MO file path for a specific domain. * Sets the language directory path for a specific domain and locale.
*
* @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 * Also sets the 'current' property for direct access
* to the path for the current (most recent) locale. * to the path for the current (most recent) locale.
@ -105,81 +105,84 @@ class WP_Textdomain_Registry {
} }
/** /**
* Resets the registry state. * Sets the custom path to the plugin's/theme's languages directory.
* *
* @since 6.1.0 * Used by {@see load_plugin_textdomain()} and {@see load_theme_textdomain()}.
*
* @param string $domain Text domain.
* @param string $path Language directory path.
*/ */
public function reset() { public function set_custom_path( $domain, $path ) {
$this->cached_mo_files = null; $this->custom_paths[ $domain ] = untrailingslashit( $path );
$this->all = array();
$this->current = array();
} }
/** /**
* Gets the path to a translation file in the languages directory for the current locale. * Gets the path to the language directory for the current locale.
*
* Checks the plugins and themes language directories as well as any
* custom directory set via {@see load_plugin_textdomain()} or {@see load_theme_textdomain()}.
* *
* @since 6.1.0 * @since 6.1.0
* *
* @see _get_path_to_translation_from_lang_dir()
*
* @param string $domain Text domain. * @param string $domain Text domain.
* @param string $locale Locale. * @param string $locale Locale.
* @return string|false MO file path or false if there is none available. * @return string|false Language directory path or false if there is none available.
*/ */
private function get_path_from_lang_dir( $domain, $locale ) { private function get_path_from_lang_dir( $domain, $locale ) {
if ( null === $this->cached_mo_files ) { $locations = array(
$this->set_cached_mo_files(); WP_LANG_DIR . '/plugins',
WP_LANG_DIR . '/themes',
);
if ( isset( $this->custom_paths[ $domain ] ) ) {
$locations[] = $this->custom_paths[ $domain ];
} }
$mofile = "{$domain}-{$locale}.mo"; $mofile = "$domain-$locale.mo";
$path = WP_LANG_DIR . '/plugins/' . $mofile; foreach ( $locations as $location ) {
if ( ! isset( $this->cached_mo_files[ $location ] ) ) {
$this->set_cached_mo_files( $location );
}
if ( in_array( $path, $this->cached_mo_files, true ) ) { $path = $location . '/' . $mofile;
$path = WP_LANG_DIR . '/plugins/';
if ( in_array( $path, $this->cached_mo_files[ $location ], true ) ) {
$this->set( $domain, $locale, $location );
return trailingslashit( $location );
}
}
// If no path is found for the given locale and a custom path has been set
// using load_plugin_textdomain/load_theme_textdomain, use that one.
if ( 'en_US' !== $locale && isset( $this->custom_paths[ $domain ] ) ) {
$path = trailingslashit( $this->custom_paths[ $domain ] );
$this->set( $domain, $locale, $path ); $this->set( $domain, $locale, $path );
return $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 ); $this->set( $domain, $locale, false );
return false; return false;
} }
/** /**
* Reads and caches all available MO files from the plugins and themes language directories. * Reads and caches all available MO files from a given directory.
* *
* @since 6.1.0 * @since 6.1.0
*
* @param string $path Language directory path.
*/ */
protected function set_cached_mo_files() { private function set_cached_mo_files( $path ) {
$this->cached_mo_files = array(); $this->cached_mo_files[ $path ] = array();
$locations = array( $mo_files = glob( $path . '/*.mo' );
WP_LANG_DIR . '/plugins',
WP_LANG_DIR . '/themes',
);
foreach ( $locations as $location ) { if ( $mo_files ) {
$mo_files = glob( $location . '/*.mo' ); $this->cached_mo_files[ $path ] = $mo_files;
if ( $mo_files ) {
$this->cached_mo_files = array_merge( $this->cached_mo_files, $mo_files );
}
} }
} }
} }

8
wp-includes/l10n.php
View File

@ -934,7 +934,7 @@ function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path
$path = WP_PLUGIN_DIR; $path = WP_PLUGIN_DIR;
} }
$wp_textdomain_registry->set( $domain, $locale, $path ); $wp_textdomain_registry->set_custom_path( $domain, $path );
return load_textdomain( $domain, $path . '/' . $mofile, $locale ); return load_textdomain( $domain, $path . '/' . $mofile, $locale );
} }
@ -968,7 +968,7 @@ function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
$path = WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' ); $path = WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' );
$wp_textdomain_registry->set( $domain, $locale, $path ); $wp_textdomain_registry->set_custom_path( $domain, $path );
return load_textdomain( $domain, $path . '/' . $mofile, $locale ); return load_textdomain( $domain, $path . '/' . $mofile, $locale );
} }
@ -1016,7 +1016,7 @@ function load_theme_textdomain( $domain, $path = false ) {
$path = get_template_directory(); $path = get_template_directory();
} }
$wp_textdomain_registry->set( $domain, $locale, $path ); $wp_textdomain_registry->set_custom_path( $domain, $path );
return load_textdomain( $domain, $path . '/' . $locale . '.mo', $locale ); return load_textdomain( $domain, $path . '/' . $locale . '.mo', $locale );
} }
@ -1265,7 +1265,7 @@ function _load_textdomain_just_in_time( $domain ) {
return false; return false;
} }
if ( $wp_textdomain_registry->has( $domain ) && ! $wp_textdomain_registry->get_current( $domain ) ) { if ( ! $wp_textdomain_registry->has( $domain ) ) {
return false; return false;
} }

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.2-alpha-54668'; $wp_version = '6.2-alpha-54669';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.