if ( isset( $locale ) ) {
/**
- * Filter WordPress install's locale ID.
+ * Filters WordPress install's locale ID.
*
* @since 1.5.0
*
$translations = $translations->translate( $text );
/**
- * Filter text with its translation.
+ * Filters text with its translation.
*
* @since 2.0.11
*
$translations = get_translations_for_domain( $domain );
$translations = $translations->translate( $text, $context );
/**
- * Filter text with its translation based on context information.
+ * Filters text with its translation based on context information.
*
* @since 2.8.0
*
$translation = $translations->translate_plural( $single, $plural, $number );
/**
- * Filter the singular or plural form of a string.
+ * Filters the singular or plural form of a string.
*
* @since 2.2.0
*
$translation = $translations->translate_plural( $single, $plural, $number, $context );
/**
- * Filter the singular or plural form of a string with gettext context.
+ * Filters the singular or plural form of a string with gettext context.
*
* @since 2.8.0
*
*
* @since 1.5.0
*
- * @global array $l10n
+ * @global array $l10n An array of all currently loaded text domains.
+ * @global array $l10n_unloaded An array of all text domains that have been unloaded again.
*
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @param string $mofile Path to the .mo file.
* @return bool True on success, false on failure.
*/
function load_textdomain( $domain, $mofile ) {
- global $l10n;
+ global $l10n, $l10n_unloaded;
+
+ $l10n_unloaded = (array) $l10n_unloaded;
/**
- * Filter text domain and/or MO file path for loading translations.
+ * Filters whether to override the .mo file loading.
*
* @since 2.9.0
*
- * @param bool $override Whether to override the text domain. Default false.
+ * @param bool $override Whether to override the .mo file loading. Default false.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @param string $mofile Path to the MO file.
*/
$plugin_override = apply_filters( 'override_load_textdomain', false, $domain, $mofile );
if ( true == $plugin_override ) {
+ unset( $l10n_unloaded[ $domain ] );
+
return true;
}
do_action( 'load_textdomain', $domain, $mofile );
/**
- * Filter MO file path for loading translations for a specific text domain.
+ * Filters MO file path for loading translations for a specific text domain.
*
* @since 2.9.0
*
if ( isset( $l10n[$domain] ) )
$mo->merge_with( $l10n[$domain] );
+ unset( $l10n_unloaded[ $domain ] );
+
$l10n[$domain] = &$mo;
return true;
*
* @since 3.0.0
*
- * @global array $l10n
+ * @global array $l10n An array of all currently loaded text domains.
+ * @global array $l10n_unloaded An array of all text domains that have been unloaded again.
*
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @return bool Whether textdomain was unloaded.
*/
function unload_textdomain( $domain ) {
- global $l10n;
+ global $l10n, $l10n_unloaded;
+
+ $l10n_unloaded = (array) $l10n_unloaded;
/**
- * Filter the text domain for loading translation.
+ * Filters whether to override the text domain unloading.
*
* @since 3.0.0
*
- * @param bool $override Whether to override unloading the text domain. Default false.
+ * @param bool $override Whether to override the text domain unloading. Default false.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
$plugin_override = apply_filters( 'override_unload_textdomain', false, $domain );
- if ( $plugin_override )
+ if ( $plugin_override ) {
+ $l10n_unloaded[ $domain ] = true;
+
return true;
+ }
/**
* Fires before the text domain is unloaded.
if ( isset( $l10n[$domain] ) ) {
unset( $l10n[$domain] );
+
+ $l10n_unloaded[ $domain ] = true;
+
return true;
}
*
* @since 1.5.0
*
- * @param string $locale Optional. Locale to load. Default is the value of {@see get_locale()}.
+ * @param string $locale Optional. Locale to load. Default is the value of get_locale().
* @return bool Whether the textdomain was loaded.
*/
function load_default_textdomain( $locale = null ) {
}
/**
- * Load a plugin's translated strings.
+ * Loads a plugin's translated strings.
*
* If the path is not given then it will be the root of the plugin directory.
*
* The .mo file should be named based on the text domain with a dash, and then the locale exactly.
*
* @since 1.5.0
+ * @since 4.6.0 The function now tries to load the .mo file from the languages directory first.
*
* @param string $domain Unique identifier for retrieving translated strings
- * @param string $deprecated Use the $plugin_rel_path parameter instead.
+ * @param string $deprecated Optional. Use the $plugin_rel_path parameter instead. Defaukt false.
* @param string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR where the .mo file resides.
* Default false.
* @return bool True when textdomain is successfully loaded, false otherwise.
*/
function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path = false ) {
- $locale = get_locale();
/**
- * Filter a plugin's locale.
+ * Filters a plugin's locale.
*
* @since 3.0.0
*
* @param string $locale The plugin's current locale.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
- $locale = apply_filters( 'plugin_locale', $locale, $domain );
+ $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
+
+ $mofile = $domain . '-' . $locale . '.mo';
- if ( false !== $plugin_rel_path ) {
+ // Try to load from the languages directory first.
+ if ( load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile ) ) {
+ return true;
+ }
+
+ if ( false !== $plugin_rel_path ) {
$path = WP_PLUGIN_DIR . '/' . trim( $plugin_rel_path, '/' );
} elseif ( false !== $deprecated ) {
- _deprecated_argument( __FUNCTION__, '2.7' );
+ _deprecated_argument( __FUNCTION__, '2.7.0' );
$path = ABSPATH . trim( $deprecated, '/' );
} else {
$path = WP_PLUGIN_DIR;
}
- // Load the textdomain according to the plugin first
- $mofile = $domain . '-' . $locale . '.mo';
- if ( $loaded = load_textdomain( $domain, $path . '/'. $mofile ) )
- return $loaded;
-
- // Otherwise, load from the languages directory
- $mofile = WP_LANG_DIR . '/plugins/' . $mofile;
- return load_textdomain( $domain, $mofile );
+ return load_textdomain( $domain, $path . '/' . $mofile );
}
/**
* Load the translated strings for a plugin residing in the mu-plugins directory.
*
* @since 3.0.0
+ * @since 4.6.0 The function now tries to load the .mo file from the languages directory first.
*
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
- * @param string $mu_plugin_rel_path Relative to WPMU_PLUGIN_DIR directory in which the .mo file resides.
- * Default empty string.
+ * @param string $mu_plugin_rel_path Optional. Relative to `WPMU_PLUGIN_DIR` directory in which the .mo
+ * file resides. Default empty string.
* @return bool True when textdomain is successfully loaded, false otherwise.
*/
function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
/** This filter is documented in wp-includes/l10n.php */
$locale = apply_filters( 'plugin_locale', get_locale(), $domain );
- $path = trailingslashit( WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' ) );
- // Load the textdomain according to the plugin first
$mofile = $domain . '-' . $locale . '.mo';
- if ( $loaded = load_textdomain( $domain, $path . $mofile ) )
- return $loaded;
- // Otherwise, load from the languages directory
- $mofile = WP_LANG_DIR . '/plugins/' . $mofile;
- return load_textdomain( $domain, $mofile );
+ // Try to load from the languages directory first.
+ if ( load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile ) ) {
+ return true;
+ }
+
+ $path = trailingslashit( WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' ) );
+
+ return load_textdomain( $domain, $path . '/' . $mofile );
}
/**
* The .mo files must be named based on the locale exactly.
*
* @since 1.5.0
+ * @since 4.6.0 The function now tries to load the .mo file from the languages directory first.
*
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @param string $path Optional. Path to the directory containing the .mo file.
* @return bool True when textdomain is successfully loaded, false otherwise.
*/
function load_theme_textdomain( $domain, $path = false ) {
- $locale = get_locale();
/**
- * Filter a theme's locale.
+ * Filters a theme's locale.
*
* @since 3.0.0
*
* @param string $locale The theme's current locale.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
- $locale = apply_filters( 'theme_locale', $locale, $domain );
+ $locale = apply_filters( 'theme_locale', get_locale(), $domain );
- if ( ! $path )
- $path = get_template_directory();
+ $mofile = $domain . '-' . $locale . '.mo';
- // Load the textdomain according to the theme
- $mofile = untrailingslashit( $path ) . "/{$locale}.mo";
- if ( $loaded = load_textdomain( $domain, $mofile ) )
- return $loaded;
+ // Try to load from the languages directory first.
+ if ( load_textdomain( $domain, WP_LANG_DIR . '/themes/' . $mofile ) ) {
+ return true;
+ }
- // Otherwise, load from the languages directory
- $mofile = WP_LANG_DIR . "/themes/{$domain}-{$locale}.mo";
- return load_textdomain( $domain, $mofile );
+ if ( ! $path ) {
+ $path = get_template_directory();
+ }
+
+ return load_textdomain( $domain, $path . '/' . $locale . '.mo' );
}
/**
return load_theme_textdomain( $domain, $path );
}
+/**
+ * Loads plugin and theme textdomains just-in-time.
+ *
+ * When a textdomain is encountered for the first time, we try to load
+ * the translation file from `wp-content/languages`, removing the need
+ * to call load_plugin_texdomain() or load_theme_texdomain().
+ *
+ * Holds a cached list of available .mo files to improve performance.
+ *
+ * @since 4.6.0
+ * @access private
+ *
+ * @see get_translations_for_domain()
+ * @global array $l10n_unloaded An array of all text domains that have been unloaded again.
+ *
+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+ * @return bool True when the textdomain is successfully loaded, false otherwise.
+ */
+function _load_textdomain_just_in_time( $domain ) {
+ global $l10n_unloaded;
+
+ $l10n_unloaded = (array) $l10n_unloaded;
+
+ static $cached_mofiles = null;
+
+ // Short-circuit if domain is 'default' which is reserved for core.
+ if ( 'default' === $domain || isset( $l10n_unloaded[ $domain ] ) ) {
+ return false;
+ }
+
+ if ( null === $cached_mofiles ) {
+ $cached_mofiles = array();
+
+ $locations = array(
+ WP_LANG_DIR . '/plugins',
+ WP_LANG_DIR . '/themes',
+ );
+
+ foreach ( $locations as $location ) {
+ foreach ( get_available_languages( $location ) as $file ) {
+ $cached_mofiles[] = "{$location}/{$file}.mo";
+ }
+ }
+ }
+
+ $locale = get_locale();
+ $mofile = "{$domain}-{$locale}.mo";
+
+ if ( in_array( WP_LANG_DIR . '/plugins/' . $mofile, $cached_mofiles ) ) {
+ return load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile );
+ }
+
+ if ( in_array( WP_LANG_DIR . '/themes/' . $mofile, $cached_mofiles ) ) {
+ return load_textdomain( $domain, WP_LANG_DIR . '/themes/' . $mofile );
+ }
+
+ return false;
+}
+
/**
* Return the Translations instance for a text domain.
*
*/
function get_translations_for_domain( $domain ) {
global $l10n;
- if ( isset( $l10n[ $domain ] ) ) {
+ if ( isset( $l10n[ $domain ] ) || ( _load_textdomain_just_in_time( $domain ) && isset( $l10n[ $domain ] ) ) ) {
return $l10n[ $domain ];
}