_nx( string $single, string $plural, int $number, string $context, string $domain = 'default' )
Translates and retrieves the singular or plural form based on the supplied number, with gettext context.
Description Description
This is a hybrid of _n() and _x(). It supports context and plurals.
Used when you want to use the appropriate form of a string with context based on whether a number is singular or plural.
Example of a generic phrase which is disambiguated via the context parameter:
printf( _nx( '%s group', '%s groups', $people, 'group of people', 'text-domain' ), number_format_i18n( $people ) );
printf( _nx( '%s group', '%s groups', $animals, 'group of animals', 'text-domain' ), number_format_i18n( $animals ) );
Parameters Parameters
- $single
-
(string) (Required) The text to be used if the number is singular.
- $plural
-
(string) (Required) The text to be used if the number is plural.
- $number
-
(int) (Required) The number to compare against to use either the singular or plural form.
- $context
-
(string) (Required) Context information for the translators.
- $domain
-
(string) (Optional) Text domain. Unique identifier for retrieving translated strings.
Default value: 'default'
Return Return
(string) The translated singular or plural form.
Source Source
File: wp-includes/l10n.php
function _nx( $single, $plural, $number, $context, $domain = 'default' ) { $translations = get_translations_for_domain( $domain ); $translation = $translations->translate_plural( $single, $plural, $number, $context ); /** * Filters the singular or plural form of a string with gettext context. * * @since 2.8.0 * * @param string $translation Translated text. * @param string $single The text to be used if the number is singular. * @param string $plural The text to be used if the number is plural. * @param string $number The number to compare against to use either the singular or plural form. * @param string $context Context information for the translators. * @param string $domain Text domain. Unique identifier for retrieving translated strings. */ return apply_filters( 'ngettext_with_context', $translation, $single, $plural, $number, $context, $domain ); }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
2.8.0 | Introduced. |