_nx() – Translates and retrieves the singular or plural form based on the supplied number, with gettext context.

You appear to be a bot. Output may be restricted

Description

Translates and retrieves the singular or plural form based on the supplied number, with gettext context.

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 ) );

Usage

$string = _nx( $single, $plural, $number, $context, $domain );

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 default: default – Optional. Text domain. Unique identifier for retrieving translated strings. Default 'default'.

Returns

string The translated singular or plural form.

Source

File name: wordpress/wp-includes/l10n.php
Lines:

1 to 36 of 36
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.
 */
  $translation = apply_filters( 'ngettext_with_context', $translation, $single, $plural, $number, $context, $domain );

  
/**
 * Filters the singular or plural form of a string with gettext context for a domain.
 *
 * The dynamic portion of the hook name, `$domain`, refers to the text domain.
 *
 * @since 5.5.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.
 */
  $translation = apply_filters( "ngettext_with_context_{$domain}", $translation, $single, $plural, $number, $context, $domain );

  return $translation;
}
 

 View on GitHub View on Trac