@wordpress/i18n
Topics
クライアント側ローカライズ用の国際化ユーティリティ。サーバー側のドキュメントについては How to Internationalize Your Plugin を参照してください。
インストール
モジュールをインストールするには次のコマンドを実行してください。
npm install @wordpress/i18n --save
このパッケージは、コードが ES2015+ 環境で実行されることを仮定しています。その言語機能や API の一部のみ、または、まったくサポートしない環境で使用するには、コードに @wordpress/babel-preset-default の polyfill を含めてください。
使用方法
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]: 構成を適用するドメイン - hooks
[Hooks]: フックの実装
戻り値
I18n: I18n インスタンス
defaultI18n
デフォルトの I18n のシングルトンインスタンス。
getLocaleData
Jed 形式の JSON オブジェクト形でドメインのロケールデータを返す。
関連
パラメータ
- domain
[string]: データを取得するドメイン。
戻り値
LocaleData: ロケールデータ。
hasTranslation
与えられた文字列の (単数形の) 翻訳があるかどうかをチェックする。
パラメータ
- single
string: 検索する文字列の単数形。 - context
[string]: 翻訳のコンテキスト情報。 - domain
[string]: 翻訳テキストを取得するドメイン。
戻り値
boolean: 翻訳が存在するかどうか。
isRTL
現在のロケールが RTL かどうかをチェックする。
RTL (Right To Left、右から左) はテキストが右から左に書かれることを示すロケールプロパティです。 例えば he ロケール (ヘブライ語) はこの RTL を指定します。アラビア語 (ar) は別の代表的な RTL で書かれる言語です。 RTL の反対、LTR (Left To Right、左から右) はその他の言語で使用されます。例えば英語 (en、en-US、en-GB等)、スペイン語 (es)、 フランス語 (fr)、日本語 (ja) など。
戻り値
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: 数値が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: 翻訳されたテキスト
このパッケージへのコントリビュート
これは、Gutenberg プロジェクトの一部である、個別パッケージです。このプロジェクトは、monorepo として構成されています。複数の自己完結型ソフトウェアパッケージで構成されており、それぞれが特定の目的を持ちます。この monorepo のパッケージは npm で公開され、WordPress や他のソフトウェアプロジェクトで利用されています。
このパッケージや Gutenberg 全体へのコントリビュートの詳細については、プロジェクトのメインのコントリビューターガイドを参照ください。
最終更新日: