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'アクションなどの実際に翻訳テキストを使用する直前で本関数を呼び出さなければならない。

[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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。