投稿日:

WordPressの国際化

このエントリーをはてなブックマークに追加
はてなブックマーク - WordPressの国際化

WordPress の国際化について調べてみましたので、覚えたことを本稿にまとめておきます。基本的に本稿末尾にまとめてある参考サイトと同様の手順ですが、自分なりに引っかかった部分があったので、そのあたりを補足しながらまとめました。

事前の知識

WordPress での国際化について、全体的な流れは次のような感じになります。

  1. 環境の準備
  2. ソースコードの国際化
  3. .pot ファイルの作成
  4. .po ファイルの翻訳
  5. .mo ファイルのコンパイル

環境の準備は最初だけですね。ソースコードの国際化というのは決められた関数で文字列を出力することと、言語ファイルの読み込み設定の追加です。.pot、.po、.mo について詳しくは後述しますが、gettext という翻訳ライブラリの仕様に基づく構成ファイルです。

WordPress では多言語化の為に「gettext」という国際化とローカリゼーションの為のライブラリを利用します。gettext では、まずはアプリケーション中で翻訳が必要な箇所について、あらかじめ決められた構文で記述しています。そして出来上がったソースコードに対して、ツールを使って「.pot」という国際化の為のテンプレートファイルを自動作成します。この .pot ファイルを元に、各言語に翻訳した 「.po」ファイルを準備し、出来上がった po ファイルを「.mo」というバイナリファイルにコンパイルしてアプリケーションに組み込むことで、翻訳が適用されるようになります。

  • .pot — 翻訳するための元となるテンプレート
  • .po — 翻訳されたファイル
  • .mo — .po ファイルをコンパイルしたバイナリ。これが実際の表示に利用される

なお、gettext のこのような仕組みは、WordPress や PHP だけでなく、その他多くのプログラミング環境で提供され、多くのプロダクトで実際に利用されています。また、WordPress では gettext を少し拡張し、より便利に利用できるようになっています。

環境の準備

まず環境を準備します。次の２つの環境については事前に整えておいてください。

gettext のインストール

gettext 環境をインストールします。Homebrewのインストールが完了してから、次のコマンドでインストールしてください。

wordpress-i18n tools の準備

WordPressでは国際化の為に gettext を拡張する「wordpress-i18n tools」というツールがコチラで Subversion のリポジトリとして配布されています。これをあなたの環境にダウンロードしてください。場所は基本的にどこに置いておいても構いませんが、ここではユーザーのホームディレクトリに「wp-i18n」という名前のディレクトリを作って準備します。

ソースコードの国際化

ソースコードで国際化したい箇所全てを、WordPress に準備されている国際化の為の関数を使った記述に変更します。例えば次のように HTML 上で「タイトル:」と記述した箇所があるとします。

これを次のように変更します。

２行目を変更しています。関数「_e()」は、翻訳されたテキストを echo する関数です。第１引数が、翻訳のソースとなる文字列です。ある言語の翻訳ファイルが用意されていない時にはこの文字列がそのまま表示されることもあり、一般に英語で記述します。

第２引数の「mytextdomain」は「テキストドメイン」を指定しています。テキストドメインについては後述します。

このような記法で、ソースコード上での翻訳したい箇所をラップして記述していきます。

WordPress に用意されている関数は次の通りです：

__(), _e(), _n(), _x(), _ex(), _nx(), esc_attr__(), esc_attr_e(), esc_attr_x(), esc_html__(), esc_html_e(),esc_html_x(), _n_noop(), _nx_noop()

「__()」が基本で、翻訳テキストを取得します。たくさんあって難しいように見えますが、関数名が意味のある記号の集合として定義されているので、その意味を知るのは意外に簡単です。

  • 無印 — ローカライズされた文字列をそのまま返す。
  • e — 文字列を echo する
  • n — 単数形・複数形の違いを扱う
  • x — テキストの文脈を指定する
  • esc_attr — HTML 属性としてエスケープする
  • esc_html — HTML テキストとしてエスケープする
  • noop — 翻訳テキストされたテキストではなく、遅延評価するための情報を返す

「__()」はプレーンな翻訳テキストをそのまま返します。e が付く「_e()」などは、翻訳文字列を echo します。n が付いたものは、数量について単数と複数で異なる記述が必要な言語のサポートです。x が付いたものは、元の言語では同じ記述でも文脈によって意味合いの異なる文字列について、文脈（コンテキスト）を与えて正しく翻訳できるようなサポートが付いたものです。esc_attr、esc_html は文字通りの意味合いです。noop がついたものは遅延評価される形式で値を返します。

noop については分かり難いかも知れませんが、他の関数はコールしたその場で評価されて翻訳テキストを返すのに対して、noop 関数はその場では翻訳テキストを得るための情報のみを返すようになっています。これによって、場合によって幾つかの文字列の切り替えが必要な時に、必要なケースに対応する翻訳テキストのみを取得できる方法を提供します。

テンプレート中、ソースコード中など、翻訳が必要な箇所の全て上記の関数でラップしてください。

テキストドメイン

上の例の第２引数のようにして、全ての関数で、「テキストドメイン」と呼ばれる識別子を指定できます。

テキストドメインとは、そのテキストの意味的な所属を表す識別子です。文字列が同じでも、例えばプラグインやテーマによって、その翻訳が異なることもあります。それらを識別する為に、gettext ではその文字列が所属する意味の範囲（ドメイン）を、テキストドメインと呼ぶ識別子で指定することが出来ます。

WordPress では、プラグインやテーマ毎に、固有のテキストドメインを指定して管理します。なお、テキストドメインは分かり易さのために、一般にプラグインやテーマの名称と一致させます。

テキストドメインを読み込む

プラグインやテーマの初期化時に、テキストドメインを読み込みます。概ね次のような記述になるでしょう。

いずれの場合も第１引数はテキストドメイン名です。

load_plugin_textdomain() の第２引数は非推奨となったので利用しません。第３引数は、moファイルが置かれた場所で、wp-content/plugins/ 以下の相対パスで指定します。

load_theme_textdomain() の第２引数はテーマの mo ファイルが置かれた場所です。フルパスで指定します。

.pot ファイルの生成

ソースコード上の国際化の準備が整ったら、wordpress-i18n tools に含まれる「makepot.php」スクリプトを使って .pot ファイルを生成します。プラグインを例に説明します。

コンソールを開いて、.pot ファイルを作成したいプラグインのディレクトリまで移動します。そして言語リソースを納めるための languages ディレクトリを作成し、そして makepot.php を実行します。

php に先ほど svn コマンドで落とした wp-i18n ディレクトリの中に含まれる makepot.php を与えて実行します。第１引数「wp-plugin」は .pot ファイルの生成タイプです。プラグインなら「wp-plugin」、テーマなら「wp-theme」を設定します。第２引数は生成したいプラグインのディレクトリを指定します。例ではそのプラグインのディレクトリに居ますので、現在ディレクトリを示す「.」を指定しています。そして第３引数に出力先を与えます。ここでは、作成したばかりの「languages」ディレクトリの中に、「mytextdomain.pot」というファイル名で生成する指定としています。ここでのファイル名は、テキストドメインに一致させてください。

完了すると次のような .pot ファイルが、languages ディレクトリに作成されている筈です。

以上はプラグインでの例です。

テーマの場合、テーマのディレクトリに同じく languages ディレクトリを作成して管理するのが良いかと思います。なお、.po や .mo のファイル名は、「{ロケール名}.po」といったように、ロケール名だけをファイル名とします（.pot はテンプレートなので適当で良いでしょう）。makepot.php 実行時のファイルの生成タイプは「wp-theme」とします。

余談ですが、今回参考にさせて頂いたこちらのイケメン記事によると PHP5.4 ではエラーが出まくるそうですので、そこは適宜対応してください。またこちらの記事には、各コマンドのエイリアスの作成方法など、よりイケメンになるための手法も紹介されていますので、イケメンな方はどんどん楽しちゃってください。本稿では基本のみにとどめます。それから、プラグインの時ですが、プラグインを納めているディレクトリ名と同名のファイルがディレクトリ内の存在しないと、PHP の Warning が出力されましたのでご注意ください。おそらくディレクトリ名と同じ名前のプラグインの本体ファイルがディレクトリ内にあるもの、という想定で makepot.php が実装されているのかな、と思います。

.po ファイルの翻訳

.pot ファイルから日本語訳の入った .po ファイルを作成します。

まず、前節で作成した .pot ファイルを複製し、例えば日本語の場合、ファイル名を「mytextdomain-ja.po」とします。テキストドメイン名＋ハイフン＋言語のロケール（日本語は ja）＋拡張子です。拡張子は「.po」としてください。

翻訳はそのまま .po ファイルをテキストエディタで編集することが出来ます。他にも次のような翻訳支援アプリケーションを使って編集することもできますが、ここでの解説は割愛します。

.mo ファイルのコンパイル

gettext のコマンド「msgfmt」を使って .po ファイルを .mo ファイルにコンパイルします。.po が保存されているディレクトリに移動して、msgfmt コマンドを実行します。

-o オプションで出力ファイル名を指定し、同じファイル名で拡張子だけ変更した .mo ファイルを出力させています。

もしかしたらエラーが出るかも知れませんが、エラーメッセージを見て適宜対処できると思います。

.mo ファイルへのコンパイルに成功したら、ファイルをアップロードしてみましょう。ソースコード中で _e() やその他の国際化関数で出力していた文字列が、日本語として表示されていることをお祈りいたします！

以上です。

参考サイト

本稿をまとめるにあたって以下のページの情報を参考にさせて頂きました。ありがとうございます！

とくにイケメン先生のサイトは簡潔で分かり易かったですね。いつもありがとうございます！

 

コメントを残す