W3cubDocs

/WordPress

translate_user_role( string $name, string $domain = ‘default’ ): 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'.

Default:'default'

Return

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

Source

* @return string[] An array of language codes or an empty array if no languages are present.
*                  Language codes are formed by stripping the file extension from the language file names.
*/

Changelog

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

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