load_theme_textdomain() の使い方|説明・引数・注意点

説明

load_theme_textdomain() は、テーマの翻訳ファイルを読み込む関数です。

基本構文

load_theme_textdomain( string $domain, string|false $path = false ): bool

引数

  • $domain:テキストドメイン
  • $path:翻訳ファイルのディレクトリ

戻り値

読み込めたら true。

使い方(サンプル)

add_action( 'after_setup_theme', function() {
	load_theme_textdomain( 'my-theme', get_template_directory() . '/languages' );
} );

注意点

  • after_setup_theme フックで呼びます。

実務での使いどころ

  • テーマの、翻訳ファイル(.mo)を、読み込むとき。

よくあるミスと対処

  • after_setup_theme フックの外で呼んでいる。
  • テキストドメインが、style.css のヘッダーや、翻訳関数に書いたものと、違う。
  • 翻訳ファイルの場所(languages フォルダ)を、指定していない。

NG例

load_theme_textdomain( 'my-theme' ); // フックの外で、場所も指定していない

OK例

add_action( 'after_setup_theme', function () {
	load_theme_textdomain( 'my-theme', get_template_directory() . '/languages' );
} );

使い分け早見表

関数 対象
load_theme_textdomain() テーマの翻訳
load_plugin_textdomain() プラグインの翻訳
get_locale() サイトの言語を取得する

関連項目

load_plugin_textdomain()、__()

公式リファレンス:load_theme_textdomain() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました