translate_user_role( string $name, string $domain = 'default' )

Translates role name.

Contents

Description 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 Parameters

$name

(string) (Required) The role name.

$domain

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

Default value: 'default'

Top ↑

Return Return

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

Top ↑

Source 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 code Collapse full source code View on Trac

Top ↑

Changelog Changelog

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

Top ↑

Top ↑

Used By Used By

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()

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Jory Hogeveen —

    Please note that `translate_user_role` doesn’t work in the front-end currently.

    Here is a workaround, you can place this in your theme:

    add_action( 'init', 'load_admin_textdomain_in_front' )
function load_admin_textdomain_in_front() {
    if ( ! is_admin() ) {
        load_textdomain( 'default', WP_LANG_DIR . '/admin-' . get_locale() . '.mo' );
    }
}

    @see: https://core.trac.wordpress.org/ticket/37539

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