load_plugin_textdomain() – Loads a plugin’s translated strings.

You appear to be a bot. Output may be restricted

Description

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.

Usage

$bool = load_plugin_textdomain( $domain, $deprecated, $plugin_rel_path );

Parameters

$domain
( string ) required – Unique identifier for retrieving translated strings
$deprecated
( string|false ) optional – Optional. Deprecated. Use the $plugin_rel_path parameter instead. Default false.
$plugin_rel_path
( string|false ) optional – Optional. Relative path to WP_PLUGIN_DIR where the .mo file resides. Default false.

Returns

bool True when textdomain is successfully loaded, false otherwise.

Source

File name: wordpress/wp-includes/l10n.php


Lines:

1 to 37 of 37
function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path = false ) {
  
/** @var WP_Textdomain_Registry $wp_textdomain_registry */
  global $wp_textdomain_registry;

  
/**
 * Filters a plugin's locale.
 *
 * @since 3.0.0
 *
 * @param string $locale The plugin's current locale.
 * @param string $domain Text domain. Unique identifier for retrieving translated strings.
 */
  $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;
  }

  if ( false !== $plugin_rel_path ) {
    $path = WP_PLUGIN_DIR . '/' . trim( $plugin_rel_path, '/' );
  } elseif ( false !== $deprecated ) {
    _deprecated_argument( load_plugin_textdomain, '2.7.0' );
    $path = ABSPATH . trim( $deprecated, '/' );
  } else {
    $path = WP_PLUGIN_DIR;
  }

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

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

 View on GitHub View on Trac