load_plugin_textdomain

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

説明

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

最終更新 : 2017年12月17日 21:44

関連

参考

Code Reference: load_plugin_textdomain

お勧め

wp_titleからwp_get_document_titleへ（2015年11月15日 更新）

先週、WordPress 4.4 beta1（以降4.4 beta1）が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

Paste JSON text：プラグイン作ってみました（2014年1月6日 更新）

動作検証用のサーバーと本番サーバーで投稿データの同期作業（コピー＆ペースト）を支援するプラグインです。動作検証用のサーバーで投稿記事をJSONテキストに変換してクリップボードにコピー。本番サーバーの新規投稿ページでクリップボードにコピーしたJSONテキストをペーストして、投稿記事のコピー＆ペーストを実現します。複数サーバー間で投稿記事の同期を行っている方は、お試しあれ。

「投稿に挿入」時のタグをちょっとカスタマイズ（2011年7月29日 更新）

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される（キャプションを指定した場合はタグも）。それらの画像をLightBox（JavaScriptライブラリ）で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。

投稿情報を連想配列で参照する（2014年11月17日 更新）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

oEmbed対応サイトを整理した（2017年11月18日 更新）

投稿記事にTwitterやYouTubeのURL（アドレス）を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み（機能）はoEmbedというもので、対応サイトは随時バージョンアップしている。