translate_with_gettext_context( string $text, string $context, string $domain = 'default' )
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.
Parameters
- $text
-
(Required) Text to translate.
- $context
-
(Required) Context information for the translators.
- $domain
-
(Optional) Text domain. Unique identifier for retrieving translated strings.<br> Default 'default'.
Default value: 'default'
Return
(string) Translated text on success, original text on failure.
Source
File: wp-includes/l10n.php
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 WP-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.
*/
return apply_filters( 'gettext_with_context', $translation, $text, $context, $domain );
}
Changelog
| Version | Description |
|---|---|
| 5.5.0 | Introduced gettext_with_context-{$domain} filter. |
| 2.8.0 | Introduced. |