load_plugin_textdomain:WordPress私的マニュアル

load_plugin_textdomain

(1.5.0以降)
load_plugin_textdomain - プラグイン用のMOファイルをロードする

説明

bool load_plugin_textdomain( string $domain [ , mixed $abs_rel_path = false [ , mixed $plugin_rel_path = false ] ] )

プラグイン用の国際化用ファイル（MOファイル）をロードする。

パラメータ

$domain
ドメイン名を指定。
$abs_rel_path
2.7以降は使用が推奨されておらず、falseを指定。
$plugin_rel_path
プラグインの相対パス名（プラグインのディレクトリ名など）を指定（省略時はfalse）。

返り値

国際化用ファイル（MOファイル）をロードできた場合はtrueを、ロードできなかった場合はfalseを返す。

注意

ドメイン名は、__関数や_e関数といった翻訳テキストを使用する際のパラメータとして指定する。
パラメータを$plugin_rel_pathを省略した場合、プラグインディレクトリにあるドメイン名-ロケール情報.moファイルがロードされる。例）ドメイン名が'mydomain'、ロケール情報が'ja'の場合

/wp-content/plugins/mydomain-ja.mo

パラメータを$plugin_rel_pathを指定した場合、自プラグインにあるドメイン名-ロケール情報.moファイルがロードされる。例）ドメイン名が'mydomain'、プラグインの相対パス名が'myplugin'、ロケール情報が'ja'の場合

/wp-content/plugins/myplugin/mydomain-ja.mo

[4.6.0]国際化用ファイルをロードするディレクトリの優先度が変更になり、パラメータ$plugin_rel_pathよりも定数WP_LANG_DIR（標準では/wp-content/languages/plugins/）の示すディレクトリが優先されるようになった。プラグインのバージョンアップ直後などは、新しいプラグインの国際化用ファイルが読み込まれないケースがあるかもしれません。

使用例

プラグインの国際化用ファイル（MOファイル）をロードする。
<?php load_plugin_textdomain( 'mydomain' ); ?>

フィルター

[3.0.0]はじめにロケール情報を確定するために'plugin_locale'フィルターを呼び出す。パラメータ$localeにはget_locale関数の値が、$domainには本関数が受け取った値が格納されている。

$locale = apply_filters( 'plugin_locale', $locale, $domain );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/l10n.php

参考

Code Reference: load_plugin_textdomain