wppaste
WordPress

translate_nooped_plural( array $nooped_plural, int $count, string $domain = 'default' ): string

Since
3.1.0
Source
wp-includes/l10n.php:693
Translates and returns the singular or plural form of a string that's been registered with _n_noop() or _nx_noop().

Description

Used when you want to use a translatable plural string once the number is known.

Example:

$message = _n_noop( '%s post', '%s posts', 'text-domain' );
...
printf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );

Compatibility

WordPress
since 3.1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$nooped_pluralarray
Array that is usually a return value from _n_noop() or _nx_noop().

  • $singularstring

    Singular form to be localized.

  • $pluralstring

    Plural form to be localized.

  • $contextstring|null

    Context information for the translators.

  • $domainstring|null

    Text domain.
$countint
Number of objects.
$domainstringoptional
Text domain. Unique identifier for retrieving translated strings. If $nooped_plural contains a text domain passed to _n_noop() or _nx_noop(), it will override this value. Default 'default'.Default: 'default'

Return value

string
Either $singular or $plural translated text.

Performance profile

How much work a call to translate_nooped_plural() 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
18–23

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 34.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
7

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

What it touches

  • hookthird-party callbacksapply_filters()one call below translate_nooped_plural()

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 · 2 distinct outcomes

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

WhenInstructionsCalls it makes
!$nooped_plural18–20_n()
$nooped_plural21–23_nx()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 34 instructions, 18–23 executed per call, 2 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

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

Used by · 7

Source code

View on Trac View on GitHub 

function translate_nooped_plural( $nooped_plural, $count, $domain = 'default' ) {	if ( $nooped_plural['domain'] ) {		$domain = $nooped_plural['domain'];	} 	if ( $nooped_plural['context'] ) {		return _nx( $nooped_plural['singular'], $nooped_plural['plural'], $count, $nooped_plural['context'], $domain );	} else {		return _n( $nooped_plural['singular'], $nooped_plural['plural'], $count, $domain );	}}

Changelog

Introduced in 3.1.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.