<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[57287] trunk: I18N: Cache list of language file paths in `WP_Textdomain_Registry`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/57287">57287</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/57287","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-01-15 19:03:27 +0000 (Mon, 15 Jan 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>I18N: Cache list of language file paths in `WP_Textdomain_Registry`.
Loading a list of language file paths using `glob()` can be expensive if involving thousands of files.
Expands scope of `WP_Textdomain_Registry` to cache list of language file paths in object cache and provides a way to invalidate that cache upon translation updates. Plugins can clear the cache using calls such as `wp_cache_delete( 'cached_mo_files_' . md5( $path ), 'translations' );`
Props mreishus, swissspidy
Fixes <a href="https://core.trac.wordpress.org/ticket/58919">#58919</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswptextdomainregistryphp">trunk/src/wp-includes/class-wp-textdomain-registry.php</a></li>
<li><a href="#trunksrcwpincludesl10nphp">trunk/src/wp-includes/l10n.php</a></li>
<li><a href="#trunksrcwpsettingsphp">trunk/src/wp-settings.php</a></li>
<li><a href="#trunktestsphpunittestsl10nwpTextdomainRegistryphp">trunk/tests/phpunit/tests/l10n/wpTextdomainRegistry.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswptextdomainregistryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-textdomain-registry.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-textdomain-registry.php 2024-01-15 18:55:59 UTC (rev 57286)
+++ trunk/src/wp-includes/class-wp-textdomain-registry.php 2024-01-15 19:03:27 UTC (rev 57287)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,8 +51,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Holds a cached list of available .mo files to improve performance.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.5.0 This property is no longer used.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @deprecated
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected $cached_mo_files = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,6 +69,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $domains_with_translations = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Initializes the registry.
+ *
+ * Hooks into the {@see 'upgrader_process_complete'} filter
+ * to invalidate MO files caches.
+ *
+ * @since 6.5.0
+ */
+ public function init() {
+ add_action( 'upgrader_process_complete', array( $this, 'invalidate_mo_files_cache' ), 10, 2 );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Returns the languages directory path for a specific domain and locale.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.1.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -135,6 +150,106 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves .mo files from the specified path.
+ *
+ * Allows early retrieval through the {@see 'pre_get_mo_files_from_path'} filter to optimize
+ * performance, especially in directories with many files.
+ *
+ * @since 6.5.0
+ *
+ * @param string $path The directory path to search for .mo files.
+ * @return array Array of .mo file paths.
+ */
+ public function get_language_files_from_path( $path ) {
+ $path = trailingslashit( $path );
+
+ /**
+ * Filters the .mo files retrieved from a specified path before the actual lookup.
+ *
+ * Returning a non-null value from the filter will effectively short-circuit
+ * the MO files lookup, returning that value instead.
+ *
+ * This can be useful in situations where the directory contains a large number of files
+ * and the default glob() function becomes expensive in terms of performance.
+ *
+ * @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.
+ **/
+ $mo_files = apply_filters( 'pre_get_language_files_from_path', null, $path );
+
+ if ( null !== $mo_files ) {
+ return $mo_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();
+ }
+ wp_cache_set( $cache_key, $mo_files, 'translations' );
+ }
+
+ return $mo_files;
+ }
+
+ /**
+ * Invalidate the cache for .mo files.
+ *
+ * This function deletes the cache entries related to .mo files when triggered
+ * by specific actions, such as the completion of an upgrade process.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Upgrader $upgrader Unused. WP_Upgrader instance. In other contexts this might be a
+ * Theme_Upgrader, Plugin_Upgrader, Core_Upgrade, or Language_Pack_Upgrader instance.
+ * @param array $hook_extra {
+ * Array of bulk item update data.
+ *
+ * @type string $action Type of action. Default 'update'.
+ * @type string $type Type of update process. Accepts 'plugin', 'theme', 'translation', or 'core'.
+ * @type bool $bulk Whether the update process is a bulk update. Default true.
+ * @type array $plugins Array of the basename paths of the plugins' main files.
+ * @type array $themes The theme slugs.
+ * @type array $translations {
+ * Array of translations update data.
+ *
+ * @type string $language The locale the translation is for.
+ * @type string $type Type of translation. Accepts 'plugin', 'theme', or 'core'.
+ * @type string $slug Text domain the translation is for. The slug of a theme/plugin or
+ * 'default' for core translations.
+ * @type string $version The version of a theme, plugin, or core.
+ * }
+ * }
+ * @return void
+ */
+ public function invalidate_mo_files_cache( $upgrader, $hook_extra ) {
+ if ( 'translation' !== $hook_extra['type'] || array() === $hook_extra['translations'] ) {
+ return;
+ }
+
+ $translation_types = array_unique( wp_list_pluck( $hook_extra['translations'], 'type' ) );
+
+ foreach ( $translation_types as $type ) {
+ switch ( $type ) {
+ case 'plugin':
+ wp_cache_delete( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/plugins/' ), 'translations' );
+ break;
+ case 'theme':
+ wp_cache_delete( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/themes/' ), 'translations' );
+ break;
+ default:
+ wp_cache_delete( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) ), 'translations' );
+ break;
+ }
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Returns possible language directory paths for a given text domain.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -156,7 +271,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Gets the path to the language directory for the current locale.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets the path to the language directory for the current domain and locale.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Checks the plugins and themes language directories as well as any
</span><span class="cx" style="display: block; padding: 0 10px"> * custom directory set via {@see load_plugin_textdomain()} or {@see load_theme_textdomain()}.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -175,13 +290,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $found_location = false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $locations as $location ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! isset( $this->cached_mo_files[ $location ] ) ) {
- $this->set_cached_mo_files( $location );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $files = $this->get_language_files_from_path( $location );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $path = "$location/$domain-$locale.mo";
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $this->cached_mo_files[ $location ] as $mo_path ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $files as $mo_path ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if (
</span><span class="cx" style="display: block; padding: 0 10px"> ! in_array( $domain, $this->domains_with_translations, true ) &&
</span><span class="cx" style="display: block; padding: 0 10px"> str_starts_with( str_replace( "$location/", '', $mo_path ), "$domain-" )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -215,21 +328,4 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- /**
- * Reads and caches all available MO files from a given directory.
- *
- * @since 6.1.0
- *
- * @param string $path Language directory path.
- */
- private function set_cached_mo_files( $path ) {
- $this->cached_mo_files[ $path ] = array();
-
- $mo_files = glob( $path . '/*.mo' );
-
- if ( $mo_files ) {
- $this->cached_mo_files[ $path ] = $mo_files;
- }
- }
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesl10nphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/l10n.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/l10n.php 2024-01-15 18:55:59 UTC (rev 57286)
+++ trunk/src/wp-includes/l10n.php 2024-01-15 19:03:27 UTC (rev 57287)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1398,6 +1398,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0 The results are now filterable with the {@see 'get_available_languages'} filter.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Textdomain_Registry $wp_textdomain_registry WordPress Textdomain Registry.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $dir A directory to search for language files.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default WP_LANG_DIR.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string[] An array of language codes or an empty array if no languages are present.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1404,9 +1406,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Language codes are formed by stripping the .mo extension from the language file names.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_available_languages( $dir = null ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $wp_textdomain_registry;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $languages = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $lang_files = glob( ( is_null( $dir ) ? WP_LANG_DIR : $dir ) . '/*.mo' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $path = is_null( $dir ) ? WP_LANG_DIR : $dir;
+ $lang_files = $wp_textdomain_registry->get_language_files_from_path( $path );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $lang_files ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $lang_files as $lang_file ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $lang_file = basename( $lang_file, '.mo' );
</span></span></pre></div>
<a id="trunksrcwpsettingsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-settings.php 2024-01-15 18:55:59 UTC (rev 57286)
+++ trunk/src/wp-settings.php 2024-01-15 19:03:27 UTC (rev 57287)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -380,6 +380,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Textdomain_Registry $wp_textdomain_registry WordPress Textdomain Registry.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $GLOBALS['wp_textdomain_registry'] = new WP_Textdomain_Registry();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$GLOBALS['wp_textdomain_registry']->init();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Load multisite-specific files.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_multisite() ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsl10nwpTextdomainRegistryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/l10n/wpTextdomainRegistry.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/l10n/wpTextdomainRegistry.php 2024-01-15 18:55:59 UTC (rev 57286)
+++ trunk/tests/phpunit/tests/l10n/wpTextdomainRegistry.php 2024-01-15 19:03:27 UTC (rev 57287)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,6 +18,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->instance = new WP_Textdomain_Registry();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function tear_down() {
+ wp_cache_delete( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/foobar/' ), 'translations' );
+ wp_cache_delete( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/plugins/' ), 'translations' );
+ wp_cache_delete( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/themes/' ), 'translations' );
+ wp_cache_delete( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) ), 'translations' );
+
+ parent::tear_down();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::has
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::get
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -24,15 +33,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::set_custom_path
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_set_custom_path() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $reflection = new ReflectionClass( $this->instance );
- $reflection_property = $reflection->getProperty( 'cached_mo_files' );
- $reflection_property->setAccessible( true );
-
- $this->assertEmpty(
- $reflection_property->getValue( $this->instance ),
- 'Cache not empty by default'
- );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $this->instance->set_custom_path( 'foo', WP_LANG_DIR . '/bar' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -48,10 +48,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->instance->get( 'foo', 'de_DE' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'Custom path for textdomain not returned'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertArrayHasKey(
- WP_LANG_DIR . '/bar',
- $reflection_property->getValue( $this->instance ),
- 'Custom path missing from cache'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertNotFalse(
+ wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . 'bar/' ), 'translations' ),
+ 'List of files in custom path not cached'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,10 +59,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_domains_locales
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get( $domain, $locale, $expected ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $reflection = new ReflectionClass( $this->instance );
- $reflection_property = $reflection->getProperty( 'cached_mo_files' );
- $reflection_property->setAccessible( true );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $actual = $this->instance->get( $domain, $locale );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame(
</span><span class="cx" style="display: block; padding: 0 10px"> $expected,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -70,12 +65,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $actual,
</span><span class="cx" style="display: block; padding: 0 10px"> 'Expected languages directory path not matching actual one'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- $this->assertArrayHasKey(
- WP_LANG_DIR . '/plugins',
- $reflection_property->getValue( $this->instance ),
- 'Default plugins path missing from cache'
- );
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -91,6 +80,75 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @covers ::get_language_files_from_path
+ */
+ public function test_get_language_files_from_path_caches_results() {
+ $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) . '/foobar/' );
+ $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) . '/plugins/' );
+ $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) . '/themes/' );
+ $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) );
+
+ $this->assertNotFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/plugins/' ), 'translations' ) );
+ $this->assertNotFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/themes/' ), 'translations' ) );
+ $this->assertNotFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/foobar/' ), 'translations' ) );
+ $this->assertNotFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) ), 'translations' ) );
+ }
+
+ /**
+ * @covers ::get_language_files_from_path
+ */
+ public function test_get_language_files_from_path_short_circuit() {
+ add_filter( 'pre_get_language_files_from_path', '__return_empty_array' );
+ $result = $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) . '/plugins/' );
+ remove_filter( 'pre_get_language_files_from_path', '__return_empty_array' );
+
+ $cache = wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/plugins/' ), 'translations' );
+
+ $this->assertEmpty( $result );
+ $this->assertFalse( $cache );
+ }
+
+ /**
+ * @covers ::invalidate_mo_files_cache
+ */
+ public function test_invalidate_mo_files_cache() {
+ $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) . '/plugins/' );
+ $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) . '/themes/' );
+ $this->instance->get_language_files_from_path( trailingslashit( WP_LANG_DIR ) );
+
+ $this->instance->invalidate_mo_files_cache(
+ null,
+ array(
+ 'type' => 'translation',
+ 'translations' => array(
+ (object) array(
+ 'type' => 'plugin',
+ 'slug' => 'internationalized-plugin',
+ 'language' => 'de_DE',
+ 'version' => '99.9.9',
+ ),
+ (object) array(
+ 'type' => 'theme',
+ 'slug' => 'internationalized-theme',
+ 'language' => 'de_DE',
+ 'version' => '99.9.9',
+ ),
+ (object) array(
+ 'type' => 'core',
+ 'slug' => 'default',
+ 'language' => 'es_ES',
+ 'version' => '99.9.9',
+ ),
+ ),
+ )
+ );
+
+ $this->assertFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/plugins/' ), 'translations' ) );
+ $this->assertFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) . '/themes/' ), 'translations' ) );
+ $this->assertFalse( wp_cache_get( 'cached_mo_files_' . md5( trailingslashit( WP_LANG_DIR ) ), 'translations' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function data_domains_locales() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'Non-existent plugin' => array(
</span></span></pre>
</div>
</div>
</body>
</html>