自作モジュールが多言語に翻訳されやすいようにするためのコーディングのTipsを紹介します。
Drupalではtという関数を使って、t('文字列')という記述をおこなうことで、該当する言語の翻訳がある場合に文字列部分を翻訳された文字列に置き換えることができます。
$message = t('welcome');
という場合に、welcomeの翻訳文字「ようこそ」が存在している場合には、$messageには'ようこそ'が代入されます。
特別な記号文字をプレイスホルダーとして使うことで動的な情報を元に翻訳をおこなうようにすることができるようになります。
たとえば以下のようになります。
- $output = t('現在の会員数：%members、オンラインしている人数：%visitors',
- '%members' => $total_users,
- '%visitors' => $guests->count,
- )
- );
このプレイスホルダーには以下の３種類があります。
「!」これは特別な処理はおこなわずそのままテキストの置き換えをします。
「@」これは置き換えられるテキスト中のHTML特殊文字のエスケープ処理をまずおこなってから置き換えがされます。セキュリティのためにも通常はこれを使用するのが好ましいです。
- $title = t("@name's blog",
- '@name' => $account->name
- )
- );
「%」これは置き換えられるテキスト中のHTML特殊文字のエスケープ処理をおこない、次にtheme_placeholder()関数でハイライト処理をしたのちに置き換えられます。theme_placeholder()関数はデフォルトでは<em></em>タグで囲んで強調をします。
- $message = t('%name-from sent %name-to an e-mail.',
- '%name-from' => $user->name,
- '%name-to' => $account->name
- )
- );
t()関数を使う場合にはできるだけ１つの文は分断することなく１つのt()関数コールに含めるようにするべきです。これは言語によっては主語や述語の位置などがまったく異なることもあり、１つの文が複数に分割されてt()コールされると、適切な翻訳をおこなうことが困難になるからです。
複数形の処理
- $output = t('There are currently %members and %visitors online.',
- '%members' => format_plural($total_users, '1 user', '@count users'),
- '%visitors' => format_plural($guests->count, '1 guest', '@count guests')
- )
- );
format_plural(カウント、１の場合のテキスト、複数の場合のテキスト);
複数の場合のテキストにおいては「@count」を記述することで実際のカウント値に置き換えられます。
参考ページ
t()関数http://api.drupal.org/api/function/t
format_plural()関数
http://api.drupal.org/api/function/format_plural/