@aarondewes/wp-i18n 中文文档教程

Question

Internationalization (i18n)

用于客户端本地化的国际化实用程序。 有关服务器端文档，请参阅如何国际化您的插件。

Installation

安装模块：

npm install @aarondewes/wp-i18n --save

此包假定您的代码将在 ES2015+ 环境中运行。 如果您使用的环境对 ES2015+ 的支持有限或不支持，例如 IE 浏览器，那么使用 core-js 将添加这些方法的 polyfill。

Usage

import { sprintf, _n } from '@aarondewes/wp-i18n';

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

有关完整示例，请参阅块编辑器手册的国际化部分。

API

# createI18n

创建一个 i18n 实例

参数

• initialData [LocaleData]: Locale data configuration.
• initialDomain [string]: Domain for which configuration applies.
• hooks [Hooks]: Hooks implementation.

返回

• I18n: I18n instance

# defaultI18n

I18n 的默认单例实例。

# getLocaleData

以 Jed 格式的 JSON 对象形状按域返回区域设置数据。

相关

• http://messageformat.github.io/Jed/

参数

• domain [string]: Domain for which to get the data.

返回

• LocaleData: Locale data.

# hasTranslation

检查给定字符串是否有翻译（单数形式）。

参数

• single string: Singular form of the string to look up.
• context [string]: Context information for the translators.
• domain [string]: Domain to retrieve the translated text.

返回

• boolean: Whether the translation exists or not.

# isRTL

检查当前语言环境是否为 RTL。

RTL（从右到左） 是一个语言环境属性，表示文本是从右到左书写的。 例如，he 语言环境（希伯来语）指定从右到左。 阿拉伯语 (ar) 是另一种常见的 语言书面RTL。 与RTL相反，LTR（Left To Right）在其他语言中使用， 包括英语（en、en-US、en-GB等）、西班牙语（es）、和法语 (fr)。

返回

• boolean: Whether locale is RTL.

# resetLocaleData

重置所有当前的 Tannin 实例区域设置数据并设置指定的 域的语言环境数据。 接受 Jed 格式的 JSON 对象形状的数据。

相关

• http://messageformat.github.io/Jed/

参数

• data [LocaleData]: Locale data configuration.
• domain [string]: Domain for which configuration applies.

# setLocaleData

将语言环境数据合并到 Tannin 实例中按域。 接受数据 Jed 格式的 JSON 对象形状。

相关

• http://messageformat.github.io/Jed/

参数

• data [LocaleData]: Locale data configuration.
• domain [string]: Domain for which configuration applies.

# sprintf

返回格式化字符串。 如果在应用格式时发生错误，则 返回原始格式字符串。

相关

• https://www.npmjs.com/package/sprintf-js

参数

• format string: The format of the string to generate.
• args ...*: Arguments to apply to the format.

返回值

• string: The formatted string.

# 订阅

订阅语言环境数据的变化

参数

• callback SubscribeCallback: Subscription callback

返回

• UnsubscribeCallback: Unsubscribe callback

# _n

根据所提供的翻译和检索单数或复数形式 数字。

相关

• https://developer.wordpress.org/reference/functions/_n/

参数

• single string: The text to be used if the number is singular.
• plural string: The text to be used if the number is plural.
• number number: The number to compare against to use either the singular or plural form.
• domain [string]: Domain to retrieve the translated text.

返回值

• string: The translated singular or plural form.

# _nx

根据所提供的翻译和检索单数或复数形式 数字，带有 gettext 上下文。

相关

• https://developer.wordpress.org/reference/functions/_nx/

参数

• single string: The text to be used if the number is singular.
• plural string: The text to be used if the number is plural.
• number number: The number to compare against to use either the singular or plural form.
• context string: Context information for the translators.
• domain [string]: Domain to retrieve the translated text.

返回

• string: The translated singular or plural form.

# _x

使用 gettext 上下文检索翻译后的字符串。

相关

• https://developer.wordpress.org/reference/functions/_x/

参数

• text string: Text to translate.
• context string: Context information for the translators.
• domain [string]: Domain to retrieve the translated text.

返回值

• string: Translated context string without pipe.

# __

检索文本的翻译。

相关

• https://developer.wordpress.org/reference/functions/__/

参数

• text string: Text to translate.
• domain [string]: Domain to retrieve the translated text.

返回值

• string: Translated text.