load_plugin_textdomain

説明

bool load_plugin_textdomain( string $domain [ , mixed $abs_rel_path $deprecated = false [ , mixed $plugin_rel_path = false ] ] )
プラグイン用の国際化用ファイル(MOファイル)をロードする。

パラメータ

  • $domain
    ドメイン名を指定。
  • $abs_rel_path $deprecated
    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/)の示すディレクトリが優先されるようになった。プラグインのバージョンアップ直後などは、新しいプラグインの国際化用ファイルが読み込まれないケースがあるかもしれない。なお国際化用ファイルがWP_LANG_DIRが示すディレクトリ(プラグインであれば/wp-content/languages/plugins)以下にある環境で__関数や_e関数などの翻訳テキストを取得する関数が呼ばれた場合、国際化用ファイルがロードされていない場合は自動的にロードされるため、本関数を使用する必要はない。

[4.7.0]管理者ページの言語がサイトの言語設定よりユーザの言語設定が優先されるように仕様が変更され、'plugin_locale'フィルターの第1パラメータ$localeの内容はリクエストが管理者ページの場合には get_user_locale関数で取得できるユーザの言語が適用される。ここで注意しなければならないのが本関数を呼び出すタイミングである。プラグインがロードされたタイミングでは、 wp_get_current_user関数を定義しているwp-includes/pluggable.phpがロードされていないため、ログインしているユーザの言語設定を取得できず、サイトの言語設定が適用されてしまう。正しくユーザの言語設定にするためには、'admin_menu'アクションなどの実際に翻訳テキストを使用する直前で本関数を呼び出さなければならない。


使用例

  • プラグインの国際化用ファイル(MOファイル)をロードする。
    <?php load_plugin_textdomain( 'mydomain' ); ?>
  • プラグインのプラグインディレクトリ内の国際化用ファイル(MOファイル)をロードする。
    <?php load_plugin_textdomain( 'mydomain', false, basename( __DIR__ ) . '/languages' ); ?>

フィルター

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

アクション

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

ソースファイル

/wp-includes/l10n.php

最終更新 : 2024年05月04日 14:32



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。