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



お勧め

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

Widgets on dashboard:プラグイン作ってみました(2014年5月7日 更新)

サイトバーなどのページ構成パーツとしてウィジェットを利用し、ある程度頻繁に更新している場合、毎回ウィジェットページを表示するのはちょっとだけ面倒かも。そんなわけで、シンプルにダッシュボードで直接編集できればいいかなと思い、調べてみました。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。