translate_with_gettext_context( string $text, string $context, string $domain = 'default' )
Retrieve 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
-
(string) (Required) Text to translate.
- $context
-
(string) (Required) Context information for the translators.
- $domain
-
(string) (Optional) Text domain. Unique identifier for retrieving translated strings.
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 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, `$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
Version | Description |
---|---|
5.5.0 | Introduced gettext_with_context-{$domain} filter. |
2.8.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/translate_with_gettext_context