load_plugin_textdomain() の使い方｜説明・引数・注意点

説明

基本構文

load_plugin_textdomain( string $domain, string|false $deprecated = false, string|false $plugin_rel_path = false ): bool

引数

• $domain：テキストドメイン
• $deprecated：使用しません
• $plugin_rel_path：翻訳ファイルの場所

戻り値

読み込めたら true。

使い方（サンプル）

add_action( 'init', function() {
	load_plugin_textdomain( 'my-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );
} );

注意点

• WordPress 4.6 以降、WordPress.orgで配布するプラグインは自動で読み込まれます。

実務での使いどころ

• プラグインの、翻訳ファイル（.mo）を、読み込むとき。

よくあるミスと対処

• init より前に呼び、またはテキストドメインを、読み込む前に、翻訳関数を呼ぶ。翻訳されない、または警告が出る。init フックで呼ぶ。
• テキストドメインが、プラグインのヘッダーや、翻訳関数に書いたものと、違う。
• 翻訳ファイルの場所（languages フォルダ）を、間違えている。

NG例

load_plugin_textdomain( 'my-plugin' ); // 翻訳ファイルの場所を指定していない

OK例

add_action( 'init', function () {
	load_plugin_textdomain( 'my-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );
} );

使い分け早見表

関連項目

load_theme_textdomain()、__()

公式リファレンス：load_plugin_textdomain() | Function | WordPress Developer Resources