translate_user_role() WordPress Function
The translate_user_role() function is used to translate a user role name into a different language. This is useful for multilingual sites where the user roles need to be displayed in the language of the user.
translate_user_role( string $name, string $domain = 'default' ) #
Translates role name.
Description
Since the role names are in the database and not in the source there are dummy gettext calls to get them into the POT file and this function properly translates them back.
The before_last_bar() call is needed, because older installations keep the roles using the old context format: ‘Role name|User role’ and just skipping the content after the last bar is easier than fixing them in the DB. New installations won’t suffer from that problem.
Parameters
- $name
(string)(Required)The role name.
- $domain
(string)(Optional) Text domain. Unique identifier for retrieving translated strings.
Default value: 'default'
Return
(string) Translated role name on success, original name on failure.
Source
File: wp-includes/l10n.php
function translate_user_role( $name, $domain = 'default' ) {
return translate_with_gettext_context( before_last_bar( $name ), 'User role', $domain );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.2.0 | Added the $domain parameter. |
| 2.8.0 | Introduced. |