wppaste
WordPress

__ngettext( $args )

Since
1.2.0
Source
wp-includes/deprecated.php:1823
Retrieve the plural or single form based on the amount.

Compatibility

Deprecated in WordPress 2.8.0. Use _n()

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

$args

Performance profile

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

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksdo_action()one call below __ngettext()

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

WhenInstructionsCalls it makes
always11_deprecated_function(), _n()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev11110
8.511110
8.411110
8.311110
8.211110
8.1111101 more instruction than PHP 7.4
7.410100

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

  • _deprecated_function()Marks a function as deprecated and inform when it has been used.
  • _n()Translates and retrieves the singular or plural form based on the supplied number.

Source code

View on Trac View on GitHub 

function __ngettext( ...$args ) { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore	_deprecated_function( __FUNCTION__, '2.8.0', '_n()' );	return _n( ...$args );}

Changelog

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

2.8.0
Deprecated. Use _n()from the docblock
1.2.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/deprecated.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.