Merge branch 'MDL-80014' of https://github.com/paulholden/moodle
[moodle.git] / admin / upgrade.txt
blob2f76124b45b48c2e0d7d07f05af84a5fd3288948
1 This files describes API changes in /admin/*.
3 === 4.3 ===
5 * Removed admin setting cookiehttponly Moodle now defaults to HTTP only cookies for new installs only.
6   Existing sites will not be affected by this change. The setting can be changed in config.php if required.
7   To enable for upgraded sites set: $CFG->cookiehttponly = true;
8   To disable for new sites set: $CFG->cookiehttponly = false;
10   Existing cookies will not be affected by this change, until they are expired or deleted.
12 * Theme setting "Enable device detection" (enabledevicedetection) and related to it has been removed.
13 * Theme setting "Device detection regular expressions" (devicedetectregex) and related to it has been removed.
14 * Class adminpresets_admin_setting_devicedetectregex has been deprecated.
15 * The admin_setting_devicedetectregex class has been deprecated.
17 === 4.2 ===
19 * A new admin setting coursecreationguide allows admins to configure the URL of the Quickstart guide for admins and managers.
21 === 4.1 ===
23 * A new admin setting supportavailability allows admins to configure who the "contact site support" feature is available to
24   (everyone, authenticated users, or nobody).
25   -For new sites and those upgrading from 3.11.x or older, the default will be "Limited to authenticated users".
26   -For sites upgrading from 4.0.x, the default will be "available to anyone visiting the site", to main consistent behaviour through the upgrade.
28 === 4.0.1 ===
30 * A new callback xxx_pre_enable_plugin_actions has been added in admin/modules.php. Plugins can use this callback to
31   force additional actions (e.g. displaying notifications, modals, etc.) before enabling the plugin. The expected
32   return value (bool) from the plugin callback method specifies whether the process of enabling the plugin should
33   continue after the added actions or not.
35 === 3.11 ===
37 * New admin setting admin_setting_encryptedpassword allows passwords in admin settings to be
38   encrypted (with the new \core\encryption API) so that even the admin cannot read them.
39 * Web services administration has been moved from Plugins into the Server category. If you have
40   Behat tests containing steps like `Given I navigate to "Plugins > Web services > ..."`, you will
41   want to replace them with `Given I navigate to "Server > Web services > ..."`.
43 === 3.9 ===
45 * The following functions, previously used (exclusively) by upgrade steps are not available anymore because of the upgrade cleanup performed for this version. See MDL-65809 for more info:
46     - upgrade_fix_block_instance_configuration()
47     - upgrade_theme_is_from_family()
48     - upgrade_find_theme_location()
49     - linkcoursesectionsupgradescriptwasrun setting
50     - upgrade_block_positions()
52 === 3.8 ===
54 * Admin setting "Open to Google" (opentogoogle) has been renamed to the more generic "Open to search engines" (opentowebcrawlers).
55   This is a more accurate representation of what is being set and the config string has also been moved and updated to reflect this.
57 === 3.7 ===
59 * Admin setting "Allow blocks to use the dock" (allowblockstodock) has been removed & stings deprecated.
60   Docking of blocks is no longer supported within the core themes (Boost, Classic).
61   Please see MDL-64506 for further details.
63 === 3.3 ===
65 * The admin settings admin_setting_configselect and admin_setting_configmultiselect now support the optgroup tag.
66   Grouping of options can be created with this new tag.
67   For using it, the option parameters needs the Group names as indexes:
68   [
69     "Spain" =>  ["madrid" => "Madrid", "barcelona" => "Barcelona"],
70     "France" => ["paris" => "Paris", "marseille" => "Marseille"],
71   ]
73 === 3.2 ===
75 * Admin settings have been refined to better support right-to-left languages. In RTL,
76   most fields should not have their direction flipped, a URL, a path to a file, ...
77   are always displayed LTR. The admin setting will now best guess if they should be
78   RTLized based on their PARAM_* type. To override that guess, use
79   admin_setting::set_force_ltr(true/false).