Moodle 3.10自定义认证插件用户创建重复问题及正确实现方式咨询

我想要为Moodle 3.10编写一个自定义认证插件。当用户尝试通过登录表单登录时，插件会调用外部API验证凭据，只有验证通过才能登录；若用户账户不存在，则自动创建。

目前我已完成以下代码：

class auth_plugin_externalapi extends auth_plugin_base {
   

    user_login($username, $password){
        global $DB;
        
        $user = login_via_api($username, $password);
    
        if(empty($user)){
           return false;
        }
    
        if(!$DB->get_record('user', array('username' => $api_data->username)){
            user_create_user($user);
        }
    
        return true;
    }
}

但该方案存在问题：当user_login方法被lib/moodlelib.php中的authenticate_user_login方法调用时，用户会被重复创建。

请问在Moodle中是否有通过认证插件创建用户的特定方式？还是需要修改lib/moodlelib.php中的代码？

解决方案 #

绝对不要修改lib/moodlelib.php核心代码，这会导致后续版本升级出现兼容问题，也违反Moodle的开发规范。Moodle认证插件有专门的用户同步机制，以下是正确的实现方式：

问题根源 #

你的代码在user_login里直接创建用户，同时存在变量错误（比如未定义的$api_data，实际应该用$user），导致判断用户是否存在的逻辑失效；再加上authenticate_user_login在认证通过后可能触发的核心同步流程，最终造成用户重复创建。

标准实现流程 #

Moodle认证插件的正确逻辑是：

1. user_login仅负责凭据验证，返回布尔值表示验证结果。
2. 实现get_userinfo方法，从外部API获取完整的用户信息。
3. 开启插件的自动创建用户配置，让Moodle核心处理用户的创建/同步逻辑。

修改后的示例代码：

class auth_plugin_externalapi extends auth_plugin_base {

    public function __construct() {
        parent::__construct();
        $this->autocreate = true; // 声明插件支持自动创建用户
    }

    public function user_login($username, $password) {
        // 仅验证凭据有效性，不处理用户创建
        $api_response = login_via_api($username, $password);
        return !empty($api_response);
    }

    public function get_userinfo($username) {
        // 从外部API获取用户完整数据，返回符合Moodle user表结构的数组
        $user_data = get_user_from_api($username);
        if (empty($user_data)) {
            return false;
        }

        // 映射Moodle所需的必填字段
        return [
            'username' => $user_data->username,
            'email' => $user_data->email,
            'firstname' => $user_data->firstname,
            'lastname' => $user_data->lastname,
            'auth' => 'externalapi', // 指定用户的认证方式为当前插件
            'confirmed' => 1, // 标记用户已通过外部验证
        ];
    }

    // 可选：自定义用户创建后的逻辑，比如添加角色、设置自定义字段
    public function user_created($user, $newuser = false) {
        // 这里可以添加自定义操作
        parent::user_created($user, $newuser);
    }
}

关键配置补充 #

在插件的settings.php中添加自动创建用户的开关配置：

$settings->add(new admin_setting_configcheckbox(
    'auth_externalapi/autocreate',
    get_string('autocreate', 'auth_externalapi'),
    get_string('autocreate_desc', 'auth_externalapi'),
    1 // 默认开启自动创建
));

核心逻辑说明 #

Moodle的authenticate_user_login方法在验证通过后，会自动调用当前认证插件的get_userinfo方法：

• 如果用户不存在，核心会用get_userinfo返回的数据创建用户
• 如果用户已存在，会根据插件配置决定是否同步更新用户信息

这套机制完全避免了重复创建用户的问题，同时遵循Moodle开发规范，保证插件的可维护性和版本兼容性。

内容的提问来源于stack exchange，提问作者Adam