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

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

Contents

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: ''

Top ↑

Return

bool True when textdomain is successfully loaded, false otherwise.

Top ↑

Source

File: wp-includes/l10n.php. View all references 

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

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Uses

Uses
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.
determine_locale() wp-includes/l10n.php

Determines the current locale desired for the request.
load_textdomain() wp-includes/l10n.php

Loads a .mo file into the text domain $domain.
apply_filters() wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
Show 1 more use Hide more uses

Top ↑

Changelog

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

Top ↑

User Contributed Notes

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