translate_user_role( string $name, string $domain ): string

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

$namestringrequired: The role name.
$domainstringoptional: Text domain. Unique identifier for retrieving translated strings.
Default 'default'.

Return

string Translated role name on success, original name on failure.

Source

function translate_user_role( $name, $domain = 'default' ) {
	return translate_with_gettext_context( before_last_bar( $name ), 'User role', $domain );
}

View all references View on Trac View on GitHub

Uses	Description
translate_with_gettext_context()`wp-includes/l10n.php`	Retrieves the translation of $text in the context defined in $context.
before_last_bar()`wp-includes/l10n.php`	Removes last item on a pipe-delimited string.

Used by	Description
WP_Users_List_Table::get_role_list()`wp-admin/includes/class-wp-users-list-table.php`	Returns an array of translated user role names for a given user object.
wp_dropdown_roles()`wp-admin/includes/template.php`	Prints out option HTML elements for role selectors.
WP_Users_List_Table::get_views()`wp-admin/includes/class-wp-users-list-table.php`	Returns an associative array listing all the views that can be used with this table.
admin_created_user_email()`wp-admin/includes/user.php`

Changelog

Version	Description
5.2.0	Added the `$domain` parameter.
2.8.0	Introduced.

User Contributed Notes

Skip to note 2 content

mahdiazarm 6 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
Always make sure that the first letter of $name is Capitalized!
For example this will fail and return the original $name
```
translate_user_role( 'administrator' ); // return administrator
```
but this one will return the translation of $name
```
translate_user_role( 'Administrator' ); // return translation of Administrator
```
Log in to add feedback

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