Merge branch 'MDL-48753_m27' of git://github.com/markn86/moodle into MOODLE_27_STABLE
[moodle.git] / auth / upgrade.txt
blob8334fed703d7269de907e974bfb2fc010676dcc6
1 This files describes API changes in /auth/* - plugins,
2 information provided here is intended especially for developers.
4 === 2.7 ===
6 * If you are returning a url in method change_password_url() from config, please make sure it is set before trying to use it.
8 === 2.6 ===
10 * can_be_manually_set() - This function was introduced in the base class and returns false by default. If overriden by
11   an authentication plugin to return true, the authentication plugin will be able to be manually set for users. For example,
12   when bulk uploading users you will be able to select it as the authentication method they use.
14 === 2.4 ===
16 required changes in code:
17 * use role_get_name() or role_fix_names() if you need any role names, using role.name
18   directly from database is not correct any more
20 optional - no changes needed:
21 * add support for custom user signup form - see auth_plugin_base::signup_form() function
23 === 2.2 ===
25 required changes in code:
26 * the correct sequence to set up global $USER is:
27     $user = get_complete_user_data('username', $username); // or $user = authenticate_user_login()
28     enrol_check_plugins($user);
29     session_set_user($user);