@wordpress/i18n

クライアント側ローカライズ用の国際化ユーティリティ。サーバー側のドキュメントについては How to Internationalize Your Plugin を参照してください。

インストール

モジュールをインストールするには次のコマンドを実行してください。

npm install @wordpress/i18n --save

このパッケージはコードが ES2015+ 環境で動作することを仮定します。ES2015+ を一部、またはまったくサポートしない環境、たとえば IE の古いバージョンで実行する場合は core-jsまたは @babel/polyfill を使用することでサポートを追加できます。詳細については Babel のドキュメント を参照してください。

使用方法

import { sprintf, _n } from '@wordpress/i18n';

sprintf( _n( '%d hat', '%d hats', 4, 'text-domain' ), 4 );
// 4 hats

完全なサンプルについては ブロックエディターハンドブックの「国際化」 を参照してください。

API

# createI18n

i18n インスタンスを作成する。

パラメータ

  • initialData [LocaleData]: ロケールデータ構成
  • initialDomain [string]: 構成を適用するドメイン

返り値

  • I18n: I18n インスタンス

# isRTL

現在のロケールが RTL かどうかをチェックする。

RTL (Right To Left、右から左) はテキストが右から左に書かれることを示すロケールプロパティです。 例えば he ロケール (ヘブライ語) はこの RTL を指定します。アラビア語 (ar) は別の代表的な RTL で書かれる言語です。 RTL の反対、LTR (Left To Right、左から右) は残りの言語で使用されます。例えば英語 (enen-USen-GB等)、スペイン語 (es)、 フランス語 (fr)、日本語 (ja) など。

返り値

  • boolean: ロケールが RTL かどうか

# setLocaleData

ロケールデータをドメインで Tannin インスタンスにマージする。Jed 形式 JSON オブジェクトのデータを受け付けます。

関連

パラメータ

  • data [LocaleData]: ロケールデータ構成
  • domain [string]: 構成を適用するドメイン

# sprintf

フォーマットされた文字列を返す。フォーマットの適用時にエラーが発生すると、オリジナルのフォーマット文字列が返されます。

関連

パラメータ

  • format string: 生成する文字列のフォーマット
  • args ...*: フォーマットに適用する引数

返り値

  • string: フォーマットされた文字列

# _n

与えられた数字に基づいて単数形、または複数形のフォームを翻訳して取得する。

関連

パラメータ

  • single string: 数値が1の場合に使用されるテキスト
  • plural string: 数値が2以上の場合に使用されるテキスト
  • number number: 単数形、複数形どちらのフォームを使うかを比較する数値
  • domain [string]: 翻訳テキストを取得するドメイン

返り値

  • string: 翻訳された単数形、または複数形のフォーム

# _nx

gettext コンテキストに応じて、与えられた数字に基づいて単数形、または複数形のフォームを翻訳して取得する。

関連

パラメータ

  • single string: 数値が1の場合に使用されるテキスト
  • plural string: 数値が2以上の場合に使用されるテキスト
  • number number: 単数形、複数形どちらのフォームを使うかを比較する数値
  • context string: コンテキスト情報
  • domain [string]: 翻訳テキストを取得するドメイン

返り値

  • string: 翻訳された単数形、または複数形のフォーム

# _x

gettext コンテキストに応じて翻訳された文字列を取得する。

関連

パラメータ

  • text string: 翻訳するテキスト
  • context string: コンテキスト情報
  • domain [string]: 翻訳テキストを取得するドメイン

返り値

  • string: コンテキストに応じて翻訳された文字列

# __

テキストの翻訳を取得する。

関連

パラメータ

  • text string: 翻訳するテキスト
  • domain [string]: 翻訳テキストを取得するドメイン

返り値

  • string: 翻訳されたテキスト
Code is Poetry.

最終更新日: