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

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

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

Default:'default'

Return

string Translated text on success, original text on failure.

Source

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;
}

Hooks

apply_filters( ‘gettext_with_context’, string $translation, string $text, string $context, string $domain )

Filters text with its translation based on context information.

apply_filters( “gettext_with_context_{$domain}”, string $translation, string $text, string $context, string $domain )

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

Changelog

VersionDescription
5.5.0Introduced gettext_with_context-{$domain} filter.
2.8.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.