Description
If the current locale exists as a .mo file in the theme’s root directory, it will be included in the translated strings by the $domain.
The .mo files must be named based on the locale exactly.
Parameters
- $domain
-
(string) (Required) Text domain. Unique identifier for retrieving translated strings.
- $path
-
(string) (Optional) Path to the directory containing the .mo file.
Default value: false
Return
(bool) True when textdomain is successfully loaded, false otherwise.
Source
File: wp-includes/l10n.php
function load_theme_textdomain( $domain, $path = false ) {
/**
* 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', determine_locale(), $domain );
$mofile = $domain . '-' . $locale . '.mo';
// Try to load from the languages directory first.
if ( load_textdomain( $domain, WP_LANG_DIR . '/themes/' . $mofile ) ) {
return true;
}
if ( ! $path ) {
$path = get_template_directory();
}
return load_textdomain( $domain, $path . '/' . $locale . '.mo' );
}
Changelog
Version | Description |
4.6.0 | The function now tries to load the .mo file from the languages directory first. |
1.5.0 | Introduced. |