wpseek.com
A WordPress-centric search engine for devs and theme authors



load_theme_textdomain › WordPress Function

Since1.5.0
Deprecatedn/a
› load_theme_textdomain ( $domain, $path = false )
Parameters: (2)
  • (string) $domain Text domain. Unique identifier for retrieving translated strings.
    Required: Yes
  • (string|false) $path Optional. Path to the directory containing the .mo file. Default false.
    Required: No
    Default: false
Returns:
  • (bool) True when textdomain is successfully loaded, false otherwise.
Defined at:
Codex:
Change Log:
  • 4.6.0
  • 6.7.0

Loads 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.


Related Functions: load_child_theme_textdomain, load_textdomain, unload_textdomain, load_script_textdomain, load_default_textdomain

Source 

function load_theme_textdomain( $domain, $path = false ) {
	/** @var WP_Textdomain_Registry $wp_textdomain_registry */
	/** @var array<string, WP_Translations|NOOP_Translations> $l10n */
	global $wp_textdomain_registry, $l10n;

	if ( ! is_string( $domain ) ) {
		return false;
	}

	if ( ! $path ) {
		$path = get_template_directory();
	}

	$wp_textdomain_registry->set_custom_path( $domain, $path );

	// If just-in-time loading was triggered before, reset the entry so it can be tried again.
	if ( isset( $l10n[ $domain ] ) && $l10n[ $domain ] instanceof NOOP_Translations ) {
		unset( $l10n[ $domain ] );
	}

	return true;
}