WordPressプラグインを多言語化に対応する

投稿日 2012年7月20日
更新日 2013年1月4日
著者キタジマタカシ
カテゴリー WordPress

WordPressにはテーマやプラグインを多言語化（翻訳）するための機能が備わっています。より多くの人がテーマやプラグインを使用できるよう、多言語化することが推奨されています。今回、はじめてプラグインの多言語化に挑戦してみたので、方法をまとめてみました。環境はMac OS X 10.7.4です。

多言語化にあたっては、下記のリソースが参考になりました。

プラグインの多言語化

翻訳する文字列をマークする

WordPressでは、gettextというライブラリを用いて国際化を実現します。翻訳したい部分を関数に通すことで、適切な文字列に翻訳されます。ここで使用する関数は主に下記の2つです。

__( ‘文字列’, ドメイン )	文字列の訳を返します。第2引数は一意な識別子のことで、これに基づいてロードする翻訳ファイルが決定されます。プラグインのベースネームが推奨されてるようです。
_e( ‘文字列’, ドメイン )	文字列の訳を出力します。

ドメインの選択と読み込み

翻訳ファイルを読み込むために、プラグインのはじめのほうに「load_plugin_textdomain」関数を記述します。

// 翻訳ファイルはプラグインディレクトリ内の「languages」というディレクトリに保存するのが慣例のようです。
load_plugin_textdomain( ドメイン, false, basename( dirname( __FILE__ ) ) . '/languages' );

プラグインのヘッダーコメント部分も国際化対応する

プラグインの管理画面に表示するプラグインの説明や作者情報なども翻訳可能です。プラグインのヘッダーコメント部分にドメインとパスを追加することで対応できるようです。

/**
 * Plugin Name: 〜
 * 〜
 * Text Domain: 多言語化ファイルのドメイン
 * Domain Path: /languages/
 */

POTファイルを作成する

「WordPress 日本語版チーム資料/リリース作業 – WordPress Codex 日本語版」に「補足1:手元で pot を作成する」としてPOTファイルの作成方法が掲載されていましたので、その方法で行います。Suvbersionやphpといったコマンドを使用しますが、Macのターミナルから普通に実行できました（恐らくXcodeのインストールが必要です）。

# ツールのチェックアウト
$ svn checkout http://svn.automattic.com/wordpress-i18n/tools/trunk/tools
# POTファイルを作成
# テーマの場合は wp-plugin の部分を wp-theme とするようです。
$ php tools/makepot.php wp-plugin プラグインの保存ディレクトリ

Macのphpの設定をしていないためか、timezoneを設定してくださいといったWarningがでましたが、ホームディレクトリにPOTファイルは作成されていましたので、そのままそれを使うことにします。

POTファイルを開き、念のため上部の設定部分をWordPress本体のPOTファイルを参考に追記します。

"Last-Translator: 翻訳者名 <翻訳者のメールアドレス>\n"
"Language-Team: 翻訳者のURL\n"
"Plural-Forms: nplurals=1; plural=0\n"
"X-Poedit-Language: Japanese\n"
"X-Poedit-Country: JAPAN\n"
"X-Poedit-SourceCharset: utf-8\n"