MDL-53765 mod_resource/mod_wiki: Removed update_module_button()
[moodle.git] / mod / upgrade.txt
CommitLineData
9c82ff2a 1This files describes API changes in /mod/* - activity modules,
2information provided here is intended especially for developers.
3
8fef061d
MG
4=== 3.2 ===
5
6* Callback delete_course is deprecated and should be replaced with observer for event \core\event\course_content_deleted
7
88acc87d
DM
8=== 3.1 ===
9
10* Old /mod/MODULENAME/pix/icon.gif and enrol/paypal/pix/icon.gif GIF icons have been removed. Please use pix_icon
11 renderable instead.
9ca0420e
MG
12* Callback get_types() is deprecated, instead activity modules can define callback get_shortcuts().
13 See source code for get_module_metadata().
88acc87d 14
0b9fc18b
JL
15=== 3.0 ===
16
01889f01
DM
17* Dropped support for the $module in mod/xxx/version.php files (deprecated
18 since 2.7). All activity modules must use the $plugin syntax now. See
19 https://docs.moodle.org/dev/version.php for details (MDL-43896).
731c2712
AA
20* Modules using rating component must implement a callback mod_x_rating_can_see_item_ratings(). Refer
21 to mod_forum_rating_can_see_item_ratings() for example.
0b9fc18b 22
8164fad4 23=== 2.9 ===
f7a84c63 24
8164fad4 25* Added Grade to pass field to mod_form for activities that support grading.
f7a84c63
DM
26* The method moodleform_mod::add_intro_editor() used in mod_form.php form
27 definitions has been deprecated. Replace it with the new
28 moodleform_mod::standard_intro_elements() method that takes the new site
29 configuration requiremodintro into account (MDL-49101).
8164fad4 30
061e6b28 31=== 2.8 ===
32
33* Constant FEATURE_GROUPMEMBERSONLY is deprecated. Modules should remove this
34 constant from their module_supports() API function.
35* $CFG->enablegroupmembersonly no longer exists.
36
59766233
JM
37=== 2.7 ===
38
39* modgrade form element has been redesigned and allows setting the maximum grade point higher than 100.
09027084
DM
40* The usage of $module in mod/xxx/version.php files is now deprecated. Please use
41 $plugin instead. The support for the legacy notation will be dropped in Moodle 2.10.
b2b4ec30
RT
42* xxx_get_view_actions() and xxx_get_post_actions() will be ignored by new logging system for
43 participation report. view_action and post_action will be detected by event's crud and edulevel.
70279746
MN
44* The functions xxx_user_outline() and xxx_user_complete() have been removed from the majority of core modules (see MDL-41286),
45 except for those that require unique functionality. These functions are used by the outline report, but now if they no longer
46 exist, the default behaviour is chosen, which supports the legacy and standard log storages introduced in 2.7 (see MDL-41266).
47 It is highly recommended you remove these functions from your module if they are simply performing the default behaviour.
59766233 48
50ae8814
MN
49=== 2.6 ===
50
b07ef13b
DP
51* Modules using the question bank MUST now declare their use of it with the xxx_supports()
52 flag FEATURE_USES_QUESTIONS.
50ae8814
MN
53* xxx_get_types() module callback can now return subtypes that have
54 a custom help text set. Also instead of array it can now return
55 MOD_SUBTYPE_NO_CHILDREN. This is optional and still defaults to prior
56 behavior. See get_module_metadata() in course/lib.php for details.
fb032ccb
DP
57* shift_course_mod_dates() has been modified to accept optional mod instance id. If mod instance id is passed then
58 dates changed will happen only on specific module instance and not on all instances of that module in course.
9c82ff2a 59
0662bd67
PS
60=== 2.5 ===
61
62* support for 'mod/*' filters was removed
63
7d59d8da
PS
64=== 2.4 ===
65
66new features:
67
68* mod/xxx/adminlib.php may now include 'plugininfo_yoursubplugintype' class definition
69 used by plugin_manager; it is recommended to store extra admin settings classes in this file
76fb0443 70
27affa26
AA
71optional - no changes needed:
72
73* mod_lesson_renderer::header() now accepts an additional parameter $extrapagetitle
7d59d8da 74
76fb0443
AG
75* mod/data/lib.php data_get_all_recordids() now has two new optional variables: $selectdata and $params.
76
0f0c0228
TH
77=== 2.3 ===
78
79required changes in code:
daefd6eb 80
0f0c0228
TH
81* define the capability mod/xxx:addinstance (and the corresponding lang string)
82 (unless your mod is a MOD_ARCHETYPE_SYSTEM).
261cbbac
DM
83* xxx_pluginfile() is now given the 7th parameter (hopefully the last one) that
84 contains additional options for the file serving. The array should be re-passed
85 to send_stored_file().
0f0c0228 86
daefd6eb 87* most resourcelib_embed_* functions are replaced with core_media_renderer;
88 for an example, see mod/resource/locallib.php, resource_display_embed()
89
652cc648
DS
90optional - no changes needed:
91
92* add support for handling course drag and drop types - functions
93 xxx_dndupload_register() and xxx_dndupload_handle($uploadinfo) see:
94 http://docs.moodle.org/dev/Implementing_Course_drag_and_drop_upload_support_in_a_module
0f0c0228 95
ee362526
PS
96=== 2.2 ===
97
98required changes in code:
99* fix missing parameter types in optional_param() and required_param()
100* use new optional_param_array(), required_param_array() or clean_param_array() when dealing with array parameters
2f1e464a 101* core_text::asort() replaced by specialized core_collator::asort()
ee362526
PS
102* use new make_temp_directory() and make_cache_directory()
103
104
105=== 2.1 ===
106
107required changes in code:
108* add new support for basic restore from 1.9
109
110
111=== 2.0 ===
44f2977c 112
9c82ff2a 113required changes in code:
114* use new DML syntax everywhere
728ebac7 115 (http://docs.moodle.org/dev/DML_functions)
9c82ff2a 116* use new DDL syntax in db/upgrade.php
728ebac7 117 (http://docs.moodle.org/dev/DDL_functions)
9c82ff2a 118* replace defaults.php by settings.php and db/install.php
847400a7 119* replace STATEMENTS section in db/install.xml with PHP code db/install.php or db/log.php
9cb56578 120* move post installation code from lib.php into db/install.php
56f7ff74 121* move uninstallation code from lib.php to db/uninstall.php
8026a943
PS
122* new mandatory naming of intro and introformat table fields in module tables,
123 the presence of these fields is indicated in xxx_plugin_supports()
9c82ff2a 124* completely rewrite file handling
728ebac7 125 (http://docs.moodle.org/dev/File_API)
9c82ff2a 126* rewrite backup/restore
44f2977c 127 (not finished yet)
9cb56578
PS
128* rewrite trusttext support - new db table columns needed
129* migrate all module features from mod_edit.php form to lib.php/modulename_supports() function
398a160d 130* implement new gradebook support (legacy 1.8.x grading not supported anymore)
44f2977c
PS
131* migrate custom resource module subtypes into separate modules,
132 necessary only for custom plugins in mod/resource/
af34490a 133* use new $PAGE and $OUTPUT instead of old weblib functions
78946b9b
PS
134* theme changes: move plugin styles into mod/xxx/styles.css and use new css markers for images,
135 move all images into new mod/xxx/pix/ directory and use new outputlib api
136 move module icon to mod/xxx/pix/icon.gif
cbcc9852 137 old global $THEME is fully replaced by $OUTPUT
8026a943 138 create plugin renderers
728ebac7 139 (http://docs.moodle.org/dev/Theme_changes_in_2.0)
b7534190 140* migrate all javascript new coding style using YUI3+YUI2
728ebac7 141 (http://docs.moodle.org/dev/JavaScript_usage_guide)
2b0e098e
PS
142* remove '_utf8' from lang pack names, use new {a} syntax
143* replace helps with new 'xxx_hlp' strings
7070ca36 144* please note the $plugin->requires in version.php has to be bigger than 2010000000,
dae88219 145 otherwise the plugin is marked as outdated and upgrade is interrupted
9c82ff2a 146
147optional - no changes needed in older code:
dbf9e4ba 148* settingstree.php replaced by settings.php - just unset the $settings if you want to make custom part of settings admin tree
ff3ad2d9
PS
149* support for new mforms editor element and embedded files
150 (not finished yet)
9c82ff2a 151* portfolio support
728ebac7 152 (http://docs.moodle.org/dev/Portfolio_API)
9c82ff2a 153* course completion tracking support
8026a943
PS
154* new navigation features
155* new comments API
728ebac7 156 (http://docs.moodle.org/dev/Comments_2.0)
8026a943 157* new ratings API
728ebac7 158 (http://docs.moodle.org/dev/Ratings_2.0)
9c82ff2a 159