説明
パラメータ
- $domainドメイン名を指定。
$abs_rel_path$deprecated2.7以降は使用が推奨されておらず、falseを指定。- $plugin_rel_pathプラグインの相対パス名(プラグインのディレクトリ名など)を指定(省略時はfalse)。
返り値
国際化用ファイル(MOファイル)をロードできた場合はtrueを、ロードできなかった場合はfalseを返す。注意
ドメイン名は、__関数や_e関数といった翻訳テキストを使用する際のパラメータとして指定する。
パラメータを$plugin_rel_pathを省略した場合、プラグインディレクトリにあるドメイン名-ロケール情報.moファイルがロードされる。例)ドメイン名が'mydomain'、ロケール情報が'ja'の場合
パラメータを$plugin_rel_pathを指定した場合、自プラグインにあるドメイン名-ロケール情報.moファイルがロードされる。例)ドメイン名が'mydomain'、プラグインの相対パス名が'myplugin'、ロケール情報が'ja'の場合
[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'アクションなどの実際に翻訳テキストを使用する直前で本関数を呼び出さなければならない。
[6.7.0]翻訳データのロードは、本関数の実行時からジャスト・イン・タイムローディング機構(翻訳テキストがはじめて要求された時)へ切り替わった。
使用例
- プラグインの国際化用ファイル(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年11月18日 09:11
関連
お勧め
フィードにサムネイル画像を追加する(2022年11月7日 更新)
WordPressが出力するの標準のフィードには、各投稿のサムネイル画像の情報が含まれていない。ネットで検索してみるといくつかの方法があることがわかったので、その中から2つ試してみた。
ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)
管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。
スマートフォン向けの振り分けを自前で行う(2012年1月23日 更新)
PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)
今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。
5.5の機能強化:コメントフォームのちょっとした改良(2020年8月12日 更新)
来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3(以降Beta 3)」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。