load_theme_textdomain

説明

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



お勧め

4.2.3でちょっと変わったショートコード(2018年5月27日 更新)

4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

Gutenbergエディターのフォントを変える(2018年10月16日 更新)

Gutenbergエディターを試していてしっくりこないのが、編集時とそれを投稿した際の見た目の違い。GutenbergエディターとテーマTwenty Seventeenとではまったく異なるタイプのフォントが適用されていることが大きな理由である。

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。