当前浏览:首页 / WordPress函数 / load_plugin_textdomain()

load_plugin_textdomain( string $domain, string|false $deprecated = false, string|false $plugin_rel_path = false ): bool

加载插件的翻译字符串

load

plugin 插件more...

textdomain


描述

如果没有给出路径,那么它将是插件目录的根目录。

.mo文件的命名应该基于带破折号的文本域,然后是确切的区域设置(locale)。


参数

$domainstring必填
用于检索翻译字符串的唯一标识符
$deprecatedstring|false可选
已弃用,请改用$plugin_rel_path参数。

默认: false

$plugin_rel_pathstring|false可选
.mo文件所在 WP_PLUGIN_DIR 的相对路径。

默认: false


返回

bool 成功加载textdomain时为true,否则为false。


钩子



源码

查看源码 官方文档


更新日志

版本描述
4.6.0该函数现在尝试首先从languages目录加载.mo文件。
1.5.0开始引入

使用示例

  • 示例1

    plugins_loaded动作期间不应加载插件翻译,因为这太早,并且会阻止其他与语言相关的插件正确连接load_textdomain()函数并执行它们想要执行的任何操作。
    调用load_plugin_textdomain()应延迟到init动作。

    add_action( 'init', 'wpdocs_load_textdomain' );
     
    /**
     * Load plugin textdomain.
     */
    function wpdocs_load_textdomain() {
      load_plugin_textdomain( 'wpdocs_textdomain', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' ); 
    }
  • 示例2

    只是一个笔记,

    load_plugin_textdomain() 将尝试加载 mo 文件从:
    WP_LANG_DIR . ‘/plugins/’ . $mofile

    只有在无法加载时,才会从WP_PLUGIN_DIR文件夹加载

  • 示例3

    插件文本域加载

    function my_plugin_init() {
        load_plugin_textdomain( 'my-textdomain', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' ); 
    }
    add_action( 'plugins_loaded', 'my_plugin_init' );