load_muplugin_textdomain( string $domain, string $mu_plugin_rel_path =  ): bool

Loads the translated strings for a plugin residing in the mu-plugins directory.

Parameters

$domainstringrequired
Text domain. Unique identifier for retrieving translated strings.
$mu_plugin_rel_pathstringoptional
Relative to WPMU_PLUGIN_DIR directory in which the .mo file resides.

Default:''

Return

bool True when textdomain is successfully loaded, false otherwise.

Source

function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
	/** @var WP_Textdomain_Registry $wp_textdomain_registry */
	global $wp_textdomain_registry;

	/** This filter is documented in wp-includes/l10n.php */
	$locale = apply_filters( 'plugin_locale', determine_locale(), $domain );

	$mofile = $domain . '-' . $locale . '.mo';

	// Try to load from the languages directory first.
	if ( load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile, $locale ) ) {
		return true;
	}

	$path = WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' );

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

	return load_textdomain( $domain, $path . '/' . $mofile, $locale );
}

Hooks

apply_filters( ‘plugin_locale’, string $locale, string $domain )

Filters a plugin’s locale.

Changelog

VersionDescription
4.6.0The function now tries to load the .mo file from the languages directory first.
3.0.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.