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



load_plugin_textdomain › WordPress Function

Since1.5.0
Deprecatedn/a
› load_plugin_textdomain ( $domain, $deprecated = false, $plugin_rel_path = false )
Parameters: (3)
  • (string) $domain Unique identifier for retrieving translated strings
    Required: Yes
  • (string|false) $deprecated Optional. Deprecated. Use the $plugin_rel_path parameter instead. Default false.
    Required: No
    Default: false
  • (string|false) $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR where the .mo file resides. 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 a plugin's translated strings.

If the path is not given then it will be the root of the plugin directory. The .mo file should be named based on the text domain with a dash, and then the locale exactly.


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

Source 

function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_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 ( false !== $plugin_rel_path ) {
		$path = WP_PLUGIN_DIR . '/' . trim( $plugin_rel_path, '/' );
	} elseif ( false !== $deprecated ) {
		_deprecated_argument( __FUNCTION__, '2.7.0' );
		$path = ABSPATH . trim( $deprecated, '/' );
	} else {
		$path = WP_PLUGIN_DIR;
	}

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