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) |
|
Returns: |
|
Defined at: |
|
Codex: | |
Change Log: |
|
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 */ global $wp_textdomain_registry; if ( ! is_string( $domain ) ) { return false; } /** * 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( __FUNCTION__, '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 ); }