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/plugins/)の示すディレクトリが優先されるようになった。プラグインのバージョンアップ直後などは、新しいプラグインの国際化用ファイルが読み込まれないケースがあるかもしれない。

[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' ); ?>

フィルター

[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

最終更新 : 2018年05月27日 10:50



お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

親子の固定ページで同じテンプレートを使う(2013年3月20日 更新)

固定ページのテンプレートファイルは「page.php」か、ページ名(スラッグ)または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 更新)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。