ngettext

Filters the singular or plural form of a string.

Description

apply_filters( 'ngettext', (string) $translation, (string) $single, (string) $plural, (number) $number, (string) $domain ); 

Parameters (5)

0. $translation (string)
The translation.
1. $single (string)
The text to be used if the number is singular.
2. $plural (string)
The text to be used if the number is plural.
3. $number (number)
The number to compare against to use either the singular or plural form.
4. $domain (string)
Text domain. Unique identifier for retrieving translated strings.

Usage

To run the hook, copy the example below.
  1. $translation = apply_filters( 'ngettext', $translation, $single, $plural, $number, $domain ); 
  2.  
  3. if ( !empty( $translation ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the ngettext callback 
  2. function filter_ngettext( $translation, $single, $plural, $number, $domain ) { 
  3. // make filter magic happen here... 
  4. return $translation
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'ngettext', 'filter_ngettext', 10, 5 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'ngettext', 'filter_ngettext', 10, 5 ); 

Defined (1)

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

/wp-includes/l10n.php  
  1. return apply_filters( 'ngettext', $translation, $single, $plural, $number, $domain );