_n( string $single, string $plural, int $number, string $domain = 'default' ): string

Translates and retrieves the singular or plural form based on the supplied number.


Description

Used when you want to use the appropriate form of a string based on whether a number is singular or plural.

Example:

printf( _n( '%s person', '%s people', $count, 'text-domain' ), number_format_i18n( $count ) );

Top ↑

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

Default: 'default'


Top ↑

Return

string The translated singular or plural form.


Top ↑

Source

File: wp-includes/l10n.php. View all references

function _n( $single, $plural, $number, $domain = 'default' ) {
	$translations = get_translations_for_domain( $domain );
	$translation  = $translations->translate_plural( $single, $plural, $number );

	/**
	 * Filters the singular or plural form of a string.
	 *
	 * @since 2.2.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 $domain      Text domain. Unique identifier for retrieving translated strings.
	 */
	$translation = apply_filters( 'ngettext', $translation, $single, $plural, $number, $domain );

	/**
	 * Filters the singular or plural form of a string 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 $domain      Text domain. Unique identifier for retrieving translated strings.
	 */
	$translation = apply_filters( "ngettext_{$domain}", $translation, $single, $plural, $number, $domain );

	return $translation;
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
5.5.0 Introduced ngettext-{$domain} filter.
2.8.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    Contributed by Codex

    Display either “1 star” or “x stars” for a star rating plugin.

    $rating = '3';
    
    $text = sprintf( _n( '%s star', '%s stars', $rating, 'wpdocs_textdomain' ), $rating );
    
    // "3 stars"
    echo $text;

    Important: Never do a calculation inside the sprintf() function! The following won’t work:

    $text = sprintf( 
    	_n( '%s star', '%s stars', $rating, 'wpdocs_textdomain' ), 
    	2 <= $rating ? $rating -1 : $rating
    );
  2. Skip to note 2 content
    Contributed by Felipe Elia

    As explained by @sergeybiryukov here, here, here and here, this functions should NOT be use in one item or more than one item scenarios, but for singular form and plural forms, which is not the same thing. Also both strings should have placeholders.

    As he stated:

    In languages that have complex plural structures the singular form can be used for numbers other than 1, so if the goal is to display a string for exactly 1 item, an explicit check like

    1 === count( $items )

    should be used instead of

    _n()

    This problem is also covered in Codex.

    Although it would be possible address this issue changing the plural form for Russian and other slavic languages it would bring a too big effort as explained here.

You must log in before being able to contribute a note or feedback.