load_muplugin_textdomain() WordPress Function

The load_muplugin_textdomain() function loads a plugin's translated strings. This function should be called after the plugin's translated strings have been loaded using the load_plugin_textdomain() function. The first argument is the plugin's textdomain. The second argument is the plugin's absolute path.

load_muplugin_textdomain( string $domain, string $mu_plugin_rel_path = '' ) #

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


Parameters

$domain

(string)(Required)Text domain. Unique identifier for retrieving translated strings.

$mu_plugin_rel_path

(string)(Optional) Relative to WPMU_PLUGIN_DIR directory in which the .mo file resides.

Default value: ''


Top ↑

Return

(bool) True when textdomain is successfully loaded, false otherwise.


Top ↑

Source

File: wp-includes/l10n.php

function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
	/** 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 ) ) {
		return true;
	}

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

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


Top ↑

Changelog

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

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.