wppaste
WordPress

translate_with_gettext_context( string $text, string $context, string $domain = 'default' ): string

Since
2.8.0, 5.5.0
Source
wp-includes/l10n.php:261
Retrieves the translation of $text in the context defined in $context.

Description

If there is no translation, or the text domain isn't loaded, the original text is returned.

Note: Don't use translate_with_gettext_context() directly, use _x() or related functions.

Compatibility

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

$textstring
Text to translate.
$contextstring
Context information for the translators.
$domainstringoptional
Text domain. Unique identifier for retrieving translated strings.
Default 'default'.Default: 'default'

Return value

string
Translated text on success, original text on failure.

Performance profile

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

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

Plugin surface
2 hooks

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

Called by
6

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

WhenInstructionsCalls it makes
always30get_translations_for_domain(), ->translate(), apply_filters(), apply_filters()

Across PHP versions

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

Hooks and filters fired · 2

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

  1. apply_filters( gettext_with_context )filterline 275 (+14 into the body)

    Filters text with its translation based on context information.

  2. apply_filters( gettext_with_context_{$domain} )filterline 289 (+28 into the body)

    Filters text with its translation based on context information for a domain.

Uses · 2

Used by · 6

Source code

function translate_with_gettext_context( $text, $context, $domain = 'default' ) {	$translations = get_translations_for_domain( $domain );	$translation  = $translations->translate( $text, $context ); 	/**	 * Filters text with its translation based on context information.	 *	 * @since 2.8.0	 *	 * @param string $translation Translated text.	 * @param string $text        Text to translate.	 * @param string $context     Context information for the translators.	 * @param string $domain      Text domain. Unique identifier for retrieving translated strings.	 */	$translation = apply_filters( 'gettext_with_context', $translation, $text, $context, $domain ); 	/**	 * Filters text with its translation based on context information 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 $text        Text to translate.	 * @param string $context     Context information for the translators.	 * @param string $domain      Text domain. Unique identifier for retrieving translated strings.	 */	$translation = apply_filters( "gettext_with_context_{$domain}", $translation, $text, $context, $domain ); 	return $translation;}

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.

5.5.0
Introduced gettext_with_context-{$domain} filter.from the docblock
2.8.0
Introduced.from the docblock

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.