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

お勧め

初期状態で「抜粋」ウィジェットを表示する（2014年1月7日 更新）

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

LevelとCapability（2018年5月27日 更新）

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。

管理画面の'アイキャッチ画像'を'写真'に変える（2013年1月23日 更新）

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

購読者は管理者ページのアクセス禁止（2013年11月12日 更新）

購読者（subscriber）は、通常「ダッシュボード」「プロフィール」にアクセスできるが、今回はプロフィールを独自に管理する準備を兼ねて、これらのページにアクセスできないようにブロックしてみた。

WordPressのコーディングスタンダードとPSR-2がかみ合わない（2018年5月27日 更新）

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon（4.6）」から「Oxygen（4.7）」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style（Formatter）」が「PSR-2」に設定されていることが原因だった。