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

Retrieve the translation of $text in the context defined in $context.


Description 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.


Top ↑

Parameters 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'


Top ↑

Return Return

(string) Translated text on success, original text on failure.



Top ↑

Source 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.
	 */
	return apply_filters( 'gettext_with_context', $translation, $text, $context, $domain );
}

Top ↑

Changelog Changelog

Changelog
Version Description
2.8.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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