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 empty string.

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 */
	/** @var array<string, WP_Translations|NOOP_Translations> $l10n */
	global $wp_textdomain_registry, $l10n;

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

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

	$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;
}

View all references View on Trac View on GitHub

Uses	Description
WP_Textdomain_Registry::set_custom_path()`wp-includes/class-wp-textdomain-registry.php`	Sets the custom path to the plugin’s/theme’s languages directory.

Changelog

Version	Description
6.7.0	Translations are no longer immediately loaded, but handed off to the just-in-time loading mechanism.
4.6.0	The function now tries to load the .mo file from the languages directory first.
3.0.0	Introduced.

User Contributed Notes

Skip to note 2 content

Sebastien SERRE 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Example from Codex:
```
function wporg_load_textdomain() {
	load_muplugin_textdomain( 'my-plugin', basename( dirname(__FILE__) ) . '/lang' );
}
add_action( 'plugins_loaded', 'wporg_load_textdomain' );
```
Log in to add feedback

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