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

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。