インストール

モジュールをインストールします:

  1. npm install @wordpress/i18n --save

このパッケージは、あなたのコードがES2015+環境で実行されることを前提としています。もし、言語機能やAPIのサポートが限られているか、全くない環境を使用している場合は、コードに@wordpress/babel-preset-defaultに同梱されているポリフィルを含める必要があります。

使用法

  1. import { sprintf, _n } from '@wordpress/i18n';
  2. sprintf( _n( '%d hat', '%d hats', 4, 'text-domain' ), 4 );
  3. // 4 hats

完全な例については、ブロックエディタハンドブックの国際化セクションを参照してください。

API

createI18n

i18nインスタンスを作成します

パラメータ

  • initialData [LocaleData]: ロケールデータの構成。
  • initialDomain [string]: 構成が適用されるドメイン。
  • hooks [Hooks]: フックの実装。

戻り値

  • I18n: I18nインスタンス。

defaultI18n

I18nのデフォルトのシングルトンインスタンス。

getLocaleData

ドメインによってロケールデータをJed形式のJSONオブジェクトとして返します。

関連

パラメータ

  • domain [string]: データを取得するためのドメイン。

戻り値

  • LocaleData: ロケールデータ。

hasTranslation

指定された文字列(単数形)の翻訳が存在するかどうかを確認します。

パラメータ

  • single string: 照会する文字列の単数形。
  • context [string]: 翻訳者のためのコンテキスト情報。
  • domain [string]: 翻訳されたテキストを取得するためのドメイン。

戻り値

  • boolean: 翻訳が存在するかどうか。

isRTL

現在のロケールがRTLかどうかを確認します。

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

戻り値

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

resetLocaleData

現在のTanninインスタンスのロケールデータをすべてリセットし、ドメインの指定されたロケールデータを設定します。Jed形式のJSONオブジェクトとしてデータを受け入れます。

関連

パラメータ

  • data [LocaleData]: ロケールデータの構成。
  • domain [string]: 構成が適用されるドメイン。

setLocaleData

ドメインによってTanninインスタンスにロケールデータをマージします。Jed形式のJSONオブジェクトとしてデータを受け入れます。

関連

パラメータ

  • data [LocaleData]: ロケールデータの構成。
  • domain [string]: 構成が適用されるドメイン。

sprintf

フォーマットされた文字列を返します。フォーマットの適用中にエラーが発生した場合、元のフォーマット文字列が返されます。

関連

パラメータ

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

戻り値

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

subscribe

ロケールデータの変更にサブスクライブします

パラメータ

  • callback SubscribeCallback: サブスクリプションコールバック

戻り値

  • UnsubscribeCallback: サブスクリプション解除コールバック

_n

提供された数に基づいて単数形または複数形を翻訳して取得します。

関連

パラメータ

  • single string: 数が単数の場合に使用されるテキスト。
  • plural string: 数が複数の場合に使用されるテキスト。
  • number number: 単数形または複数形を使用するために比較する数。
  • domain [string]: 翻訳されたテキストを取得するためのドメイン。

戻り値

  • string: 翻訳された単数形または複数形。

_nx

提供された数に基づいて単数形または複数形を翻訳して取得し、gettextコンテキストを使用します。

関連

パラメータ

  • single string: 数が単数の場合に使用されるテキスト。
  • plural string: 数が複数の場合に使用されるテキスト。
  • number number: 単数形または複数形を使用するために比較する数。
  • context string: 翻訳者のためのコンテキスト情報。
  • domain [string]: 翻訳されたテキストを取得するためのドメイン。

戻り値

  • string: 翻訳された単数形または複数形。

_x

gettextコンテキストを使用して翻訳された文字列を取得します。

関連

パラメータ

  • text string: 翻訳するテキスト。
  • context string: 翻訳者のためのコンテキスト情報。
  • domain [string]: 翻訳されたテキストを取得するためのドメイン。

戻り値

  • string: パイプなしの翻訳されたコンテキスト文字列。

__

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

関連

パラメータ

  • text string: 翻訳するテキスト。
  • domain [string]: 翻訳されたテキストを取得するためのドメイン。

戻り値

  • string: 翻訳されたテキスト。

このパッケージへの貢献

これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主な貢献者ガイドをお読みください。