translate() WordPress Function

The translate() function allows you to translate a string using the WordPress translation API. This function takes two parameters: the string to be translated and the target language. If the target language is not specified, WordPress will try to determine the language based on the current user's language settings.

translate( string $text, string $domain = 'default' ) #

Retrieve the translation of $text.


Description

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

_Note:_ Don’t use translate() directly, use __() or related functions.


Top ↑

Parameters

$text

(string)(Required)Text to translate.

$domain

(string)(Optional) Text domain. Unique identifier for retrieving translated strings.

Default value: 'default'


Top ↑

Return

(string) Translated text.


Top ↑

Source

File: wp-includes/l10n.php

function translate( $text, $domain = 'default' ) {
	$translations = get_translations_for_domain( $domain );
	$translation  = $translations->translate( $text );

	/**
	 * Filters text with its translation.
	 *
	 * @since 2.0.11
	 *
	 * @param string $translation Translated text.
	 * @param string $text        Text to translate.
	 * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
	 */
	$translation = apply_filters( 'gettext', $translation, $text, $domain );

	/**
	 * Filters text with its translation 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 $domain      Text domain. Unique identifier for retrieving translated strings.
	 */
	$translation = apply_filters( "gettext_{$domain}", $translation, $text, $domain );

	return $translation;
}


Top ↑

Changelog

Changelog
VersionDescription
5.5.0Introduced gettext-{$domain} filter.
2.2.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.