
本文详细讲解如何在 moodle 自定义区块(如页脚)中安全、准确地获取并显示当前登录用户的角色名称,涵盖数据库查询误区、moodle 原生 api 推荐用法及完整可运行代码示例。
本文详细讲解如何在 moodle 自定义区块(如页脚)中安全、准确地获取并显示当前登录用户的角色名称,涵盖数据库查询误区、moodle 原生 api 推荐用法及完整可运行代码示例。
在 Moodle 开发中,直接操作 role_assignments 表虽可行,但容易出错——该表仅存储 roleid 和上下文信息,不包含角色名称;且示例代码中存在关键变量错误($user->id 应为 $USER->id)。更规范、健壮的做法是使用 Moodle 内置的 get_user_roles() 函数,它自动关联角色定义、上下文权限,并返回已本地化(支持多语言)的角色对象。
以下是修正后的完整区块实现(兼容 Moodle 3.9+,推荐用于系统级上下文):
class block_add extends block_base {
function init() {
$this->title = get_string('pluginname', 'block_add');
}
function applicable_formats() {
return array('all' => true, 'tag' => false);
}
function specialization() {
$this->title = isset($this->config->title) ? $this->config->title : get_string('newblock', 'block_add');
}
function instance_allow_multiple() {
return true;
}
function get_content() {
if ($this->content !== null) {
return $this->content;
}
$this->content = new stdClass();
$this->content->text = ''; // 可选:主内容区留空或填充其他内容
$this->content->footer = '';
global $USER, $PAGE;
// ✅ 正确方式:获取当前用户在系统上下文中的所有角色(含名称)
$systemcontext = \context_system::instance();
$roles = get_user_roles($systemcontext, $USER->id, true); // 第三个参数 true → 排序并去重
if (!empty($roles)) {
$roleNames = [];
foreach ($roles as $role) {
// 使用 get_string() 确保角色名支持多语言(如 'manager', 'teacher' 等)
$roleNames[] = s($role->name); // s() 防 XSS
}
$this->content->footer = '<div class="block-role-footer">' .
get_string('roles', 'block_add') . ': ' .
implode(', ', $roleNames) .
'</div>';
} else {
$this->content->footer = '<div class="block-role-footer">' .
get_string('norolesassigned', 'block_add') .
'</div>';
}
return $this->content;
}
function has_config() {
return true;
}
}
? 关键注意事项:
-
上下文选择很重要:
context_system::instance()获取全局角色(如管理员、经理);若需课程内角色,请改用$PAGE->context或指定课程上下文(如\context_course::instance($courseid))。 -
安全性:始终使用
s()过滤输出,防止 XSS;避免直接拼接未过滤的数据库字段。 -
性能:
get_user_roles()已内部缓存,比手动 JOINrole表更高效。 -
语言支持:
$role->name是已翻译的字符串(依赖get_string()机制),无需额外处理。 -
空值处理:务必检查
$roles是否为空,避免 PHP 警告。
✅ 总结:优先使用 Moodle 封装函数(如 get_user_roles())而非直查数据表,既保证功能正确性,又提升代码可维护性与安全性。角色展示应明确上下文范围,并始终进行输出转义与空值兜底。










