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 * The block_login now displays the loginpage_idp_list() links as well as main login page.
   9 * The authentication plugin auth_radius has been moved to https://github.com/moodlehq/moodle-auth_radius
  10 * New auth_email::user_signup_with_confirmation() method has a new optional parameter $confirmationurl to provide a different
  11   confirmation URL.
  12 * New signup_is_enabled() function available in lib/authlib.php to safely check if sign-up is enabled in the site.
  13
  14 === 3.0 ===
  15
  16 * login_signup_form::signup_captcha_enabled() now calls is_captcha_enabled() from the current auth plugin instead of from auth_email
  17
  18 === 2.9 ===
  19
  20 * Do not update user->firstaccess from any auth plugin, the complete_user_login() does it automatically.
  21
  22 * Add user_add_password_history() to user_signup() method.
  23
  24 * New auth hook - pre_loginpage_hook() - available, triggered before redirecting to the login page.
  25
  26 === 2.8 ===
  27
  28 * \core\session\manager::session_exists() now verifies the session is active
  29   instead of only checking the session data is present in low level session handler
  30
  31 * MNet is no longer sending logs between the client and parent sites. auth_plugin_mnet::refresh_log() is now deprecated. There is
  32   no alternative. Please don't use this function.
  33
  34 === 2.7 ===
  35
  36 * If you are returning a url in method change_password_url() from config, please make sure it is set before trying to use it.
  37
  38 === 2.6 ===
  39
  40 * can_be_manually_set() - This function was introduced in the base class and returns false by default. If overriden by
  41   an authentication plugin to return true, the authentication plugin will be able to be manually set for users. For example,
  42   when bulk uploading users you will be able to select it as the authentication method they use.
  43
  44 === 2.4 ===
  45
  46 required changes in code:
  47 * use role_get_name() or role_fix_names() if you need any role names, using role.name
  48   directly from database is not correct any more
  49
  50 optional - no changes needed:
  51 * add support for custom user signup form - see auth_plugin_base::signup_form() function
  52
  53 === 2.2 ===
  54
  55 required changes in code:
  56 * the correct sequence to set up global $USER is:
  57     $user = get_complete_user_data('username', $username); // or $user = authenticate_user_login()
  58     enrol_check_plugins($user);
  59     session_set_user($user);