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

フィルター

[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年10月29日 15:55



お勧め

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

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

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。