Merge branch 'MDL-77533-400' of https://github.com/paulholden/moodle into MOODLE_400_...
[moodle.git] / admin / upgrade.txt
blobdf789ff29b9156d599aee199535b320f7d9d6300
1 This files describes API changes in /admin/*.
3 === 4.0.1 ===
5 * A new callback xxx_pre_enable_plugin_actions has been added in admin/modules.php. Plugins can use this callback to
6   force additional actions (e.g. displaying notifications, modals, etc.) before enabling the plugin. The expected
7   return value (bool) from the plugin callback method specifies whether the process of enabling the plugin should
8   continue after the added actions or not.
10 === 3.11 ===
12 * New admin setting admin_setting_encryptedpassword allows passwords in admin settings to be
13   encrypted (with the new \core\encryption API) so that even the admin cannot read them.
14 * Web services administration has been moved from Plugins into the Server category. If you have
15   Behat tests containing steps like `Given I navigate to "Plugins > Web services > ..."`, you will
16   want to replace them with `Given I navigate to "Server > Web services > ..."`.
18 === 3.9 ===
20 * 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:
21     - upgrade_fix_block_instance_configuration()
22     - upgrade_theme_is_from_family()
23     - upgrade_find_theme_location()
24     - linkcoursesectionsupgradescriptwasrun setting
25     - upgrade_block_positions()
27 === 3.8 ===
29 * Admin setting "Open to Google" (opentogoogle) has been renamed to the more generic "Open to search engines" (opentowebcrawlers).
30   This is a more accurate representation of what is being set and the config string has also been moved and updated to reflect this.
32 === 3.7 ===
34 * Admin setting "Allow blocks to use the dock" (allowblockstodock) has been removed & stings deprecated.
35   Docking of blocks is no longer supported within the core themes (Boost, Classic).
36   Please see MDL-64506 for further details.
38 === 3.3 ===
40 * The admin settings admin_setting_configselect and admin_setting_configmultiselect now support the optgroup tag.
41   Grouping of options can be created with this new tag.
42   For using it, the option parameters needs the Group names as indexes:
43   [
44     "Spain" =>  ["madrid" => "Madrid", "barcelona" => "Barcelona"],
45     "France" => ["paris" => "Paris", "marseille" => "Marseille"],
46   ]
48 === 3.2 ===
50 * Admin settings have been refined to better support right-to-left languages. In RTL,
51   most fields should not have their direction flipped, a URL, a path to a file, ...
52   are always displayed LTR. The admin setting will now best guess if they should be
53   RTLized based on their PARAM_* type. To override that guess, use
54   admin_setting::set_force_ltr(true/false).