wppaste
WordPress

_nx_noop( string $singular, string $plural, string $context, string $domain = null ): array

Since
2.8.0
Source
wp-includes/l10n.php:654
Registers plural strings with gettext context in POT file, but does not translate them.

Description

Used when you want to keep structures with translatable plural strings and use them later when the number is known.

Example of a generic phrase which is disambiguated via the context parameter:

$messages = array(
 'people' => _nx_noop( '%s group', '%s groups', 'people', 'text-domain' ),
 'animals' => _nx_noop( '%s group', '%s groups', 'animals', 'text-domain' ),
);
...
$message = $messages[ $type ];
printf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );

Compatibility

WordPress
since 2.8.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

$singularstring
Singular form to be localized.
$pluralstring
Plural form to be localized.
$contextstring
Context information for the translators.
$domainstringoptional
Text domain. Unique identifier for retrieving translated strings.
Default null.Default: null

Return value

array
Array of translation information for the strings.

  • $0string

    Singular form to be localized. No longer used.

  • $1string

    Plural form to be localized. No longer used.

  • $2string

    Context information for the translators. No longer used.

  • $singularstring

    Singular form to be localized.

  • $pluralstring

    Plural form to be localized.

  • $contextstring

    Context information for the translators.

  • $domainstring|null

    Text domain.

Performance profile

How much work a call to _nx_noop() 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
12

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
2

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

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_noop() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always12none

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 12 instructions, 12 executed per call, 0 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.

Used by · 2

Source code

View on Trac View on GitHub 

function _nx_noop( $singular, $plural, $context, $domain = null ) {	return array(		0          => $singular,		1          => $plural,		2          => $context,		'singular' => $singular,		'plural'   => $plural,		'context'  => $context,		'domain'   => $domain,	);}

Changelog

Introduced in 2.8.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 6.8.8 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.