_nx

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

Description

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

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:

Returns (string)

The translated singular or plural form.

Parameters (5)

0. $single (string)
The text to be used if the number is singular.
1. $plural (string)
The text to be used if the number is plural.
2. $number (number)
The number to compare against to use either the singular or plural form.
3. $context (string)
Context information for the translators.
4. $domain — Optional. (string) => 'default'
Text domain. Unique identifier for retrieving translated strings. Default default..

Usage

  1. if ( !function_exists( '_nx' ) ) { 
  2.     require_once ABSPATH . WPINC . '/l10n.php'; 
  3. } 
  4.   
  5. // The text to be used if the number is singular. 
  6. $single = ''; 
  7.   
  8. // The text to be used if the number is plural. 
  9. $plural = ''; 
  10.   
  11. // The number to compare against to use either the singular or plural form. 
  12. $number = null; 
  13.   
  14. // Context information for the translators. 
  15. $context = ''; 
  16.   
  17. // Optional. Text domain. Unique identifier for retrieving translated strings. 
  18. // Default 'default'. 
  19. $domain = 'default'; 
  20.   
  21. // NOTICE! Understand what this does before running. 
  22. $result = _nx($single, $plural, $number, $context, $domain); 
  23.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/l10n.php  
  1. function _nx($single, $plural, $number, $context, $domain = 'default') { 
  2.     $translations = get_translations_for_domain( $domain ); 
  3.     $translation = $translations->translate_plural( $single, $plural, $number, $context ); 
  4.  
  5.     /** 
  6.      * Filters the singular or plural form of a string with gettext context. 
  7.      * 
  8.      * @since 2.8.0 
  9.      * 
  10.      * @param string $translation Translated text. 
  11.      * @param string $single      The text to be used if the number is singular. 
  12.      * @param string $plural      The text to be used if the number is plural. 
  13.      * @param string $number      The number to compare against to use either the singular or plural form. 
  14.      * @param string $context     Context information for the translators. 
  15.      * @param string $domain      Text domain. Unique identifier for retrieving translated strings. 
  16.      */ 
  17.     return apply_filters( 'ngettext_with_context', $translation, $single, $plural, $number, $context, $domain ); 
  18. }