auth/upgrade.txt

   1 This files describes API changes in /auth/* - plugins,
   2 information provided here is intended especially for developers.
   3
   4 === 3.2 ===
   5
   6 * New auth hook - pre_user_login_hook() - available, triggered right after the user object is created.
   7   This can be used to modify the user object before any authentication errors are raised.
   8
   9 === 3.0 ===
  10
  11 * login_signup_form::signup_captcha_enabled() now calls is_captcha_enabled() from the current auth plugin instead of from auth_email
  12
  13 === 2.9 ===
  14
  15 * Do not update user->firstaccess from any auth plugin, the complete_user_login() does it automatically.
  16
  17 * Add user_add_password_history() to user_signup() method.
  18
  19 * New auth hook - pre_loginpage_hook() - available, triggered before redirecting to the login page.
  20
  21 === 2.8 ===
  22
  23 * \core\session\manager::session_exists() now verifies the session is active
  24   instead of only checking the session data is present in low level session handler
  25
  26 * MNet is no longer sending logs between the client and parent sites. auth_plugin_mnet::refresh_log() is now deprecated. There is
  27   no alternative. Please don't use this function.
  28
  29 === 2.7 ===
  30
  31 * If you are returning a url in method change_password_url() from config, please make sure it is set before trying to use it.
  32
  33 === 2.6 ===
  34
  35 * can_be_manually_set() - This function was introduced in the base class and returns false by default. If overriden by
  36   an authentication plugin to return true, the authentication plugin will be able to be manually set for users. For example,
  37   when bulk uploading users you will be able to select it as the authentication method they use.
  38
  39 === 2.4 ===
  40
  41 required changes in code:
  42 * use role_get_name() or role_fix_names() if you need any role names, using role.name
  43   directly from database is not correct any more
  44
  45 optional - no changes needed:
  46 * add support for custom user signup form - see auth_plugin_base::signup_form() function
  47
  48 === 2.2 ===
  49
  50 required changes in code:
  51 * the correct sequence to set up global $USER is:
  52     $user = get_complete_user_data('username', $username); // or $user = authenticate_user_login()
  53     enrol_check_plugins($user);
  54     session_set_user($user);