load_theme_textdomain

（1.5.0以降）
load_theme_textdomain - テーマ用のMOファイルをロードする

説明

bool load_theme_textdomain( string $domain [ , mixed $path = false ] )
テーマ用の国際化用ファイル（MOファイル）をロードする。

パラメータ

  • $domain
    ドメイン名を指定。
  • $path
    国際化用ファイル（MOファイル）のパス名を指定（省略時はfalseとなり、現在のテーマのディレクトリとなる）。

返り値

国際化用ファイル（MOファイル）をロードできた場合はtrueを、ロードできなかった場合はfalseを返す。

注意

ドメイン名は、__関数や_e関数といった翻訳テキストを使用する際のパラメータとして指定する。
パラメータを$pathを省略した場合、現在のテーマのディレクトリにあるロケール情報.moファイルがロードされる。例）ドメイン名が'mydomain'、ロケール情報が'ja'の場合

/wp-content/themes/mytheme/ja.mo

パラメータを$pathを指定した場合、そのパス名のディレクトリにあるロケール情報.moファイルがロードされる。例）ドメイン名が'mydomain'、$pathとしてget_template_directory関数の戻り値に'/languages'を追加し、ロケール情報が'ja'の場合

/wp-content/themes/mytheme/languages/mydomain-ja.mo

[4.6.0]従来テーマ内の(ロケール).moファイルよりも定数WP_LANG_DIR（/wp-content/languages）/themes/（ドメイン名）-(ロケール情報).moファイルが優先されるように変更された。なお国際化用ファイルがWP_LANG_DIRが示すディレクトリ（テーマであれば/wp-content/languages/themes）以下にある環境で__関数や_e関数などの翻訳テキストを取得する関数が呼ばれた場合、国際化用ファイルがロードされていない場合は自動的にロードされるため、本関数を使用する必要はない。

使用例

  • テーマ内の国際化用ファイル（MOファイル）をロードする。
    <?php load_theme_textdomain( 'mydomain' ); ?>
  • テーマ内の'languages'ディレクトリにある国際化用ファイル（MOファイル）をロードする。
    <?php load_theme_textdomain( 'mydomain', get_template_directory().'/languages' ); ?>

フィルター

[3.0.0]冒頭でロケールを決定するため'theme_locale'フィルターを呼び出す。パラメータ$localeにはサイトのロケール（[4.7.0]$localeがログインしている場合はそのユーザーのロケールを優先）が、$domainには本関数が受け取った内容が格納されている。 
$locale = apply_filters( 'theme_locale', $locale, $domain );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/l10n.php

最終更新 : 2018年10月29日 15:58

関連

参考

Code Reference: load_theme_textdomain

お勧め

Login rebuilder 2.6.0の新機能紹介（2019年4月22日 更新）

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

query_posts（WP_Queryクラス）で投稿タグを絞り込む（2011年9月14日 更新）

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts（WP_Queryクラス）でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

classic editorプラグインを試してみた（2018年12月10日 更新）

WordPress 5.0 beta1のリリースにあわせて旧エディター環境を実現できる「classic editor」（バージョン0.5.0）が公開された。自分が公開しているプラグインの一部が旧エディター環境に依存していることもあり、さっそく試してみた。WordPress 5.0正式リリースに合わせてclassic editorも1.0がリリースされたので、それについて追記しました。

コメントの「ウェブサイト」止めました（2014年4月15日 更新）

とあるサイトのスパムコメントが多く、その都度のスパム指定するのが面倒である。これまでいくつか対策を行ってきたが、そういった対応にもいい加減うんざりしてきたので、試験的に「ウェブサイト」を無効化しようと思った。

プラグインの設定ページもレスポンシブ対応（2014年6月3日 更新）

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。