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

Description

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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$singlestring

The text to be used if the number is singular.

$pluralstring

The text to be used if the number is plural.

$numberint

The number to compare against to use either the singular or plural form.

$contextstring

Context information for the translators.

$domainstringoptional

Text domain. Unique identifier for retrieving translated strings.
Default 'default'.Default: 'default'

Return value

string

The translated singular or plural form.

Performance profile

How much work a call to _nx() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

38

Executed per call on PHP 8.5. The body compiles to 38.

Plugin surface

2 hooks

Third-party callbacks on 'ngettext_with_context', 'ngettext_with_context_{$domain}' run inside this call, and their cost is not bounded by anything here.

Called by

9

9 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost _nx() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while _nx() runs, in this order:

1. 1
   apply_filters( ngettext_with_context )filterline 558 (+16 into the body)

   Filters the singular or plural form of a string with gettext context.

2. 2
   apply_filters( ngettext_with_context_{$domain} )filterline 574 (+32 into the body)

   Filters the singular or plural form of a string with gettext context for a domain.

Uses · 2

• get_translations_for_domain()Returns the Translations instance for a text domain.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 9

• WP_MS_Themes_List_Table::get_views()Gets the list of views (statuses) for the list table.
• WP_MS_Users_List_Table::get_views()
• WP_Plugin_Install_List_Table::display_rows()Generates the list table rows.
• WP_Plugins_List_Table::get_views()Gets an associative array of status filter links for the views area.
• WP_Posts_List_Table::get_views()
• WP_Privacy_Requests_Table::get_views()Gets an associative array ( id => link ) with the list of views available on this table.
• WP_Users_List_Table::get_views()Returns an associative array listing all the views that can be used with this table.
• install_plugin_information()Displays plugin information in dialog box form.
• translate_nooped_plural()Translates and returns the singular or plural form of a string that's been registered with _n_noop() or _nx_noop().

Source code

View on Trac ↗View on GitHub ↗

542function _nx( $single, $plural, $number, $context, $domain = 'default' ) {543	$translations = get_translations_for_domain( $domain );544	$translation  = $translations->translate_plural( $single, $plural, $number, $context );545 546	/**547	 * Filters the singular or plural form of a string with gettext context.548	 *549	 * @since 2.8.0550	 *551	 * @param string $translation Translated text.552	 * @param string $single      The text to be used if the number is singular.553	 * @param string $plural      The text to be used if the number is plural.554	 * @param int    $number      The number to compare against to use either the singular or plural form.555	 * @param string $context     Context information for the translators.556	 * @param string $domain      Text domain. Unique identifier for retrieving translated strings.557	 */558	$translation = apply_filters( 'ngettext_with_context', $translation, $single, $plural, $number, $context, $domain );559 560	/**561	 * Filters the singular or plural form of a string with gettext context for a domain.562	 *563	 * The dynamic portion of the hook name, `$domain`, refers to the text domain.564	 *565	 * @since 5.5.0566	 *567	 * @param string $translation Translated text.568	 * @param string $single      The text to be used if the number is singular.569	 * @param string $plural      The text to be used if the number is plural.570	 * @param int    $number      The number to compare against to use either the singular or plural form.571	 * @param string $context     Context information for the translators.572	 * @param string $domain      Text domain. Unique identifier for retrieving translated strings.573	 */574	$translation = apply_filters( "ngettext_with_context_{$domain}", $translation, $single, $plural, $number, $context, $domain );575 576	return $translation;577}

Changelog

Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/l10n.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.