WordPress at a glance

load_theme_textdomain() WP 1.0

Load the theme's translated strings.

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.

  • Since 4.6.0 The function now tries to load the .mo file from the languages directory first.
Works based on: load_textdomain()
Hooks from function:
Return

true/false. True when textdomain is successfully loaded, false otherwise.

Usage

load_theme_textdomain( $domain, $path );
$domain(string) (required)
Text domain. Unique identifier for retrieving translated strings.
$path(string)
Path to the directory containing the .mo file.
Default: false

Code of load_theme_textdomain: wp-includes/l10n.php VER 4.9.8

<?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', is_admin() ? get_user_locale() : get_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' );
}

Related Functions

From tag: textdomain (mo po files)

More from tag: localize (l10n i18n Internationalization localization)

More from category: Localization

No comments
    Hello, !     Log In . Register