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

Uses

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

Used By

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

Changelog

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

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/translate_user_role