MDL-68454 table: Improve documentation for dynamic table
[moodle.git] / lib / upgrade.txt
690a55f6 1This files describes API changes in core libraries and APIs,
ee362526 2information provided here is intended especially for developers.
1cb5c7b3 3
2ead888f 4=== 3.9 ===
5* Old Safe Exam Browser quiz access rule (quizaccess_safebrowser) replaced by new Safe Exam Browser access rule (quizaccess_seb).
6 Experimental setting enablesafebrowserintegration was deleted.
3df84921 7* New CFPropertyList library has been added to Moodle core in /lib/plist.
8* behat_data_generators::the_following_exist() has been removed, please use
9 behat_data_generators::the_following_entities_exist() instead. See MDL-67691 for more info.
10* admin/tool/task/cli/adhoc_task.php now observers the concurrency limits.
11 If you want to get the previous (unlimited) behavior, use the --ignorelimits switch).
08f3363b 12* Removed the following deprecated functions:
13 - question_add_tops
14 - question_is_only_toplevel_category_in_context
15* format_float() now accepts a special value (-1) as the $decimalpoints parameter
16 which means auto-detecting number of decimal points.
17* plagiarism_save_form_elements() has been deprecated. Please use {plugin name}_coursemodule_edit_post_actions() instead.
18* plagiarism_get_form_elements_module() has been deprecated. Please use {plugin name}_coursemodule_standard_elements() instead.
859ed92f 19* Changed default sessiontimeout to 8 hours to cover most normal working days
20* Plugins can now explicitly declare supported and incompatible Moodle versions in version.php
21 - $plugin->supported = [37,39];
22 supported takes an array of ascending numbers, that correspond to a range of branch numbers of supported versions, inclusive.
23 Moodle versions that are outside of this range will produce a message notifying at install time, but will allow for installation.
24 - $plugin->incompatible = 36;
25 incompatible takes a single int corresponding to the first incompatible branch. Any Moodle versions including and
26 above this will be prevented from installing the plugin, and a message will be given when attempting installation.
b2eec327 27* Added the <component>_bulk_user_actions() callback which returns a list of custom action_links objects
28* Add 'required' admin flag for mod forms allows elements to be toggled between being required or not in admin settings.
29 - In mod settings, along with lock, advanced flags, the required flag can now be set with $setting->set_required_flag_options().
30 The name of the admin setting must be exactly the same as the mod_form element.
31 - Currently supported by:
32 - mod_assign
33 - mod_quiz
262061d6 34* Added a native MySQL / MariaDB lock implementation
35* The database drivers (moodle_database and subclasses) don't need to implement get_columns() anymore.
36 They have to implement fetch_columns instead.
934c2ee1 37* Added function cleanup_after_drop to the database_manager class to take care of all the cleanups that need to be done after a table is dropped.
648e20ab 38* The 'xxxx_check_password_policy' callback now only fires if $CFG->passwordpolicy is true
ae46b744 39* grade_item::update_final_grade() can now take an optional parameter to set the grade->timemodified. If not present the current time will carry on being used.
06299fc6 40* lib/outputrequirementslib::get_jsrev now is public, it can be called from other classes.
08fda3e0 41* H5P libraries have been moved from /lib/h5p to h5p/h5plib as an h5plib plugintype.
42* mdn-polyfills has been renamed to polyfills. The reason there is no polyfill from the MDN is
43 because there is no example polyfills on the MDN for this functionality.
44* AJAX pages can be called without requiring a session lock if they set READ_ONLY_SESSION to true, eg.
45 define('READ_ONLY_SESSION', true); Note - this also requires $CFG->enable_read_only_sessions to be set to true.
46* External functions can be called without requiring a session lock if they define 'readonlysession' => true in
47 db/services.php. Note - this also requires $CFG->enable_read_only_sessions to be set to true.
47f3fa13 48* database_manager::check_database_schema() now checks for missing and extra indexes.
5bf5a7aa 49* Implement a more direct xsendfile_file() method for an alternative_file_system_class
50* A new `dynamic` table interface has been defined, which allows any `flexible_table` to be converted into a table which
51 is updatable via ajax calls. See MDL-68495 and `\core_table\dynamic` for further information.
2ead888f 52
7aeeb444 53=== 3.8 ===
0bcc273f 54* Add CLI option to notify all cron tasks to stop: admin/cli/cron.php --stop
4a6edc57 55* The rotate_image function has been added to the stored_file class (MDL-63349)
7aeeb444 56* The yui checknet module is removed. Call \core\session\manager::keepalive instead.
c7321899 57* The generate_uuid() function has been deprecated. Please use \core\uuid::generate() instead.
b71e734b 58* Remove lib/pear/auth/RADIUS.php (MDL-65746)
29c442c5 59* Core components are now defined in /lib/components.json instead of coded into /lib/classes/component.php
e63a35dc 60* Subplugins should now be defined using /db/subplugins.json instead of /db/subplugins.php
61* The following functions have been finally deprecated and can not be used anymore:
62 * allow_override()
63 * allow_assign()
64 * allow_switch()
65 * https_required()
66 * verify_https_required()
91930754 67* Remove duplicate font-awesome SCSS, Please see /theme/boost/scss/fontawesome for usage (MDL-65936)
062dc67e 68* Remove lib/pear/Crypt/CHAP.php (MDL-65747)
69* New output component available: \core\output\checkbox_toggleall
70 - This allows developers to easily output groups of checkboxes that can be toggled by master controls in the form of a checkbox or
71 a button. Action elements which perform actions on the selected checkboxes can also be enabled/disabled depending on whether
72 at least a single checkbox item is selected or not.
c5681f7f 73* Final deprecation (removal) of the core/modal_confirm dialogue.
d7b43fd9 74* Upgrade scssphp to v1.0.2, This involves renaming classes from Leafo => ScssPhp as the repo has changed.
75* Implement supports_xsendfile() method and allow support for xsendfile in alternative_file_system_class
76 independently of local files (MDL-66304).
77* The methods get_local_path_from_storedfile and get_remote_path_from_storedfile in lib/filestore/file_system.php
78 are now public. If you are overriding these then you will need to change your methods to public in your class.
79* It is now possible to use sub-directories for AMD modules.
80 The standard rules for Level 2 namespaces also apply to AMD modules.
81 The sub-directory used must be either an valid component, or placed inside a 'local' directory to ensure that it does not conflict with other components.
83 The following are all valid module names and locations in your plugin:
84 mod_forum/view: mod/forum/amd/src/view.js
85 mod_forum/local/views/post: mod/forum/amd/src/local/views/post
86 mod_forum/form/checkbox-toggle: mod/forum/amd/src/form/checkbox-toggle.js
88 The following are all invalid module names and locations in your plugin:
89 mod_forum/views/post: mod/forum/amd/src/views/post
90* The 'xxxx_check_password_policy' method now has an extra parameter: $user. It contains the user object to perform password
91validation against and defaults to null (so, no user needed) if not provided.
92* It is now possible to use sub-directories when creating mustache templates.
93 The standard rules for Level 2 namespaces also apply to templates.
94 The sub-directory used must be either an valid component, or placed inside a 'local' directory to ensure that it does not conflict with other components.
96 The following are all valid template names and locations in your plugin:
97 mod_forum/forum_post: mod/forum/templates/forum_post.mustache
98 mod_forum/local/post/user: mod/forum/templates/local/post/user.mustache
99 mod_forum/form/checkbox_toggle: mod/forum/templates/form/checkbox_toggle.mustache
c5f3e924 100
101 The following are _invalid_ template names and locations:
102 mod_forum/post/user: mod/forum/templates/local/post/user.mustache
103* Following behat steps have been removed from core:
104 - I go to "<gradepath_string>" in the course gradebook
e2d97a46 105* A new admin setting widget 'core_admin\local\settings\filesize' is added.
1d6f041a 106* Core capabilities 'moodle/community:add' and 'moodle/community:download' have been removed from core as part of sunsetting.
107* As part of sunsetting process the following hub api functions have been deprecated:
108 - get_courses
109 - unregister_courses
110 - register_course
111 - add_screenshot
112 - download_course_backup
113 - upload_course_backup
114* A new setting 'Cache templates' was added (see MDL-66367). This setting determines if templates are cached or not.
115 This setting can be set via the UI or by defining $CFG->cachetemplates in your config.php file. It is a boolean
116 and should be set to either false or true. Developers will probably want to set this to false.
2d4ce64d 117* The core_enrol_edit_user_enrolment webservice has been deprecated. Please use core_enrol_submit_user_enrolment_form instead.
ca81e906 118* \single_button constructor has a new attributes param to add attributes to the button HTML tag.
60dc0242 119* Improved url matching behaviour for profiled urls and excluded urls
d6f5fbb7 120* Attempting to use xsendfile via the 3rd param of readstring_accel() is now ignored.
121* New H5P libraries have been added to Moodle core in /lib/h5p.
122* New H5P core subsystem have been added.
123* Introduced new callback for plugin developers '<component>_get_path_from_pluginfile($filearea, $args)': This will return
124the itemid and filepath for the filearea and path defined in $args. It has been added in order to get the correct itemid and
125filepath because some components, such as mod_page or mod_resource, add the revision to the URL where the itemid should be placed
126(to prevent caching problems), but then they don't store it in database.
225eb7b2 127* New utility function \core_form\util::form_download_complete should be called if your code sends
128 a file with Content-Disposition: Attachment in response to a Moodle form submit button (to ensure
129 that disabled submit buttons get re-enabled in that case). It is automatically called by the
130 filelib.php send_xx functions.
131* If you have a form which sends a file in response to a Moodle form submit button, but you cannot
132 call the above function because the file is sent by a third party library, then you should add
133 the attribute data-double-submit-protection="off" to your form.
7aeeb444 134
b91ddd16 135=== 3.7 ===
21406f66 136
9df03b19 137* Nodes in the navigation api can have labels for each group. See set/get_collectionlabel().
b91ddd16 138* The method core_user::is_real_user() now returns false for userid = 0 parameter
139* 'mform1' dependencies (in themes, js...) will stop working because a randomly generated string has been added to the id
140attribute on forms to avoid collisions in forms loaded in AJAX requests.
141* A new method to allow queueing or rescheduling of an existing scheduled task was added. This allows an existing task
142 to be updated or queued as required. This new functionality can be found in \core\task\manager::reschedule_or_queue_adhoc_task.
ef96eb02 143* Icons are displayed for screen readers unless they have empty alt text (aria-hidden). Do not provide an icon with alt text immediately beside an element with exactly the same text.
d940855f 144* admin_settingpage has a new function hide_if(), modeled after the same functionality in the forms library. This allows admin settings to be dynamically hidden based on the values of other settings.
145* The \core_rating provider's get_sql_join function now accepts an optional $innerjoin parameter.
146 It is recommended that privacy providers using this function call rewrite any long query into a number of separate
147 calls to add_from_sql for improved performance, and that the new argument is used.
148 This will allow queries to remain backwards-compatible with older versions of Moodle but will have significantly better performance in version supporting the innerjoin parameter.
149* /message/defaultoutputs.php file and admin_page_defaultmessageoutputs class have been deprecated
150 and all their settings moved to admin/message.php (see MDL-64495). Please use admin_page_managemessageoutputs class instead.
151* A new parameter $lang has been added to mustache_template_source_loader->load_with_dependencies() method
152 so it is possible for Mustache to request string in a specific language.
05a5d547 153* Behat timeout constants behat_base::TIMEOUT, EXTENDED_TIMEOUT, and REDUCED_TIMEOUT have been
154 deprecated. Please instead use the functions behat_base::get_timeout(), get_extended_timeout(),
155 and get_reduced_timeout(). These allow for timeouts to be increased by a setting in config.php.
156* The $draftitemid parameter of file_save_draft_area_files() function now supports the constant IGNORE_FILE_MERGE:
157 When the parameter is set to that constant, the function won't process file merging, keeping the original state of the file area.
418a86c6 158 Notice also than when $text is set, pluginfile rewrite won't be processed so the text will not be modified.
159* Introduced new callback for plugin developers '<component>_pre_processor_message_send($procname, $proceventdata)':
160 This will allow any plugin to manipulate messages or notifications before they are sent by a processor (email, mobile...)
f7b52799 161* New capability 'moodle/category:viewcourselist' in category context that controls whether user is able to browse list of courses
162 in this category. To work with list of courses use API methods in core_course_category and also 'course' form element.
163* It is possible to pass additional conditions to get_courses_search();
164 core_course_category::search_courses() now allows to search only among courses with completion enabled.
bf9f2555 165* Add support for a new xxx_after_require_login callback
166* A new conversation type has been created for self-conversations. During the upgrading process:
167 - Firstly, the existing self-conversations will be starred and migrated to the new type, removing the duplicated members in the
168 message_conversation_members table.
169 - Secondly, the legacy self conversations will be migrated from the legacy 'message_read' table. They will be created using the
170 new conversation type and will be favourited.
171 - Finally, the self-conversations for all remaining users without them will be created and starred.
172Besides, from now, a self-conversation will be created and starred by default to all the new users (even when $CFG->messaging
173is disabled).
174* New optional parameter $throwexception for \get_complete_user_data(). If true, an exception will be thrown when there's no
175 matching record found or when there are multiple records found for the given field value. If false, it will simply return false.
176 Defaults to false when not set.
cb28132d 177* Exposed submit button to allow custom styling (via customclassoverride variable) which can override btn-primary/btn-secondary classes
178* `$includetoken` parameter type has been changed. Now supports:
179 boolean: False indicates to not include the token, true indicates to generate a token for the current user ($USER).
180 integer: Indicates to generate a token for the user whose id is the integer value.
181* The following functions have been updated to support the new usage:
182 - make_pluginfile_url
183 - file_rewrite_pluginfile_urls
e240a000 184* New mform element 'float' handles localised floating point numbers.
b91ddd16 185
437ffc9f 186=== 3.6 ===
188* A new token-based version of pluginfile.php has been added which can be used for out-of-session file serving by
189 setting the `$includetoken` parameter to true on the `moodle_url::make_pluginfile_url()`, and
190 `moodle_url::make_file_url()` functions.
191* The following picture functions have been updated to support use of the new token-based file serving:
192 - print_group_picture
193 - get_group_picture_url
194* The `user_picture` class has a new public `$includetoken` property which can be set to make use of the new token-based
195 file serving.
9411beb3 196* Custom AJAX handlers for the form autocomplete fields can now optionally return string in their processResults()
2dd33840 197 callback. If a string is returned, it is displayed instead of the list of suggested items. This can be used, for
9411beb3 198 example, to inform the user that there are too many items matching the current search criteria.
f8d15c66 199* The form element 'htmleditor' has been deprecated. Please use the 'editor' element instead.
350d7b06 200* The print_textarea() function has been deprecated. Please use $OUTPUT->print_textarea() instead.
437ffc9f 201* The following functions have been finally deprecated and can not be used any more:
202 - external_function_info()
203 - core_renderer::update_module_button()
204 - events_trigger()
205 - events_cron()
206 - events_dispatch()
207 - events_is_registered()
208 - events_load_def()
209 - events_pending_count()
210 - events_process_queued_handler()
211 - events_queue_handler()
212 - events_trigger_legacy()
213 - events_update_definition()
214 - get_file_url()
215 - course_get_cm_rename_action()
216 - course_scale_used()
217 - site_scale_used()
218 - clam_message_admins()
219 - get_clam_error_code()
220 - get_records_csv()
221 - put_records_csv()
222 - print_log()
223 - print_mnet_log()
224 - print_log_csv()
225 - print_log_xls()
226 - print_log_ods()
227 - build_logs_array()
228 - get_logs_usercourse()
229 - get_logs_userday()
230 - get_logs()
231 - prevent_form_autofill_password()
f2cdf993 232 - prefixed_tablenode_transformations()
233 - core_media_renderer
234 - core_media
8d2432f5 235* Following api's have been removed in behat_config_manager, please use behat_config_util instead.
236 - get_features_with_tags()
237 - get_components_steps_definitions()
238 - get_config_file_contents()
239 - merge_behat_config()
240 - get_behat_profile()
241 - profile_guided_allocate()
242 - merge_config()
243 - clean_path()
244 - get_behat_tests_path()
245* Following behat steps have been removed from core:
246 - I set the field "<field_string>" to multiline
247 - I follow "<link_string>"" in the open menu
248* The following behat steps have been deprecated, please do not use these step definitions any more:
249 - behat_navigation.php: i_navigate_to_node_in()
250 - theme/boost/tests/behat/behat_theme_boost_behat_navigation.php: i_navigate_to_node_in()
251 Use one of the following steps instead:
252 - I navigate to "PATH > ITEM" in current page administration
253 - I navigate to "PATH > ITEM" in site administration
254 - I navigate to course participants
255 - I navigate to "TAB1 > TAB2" in the course gradebook
256 If some items are not available without Navigation block at all, one can use combination of:
257 - I add the "Navigation" block if not present
258 - I click on "LINK" "link" in the "Navigation" "block"
259* The core\session\util class has been removed. This contained one function only used by the memcached class which has
260 been moved there instead (connection_string_to_memcache_servers).
512a1d31 261* Removed the lib/password_compat/lib/password.php file.
262* The eventslib.php file has been deleted and its functions have been moved to deprecatedlib.php. The affected functions are:
263 - events_get_cached()
264 - events_uninstall()
265 - events_cleanup()
266 - events_dequeue()
267 - events_get_handlers()
268* coursecat::get() now has optional $user parameter.
269* coursecat::is_uservisible() now has optional $user parameter.
2dd33840 270* Removed the lib/form/submitlink.php element which was deprecated in 3.2.
271* The user_selector classes do not support custom list of extra identity fields any more. They obey the configured user
272 policy and respect the privacy setting made by site administrators. The list of user identifiers should never be
273 hard-coded. Instead, the setting $CFG->showuseridentity should be always respected, which has always been the default
274 behaviour (MDL-59847).
275* The function message_send() in messagelib.php will now only take the object \core\message\message as a parameter.
276* The method message_sent::create_from_ids() parameter courseid is now required. A debugging
277 message was previously displayed, and the SITEID was used, when not provided.
278* The method \core\message\manager::send_message() now only takes the object \core\message\message as the first parameter.
df536ab1 279* Following functions have been deprecated, please use get_roles_used_in_context.
280 - get_roles_on_exact_context()
281 - get_roles_with_assignment_on_context()
7d7d3b17 282* New functions to support the merging of user draft areas from the interface; see MDL-45170 for details:
283 - file_copy_file_to_file_area()
284 - file_merge_draft_areas()
285 - file_replace_file_area_in_text()
286 - extract_draft_file_urls_from_text()
287* Class coursecat is now alias to autoloaded class core_course_category, course_in_list is an alias to
288 core_course_list_element, class coursecat_sortable_records is deprecated without replacement.
289* \core_user_external::create_users() and \core_user_external::update_users() can now accept more user profile fields so user
290 creation/update via web service can now be very similar to the edit profile page's functionality. The new fields that have been
291 added are:
292 - maildisplay
293 - interests
294 - url
295 - icq
296 - skype
297 - aim
298 - yahoo
299 - msn
300 - institution
301 - department
302 - phone1
303 - phone2
304 - address
305* New function mark_user_dirty() must be called after changing data that gets cached in user sessions. Examples:
306 - Assigning roles to users.
307 - Unassigning roles from users.
308 - Enrolling users into courses.
309 - Unenrolling users from courses.
310* New optional parameter $context for the groups_get_members_join() function and ability to filter users that are not members of
311any group. Besides, groups_get_members_ids_sql, get_enrolled_sql and get_enrolled_users now accepts -1 (USERSWITHOUTGROUP) for
312the groupid field.
313* Added $CFG->conversionattemptlimit setting to config.php allowing a maximum number of retries before giving up conversion
314 of a given document by the assignfeedback_editpdf\task\convert_submissions task. Default value: 3.
315* The following events have been deprecated and should not be used any more:
316 - message_contact_blocked
317 - message_contact_unblocked
318 The reason for this is because you can now block/unblock users without them necessarily being a contact. These events
319 have been replaced with message_user_blocked and message_user_unblocked respectively.
320* The event message_deleted has been changed, it no longer records the value of the 'useridto' due to
321 the introduction of group messaging. Please, if you have any observers or are triggering this event
322 in your code you will have to make some changes!
323* The gradebook now supports the ability to accept files as feedback. This can be achieved by adding
324 'feedbackfiles' to the $grades parameter passed to grade_update().
325 For example -
326 $grades['feedbackfiles'] = [
327 'contextid' => 1,
328 'component' => 'mod_xyz',
329 'filearea' => 'mod_xyz_feedback',
330 'itemid' => 2
331 ];
332 These files will be then copied to the gradebook file area.
333* Allow users to choose who can message them for privacy reasons, with a 'growing circle of contactability':
334 - Added $CFG->messagingallusers, for enabling messaging to all site users. Default value: 0.
335 When $CFG->messagingallusers = false users can choose being contacted by only contacts or contacts and users sharing a course with them.
336 In that case, the default user preference is MESSAGE_PRIVACY_COURSEMEMBER (users sharing a course).
337 When $CFG->messagingallusers = true users have a new option for the privacy messaging preferences: "Anyone on the site". In that case,
338 the default user preference is MESSAGE_PRIVACY_SITE (all site users).
339 - Added $CFG->keepmessagingallusersenabled setting to config.php to force enabling $CFG->messagingallusers during the upgrading process.
340 Default value: 0.
341 When $CFG->keepmessagingallusersenabled is set to true, $CFG->messagingallusers will be also set to true to enable messaging site users.
342 However, when it is empty, $CFG->messagingallusers will be disabled during the upgrading process, so the users will only be able to
343 message contacts and users sharing a course with them.
344* There has been interface and functional changes to admin_apply_default_settings() (/lib/adminlib.php). The function now takes two
345 additional optional parameters, $admindefaultsettings and $settingsoutput. It also has a return value $settingsoutput.
346 The function now does not need to be called twice to ensure all default settings are set. Instead the function calls itself recursively
347 until all settings have been set. The additional parameters are used recursively and shouldn't be need to be explicitly passed in when calling
348 the function from other parts of Moodle.
349 The return value: $settingsoutput is an array of setting names and the values that were set by the function.
160e77f9 350* Webservices no longer update the lastaccess time for a user in a course. Call core_course_view_course() manually if needed.
0616f045 351* A new field has been added to the context table. Please ensure that any contxt preloading uses get_preload_record_columns_sql or get_preload_record_columns to fetch the list of columns.
f7115c2e 352
353=== 3.5 ===
355* There is a new privacy API that every subsystem and plugin has to implement so that the site can become GDPR
356 compliant. Plugins use this API to report what information they store or process regarding users, and provide ability
357 to export and delete personal data. See for guidelines on how to implement the
358 privacy API in your plugin.
cd305dc2 359* The cron runner now sets up a fresh PAGE and OUTPUT between each task.
360* The core_renderer methods notify_problem(), notify_success(), notify_message() and notify_redirect() that were
361 deprecated in Moodle 3.1 have been removed. Use \core\notification::add(), or \core\output\notification as required.
362* The maximum supported precision (the total number of digits) for XMLDB_TYPE_NUMBER ("number") fields raised from 20 to
363 38 digits. Additionally, the whole number part (precision minus scale) must not be longer than the maximum length of
364 integer fields (20 digits). Note that PHP floats commonly support precision of roughly 15 digits only (MDL-32113).
365* Event triggering and event handlers:
366 - The following events, deprecated since moodle 2.6, have been finally removed: groups_members_removed,
367 groups_groupings_groups_removed, groups_groups_deleted, groups_groupings_deleted.
368* The following functions have been finally deprecated and can not be used any more:
369 - notify()
370* XMLDB now validates the PATH attribute on every install.xml file. Both the XMLDB editor and installation will fail
371 when a problem is detected with it. Please ensure your plugins contain correct directory relative paths.
caae0820 372* Add recaptchalib_v2.php for support of reCAPTCHA v2.
373* Plugins can define class 'PLUGINNAME\privacy\local\sitepolicy\handler' if they implement an alternative mechanisms for
374 site policies managements and agreements. Administrators can define which component is to be used for handling site
375 policies and agreements. See
376* Scripts can define a constant NO_SITEPOLICY_CHECK and set it to true before requiring the main config.php file. It
377 will make the require_login() skipping the test for the user's policyagreed status. This is useful for plugins that
378 act as a site policy handler.
379* There is a new is_fulltext_search_supported() DML function. The default implementation returns false. This function
380 is used by 'Simple search' global search engine to determine if the database full-text search capabilities can be used.
381* The following have been removed from the list of core subsystems:
382 - core_register
383 - core_publish
384 Following this change, \core_register_renderer and \core_publish_renderer have been removed and their methods have been
385 moved to \core_admin_renderer and \core_course_renderer respectively.
521252d6 386
8cf36e9c 387=== 3.4 ===
521252d6 388
d3882ea4 389* oauth2_client::request method has an extra parameter to specify the accept header for the response (MDL-60733)
390* The following functions, previously used (exclusively) by upgrade steps are not available
391 anymore because of the upgrade cleanup performed for this version. See MDL-57432 for more info:
392 - upgrade_mimetypes()
393 - upgrade_fix_missing_root_folders_draft()
394 - upgrade_minmaxgrade()
395 - upgrade_course_tags()
397* Added new moodleform element 'filetypes' and new admin setting widget 'admin_setting_filetypes'. These new widgets
398 allow users to define a list of file types; either by typing them manually or selecting them from a list. The widgets
399 directly support the syntax used to feed the 'accepted_types' option of the filemanager and filepicker elements. File
400 types can be specified as extensions (.jpg or just jpg), mime types (text/plain) or groups (image).
401* Removed accesslib private functions: load_course_context(), load_role_access_by_context(), dedupe_user_access() (MDL-49398).
402* Internal "accessdata" structure format has changed to improve ability to perform role definition caching (MDL-49398).
403* Role definitions are no longer cached in user session (MDL-49398).
404* External function core_group_external::get_activity_allowed_groups now returns an additional field: canaccessallgroups.
405 It indicates whether the user will be able to access all the activity groups.
bef201c7 406* file_get_draft_area_info does not sum the root folder anymore when calculating the foldercount.
407* The moodleform element classes can now optionally provide a public function validateSubmitValue(). This method can be
408 used to perform implicit validation of submitted values - without the need to explicitly add the validation rules to
409 every form. The method should accept a single parameter with the submitted value. It should return a string with the
410 eventual validation error, or an empty value if the validation passes.
3b1eba06 411* New user_picture attribute $includefullname to determine whether to include the user's full name with the user's picture.
412* Enrol plugins which provide enrolment actions can now declare the following "data-action" attributes in their implementation of
413 enrol_plugin::get_user_enrolment_actions() whenever applicable:
414 * "editenrolment" - For editing a user'e enrolment details. Defined by constant ENROL_ACTION_EDIT.
415 * "unenrol" - For unenrolling a student. Defined by constant ENROL_ACTION_UNENROL.
416 These attributes enable enrol actions to be rendered via modals. If not added, clicking on the enrolment action buttons will still
417 redirect the user to the appropriate enrolment action page. Though optional, it is recommended to add these attributes for a
418 better user experience when performing enrol actions.
419* The enrol_plugin::get_user_enrolment_actions() implementations for core enrol plugins have been removed and moved to
420 the parent method itself. New enrol plugins don't have to implement get_user_enrolment_actions(), but just need to
421 make sure that they override:
422 - enrol_plugin::allow_manage(), and/or
423 - enrol_plugin::allow_unenrol_user() or enrol_plugin::allow_unenrol()
424 Existing enrol plugins that override enrol_plugin::get_user_enrolment_actions() don't have to do anything, but can
425 also opt to remove their own implementation of the method if they basically have the same logic as the parent method.
426* New optional parameter $enrolid for the following functions:
427 - get_enrolled_join()
428 - get_enrolled_sql()
429 - get_enrolled_with_capabilities_join()
430 Setting this parameter to a non-zero value will add a condition to the query such that only users that were enrolled
431 with this enrolment method will be returned.
432* New optional parameter 'closeSuggestionsOnSelect' for the enhance() function for form-autocomplete. Setting this to true will
433 close the suggestions popup immediately after an option has been selected. If not specified, it defaults to true for single-select
434 elements and false for multiple-select elements.
4d068a67 435* user_can_view_profile() now also checks the moodle/user:viewalldetails capability.
436* The core/modal_confirm dialogue has been deprecated. Please use the core/modal_save_cancel dialogue instead. Please ensure you
437 update to use the and ModalEvents.cancel events instead of their yes/no counterparts.
438* Instead of checking the 'moodle/course:viewparticipants' and 'moodle/site:viewparticipants' capabilities use the
439 new functions course_can_view_participants() and course_require_view_participants().
b1eb6dd7 440* $stored_file->add_to_curl_request() now adds the filename to the curl request.
441* The option for Login HTTPS (authentication-only SSL) has been removed
442* $CFG->loginhttps is now deprecated, do not use it.
4b501ec9 443* $PAGE->https_required and $PAGE->verify_https_required() are now deprecated. They are no longer used and will throw a coding_exception.
672f4836 444* $CFG->httpswwwroot is now deprecated and will always result in the same value as wwwroot.
445* Added function core_role_set_view_allowed() to check if a user should be able to see a given role.
446 This should be checked whenever displaying a list of roles to a user, however, core_role_set_assign_allowed may need to override it
447 in some cases.
64cd4596 448* Deprecated allow_override, allow_assign and allow_switch and replaced with core_role_set_*_allowed to avoid function names conflicting.
8cf36e9c 449
450=== 3.3.1 ===
452* ldap_get_entries_moodle() now always returns lower-cased attribute names in the returned entries.
453 It was suppposed to do so before, but it actually didn't.
3be09119 455=== 3.3 ===
1cb5c7b3 456
457* Behat compatibility changes are now being documented at
459* PHPUnit's bootstrap has been changed to use HTTPS wwwroot ( from previous HTTP version. Any
460 existing test expecting the old HTTP URLs will need to be switched to the new HTTPS value (reference: MDL-54901).
461* The information returned by the idp list has changed. This is usually only rendered by the login page and login block.
462 The icon attribute is removed and an iconurl attribute has been added.
151b0f94 463* Support added for a new type of external file: FILE_CONTROLLED_LINK. This is an external file that Moodle can control
141ee541 464 the permissions. Moodle makes files read-only but can grant temporary write access.
465 When accessing a URL, the info from file_browser::get_file_info will be checked to determine if the user has write access,
466 if they do - the remote file will have access controls set to allow editing.
467* The method moodleform::after_definition() has been added and can now be used to add some logic
468 to be performed after the form's definition was set. This is useful for intermediate subclasses.
469* Moodle has support for font-awesome icons. Plugins should use the xxx_get_fontawesome_icon_map callback
470 to map their custom icons to one from font-awesome.
471* $OUTPUT->pix_url() has been deprecated because it is was used mostly to manually generate image tags for icons.
472 We now distinguish between icons and "small images". The difference is that an icon does not have to be rendered as an image tag
473 with a source. It is OK to still have "small images" - if this desired use $OUTPUT->image_icon() and $OUTPUT->image_url(). For
474 other uses - use $OUTPUT->pix_icon() or the pix helper in mustache templates {{#pix}}...{{/pix}}
c266d256 475 For other valid use cases use $OUTPUT->image_url().
3e6adcd6 476* Activity icons have been split from standard icons. Use $OUTPUT->image_icon instead of $OUTPUT->pix_icon for these
c2dde7ee 477 type of icons (the coloured main icon for each activity).
478* YUI module moodle-core-formautosubmit has been removed, use jquery .change() instead (see lib/templates/url_select.mustache for
479 an example)
480* $mform->init_javascript_enhancement() is deprecated and no longer does anything. Existing uses of smartselect enhancement
481 should be switched to the searchableselector form element or other solutions.
7620746f 482* Return value of the validate_email() is now proper boolean as documented. Previously the function could return 1, 0 or false.
483* The mcore YUI rollup which included various YUI modules such as moodle-core-notification is no longer included on every
484 page. Missing YUI depdencies may be exposed by this change (e.g. missing a requirement on moodle-core-notification when
485 using M.core.dialogue).
486* Various legacy javascript functions have been removed:
487 * M.util.focus_login_form and M.util.focus_login_error no longer do anything. Please use jquery instead. See
488 lib/templates/login.mustache for an example.
489 * Some outdated global JS functions have been removed and should be replaced with calls to jquery
490 or alternative approaches:
491 checkall, checknone, select_all_in_element_with_id, select_all_in, deselect_all_in, confirm_if, findParentNode,
492 filterByParent, stripHTML
493 * M.util.init_toggle_class_on_click has been removed.
494* The following functions have been deprecated and should not be used any more:
495 - file_storage::try_content_recovery - See MDL-46375 for more information
496 - file_storage::content_exists - See MDL-46375 for more information
497 - file_storage::deleted_file_cleanup - See MDL-46375 for more information
498 - file_storage::get_converted_document
499 - file_storage::is_format_supported_by_unoconv
500 - file_storage::can_convert_documents
501 - file_storage::send_test_pdf
502 - file_storage::test_unoconv_path
503* Following behat steps have been removed from core:
504 - I click on "<element_string>" "<selector_string>" in the "<row_text_string>" table row
505 - I go to notifications page
506 - I add "<filename_string>" file from recent files to "<filepicker_field_string>" filepicker
507 - I upload "<filepath_string>" file to "<filepicker_field_string>" filepicker
508 - I create "<foldername_string>" folder in "<filepicker_field_string>" filepicker
509 - I open "<foldername_string>" folder from "<filepicker_field_string>" filepicker
510 - I unzip "<filename_string>" file from "<filepicker_field_string>" filepicker
511 - I zip "<filename_string>" folder from "<filepicker_field_string>" filepicker
512 - I delete "<file_or_folder_name_string>" from "<filepicker_field_string>" filepicker
513 - I send "<message_contents_string>" message to "<username_string>"
514 - I add "<user_username_string>" user to "<cohort_idnumber_string>" cohort
515 - I add "<username_string>" user to "<group_name_string>" group
516 - I fill in "<field_string>" with "<value_string>"
517 - I select "<option_string>" from "<select_string>"
518 - I select "<radio_button_string>" radio button
519 - I check "<option_string>"
520 - I uncheck "<option_string>"
521 - the "<field_string>" field should match "<value_string>" value
522 - the "<checkbox_string>" checkbox should be checked
523 - the "<checkbox_string>" checkbox should not be checked
524 - I fill the moodle form with:
525 - "<element_string>" "<selector_string>" should exists
526 - "<element_string>" "<selector_string>" should not exists
527 - the following "<element_string>" exists:
528* get_user_capability_course() now has an additional parameter 'limit'. This can be used to return a set number of records with
529 the submitted capability. The parameter 'fieldsexceptid' will now accept context fields which can be used for preloading.
ed0a1cd7 530* The caching option 'immutable' has been added to send_stored_file() and send_file().
37d0c7c7 531* New adhoc task refresh_mod_calendar_events_task that updates existing calendar events of modules.
ca75ec4f 532* New 'priority' column for the event table to determine which event to show in case of events with user and group overrides.
fb41d2f0 533* Webservices core_course_search_courses and core_course_get_courses_by_field will always return the sortorder field.
e9dfeec9 534* core_course_external::get_activities_overview has been deprecated. Please do not call this function any more.
e03d5d47 535* Changed the pix mustache template helper to accept context variables for the key, component and alt text.
536* New auth_plugin_base helper methods:
537 - get_identity_providers() - Retrieves available auth identity providers.
538 - prepare_identity_providers_for_output() - Prepares auth identity provider data for output (e.g. to templates, WS, etc.).
2fa2ed50 539
540=== 3.2 ===
542* Custom roles with access to any part of site administration that do not use the manager archetype will need
543 moodle/site:configview capability added.
ba5c5083 544* Admin setting "Show My courses expanded on Dashboard" has been removed.
545* Some backwards and forwards compatibility has been added for different bootstrap versions.
546 This is to allow the same markup to work in "clean" and "boost" themes alot of the time. It is also to allow user text
547 with bootstrap classes to keep working in the new theme. See MDL-56004 for the list of supported classes.
ff392efc 548* MForms element 'submitlink' has been deprecated.
549* Searchable selector form element is now a wrapper for autocomplete. A "No selection" option is automatically
550 added to the options list for best backwards compatibility - if you were manually adding a "no selection" option you will need
551 to remove it.
2ce91090 552* Node.js versions >=4 are now required to run grunt.
553* JQuery has been updated to 3.1.0. JQuery migrate plugins are no longer shipped - please read
554 and update your javascript.
af6a4240 555* New option 'blanktarget' added to format_text. This option adds target="_blank" to links
556* A new webservice structure `external_files` has been created which provides a standardised view of files in Moodle and
557 should be used for all file return descriptions.
558 Files matching this format can be retrieved via the new `external_util::get_area_files` method.
559 See MDL-54951 for further information.
560* The parameter $usepost of the following functions has been deprecated and is not used any more:
561 - get_max_upload_file_size()
562 - get_user_max_upload_file_size()
563* The following classes have been removed and should not be used any more:
564 - boxclient - See MDL-49599 for more information.
565* The following functions have been removed and should not be used any more:
566 - file_modify_html_header() - See MDL-29738 for more information.
aa7e371a 567* core_grades_external::get_grades has been deprecated. Please do not call this function any more.
64064315 568 External function gradereport_user_external::get_grade_items can be used for retrieving the course grades information.
6fb1a717 569* New option 'escape' added to format_string. When true (default), escapes HTML entities from the string
570* The following functions have been deprecated and are not used any more:
571 - get_records_csv() Please use csv_import_reader::load_csv_content() instead.
572 - put_records_csv() Please use download_as_dataformat (lib/dataformatlib.php) instead.
573 - zip_files() - See MDL-24343 for more information.
574 - unzip_file() - See MDL-24343 for more information.
575 - print_log() - See MDL-43681 for more information
576 - print_log_csv() - See MDL-43681 for more information
577 - print_log_ods() - See MDL-43681 for more information
578 - print_log_xls() - See MDL-43681 for more information
579 - print_mnet_log() - See MDL-43681 for more information
580 - build_logs_array() - See MDL-43681 for more information
581 - get_logs() - See MDL-43681 for more information
582 - get_logs_usercourse() - See MDL-43681 for more information
583 - get_logs_userday() - See MDL-43681 for more information
ac157b0b 584 - prevent_form_autofill_password() Please do not use anymore.
21e8b48d 585* The password_compat library was removed as it is no longer required.
586* Phpunit has been upgraded to 5.4.x and following has been deprecated and is not used any more:
587 - setExpectedException(), use @expectedException or $this->expectException() and $this->expectExceptionMessage()
588 - getMock(), use createMock() or getMockBuilder()->getMock()
589 - UnitTestCase class is removed.
590* The following methods have been finally deprecated and should no longer be used:
591 - course_modinfo::build_section_cache()
592 - cm_info::get_deprecated_group_members_only()
593 - cm_info::is_user_access_restricted_by_group()
594* The following methods in cm_info::standardmethods have also been finally deprecated and should no longer be used:
595 - cm_info::get_after_edit_icons()
596 - cm_info::get_after_link()
597 - cm_info::get_content()
598 - cm_info::get_custom_data()
599 - cm_info::get_extra_classes()
600 - cm_info::get_on_click()
601 - cm_info::get_url()
602 - cm_info::obtain_dynamic_data()
603 Calling them through the magic method __call() will throw a coding exception.
604* The alfresco library has been removed from core. It was an old version of
605 the library which was not compatible with newer versions of Alfresco.
7a05bc92 606* Added down arrow: $OUTPUT->darrow.
607* All file_packer implementations now accept an additional parameter to allow a simple boolean return value instead of
608 an array of individual file statuses.
e259795c 609* "I set the field "field_string" to multiline:" now end with colon (:), as PyStrings is supposed to end with ":"
610* New functions to support deprecation of events have been added to the base event. See MDL-46214 for further details.
611* A new function `get_name_with_info` has been added to the base event. This function adds information about event
612 deprecations and should be used where this information is relevant.
613* Following api's have been deprecated in behat_config_manager, please use behat_config_util instead.
614 - get_features_with_tags
615 - get_components_steps_definitions
616 - get_config_file_contents
617 - merge_behat_config
618 - get_behat_profile
619 - profile_guided_allocate
620 - merge_config
621 - clean_path
622 - get_behat_tests_path
623* behat_util::start_test_mode() accepts 3 options now:
624 - 1. Theme sute with all features: If behat should initialise theme suite with all core features.
625 - 2. Parallel runs: How many parallel runs will be running.
626 - 3. Run: Which process behat should be initialise for.
627* behat_context_helper::set_session() has been deprecated, please use behat_context_helper::set_environment() instead.
9b9afffe 628* data-fieldtype="type" attribute has been added to form field default template.
629* form elements extending MoodleQuickForm_group must call $this->createFormElement() instead of
630 @MoodleQuickForm::createElement() in order to be compatible with PHP 7.1
631* Relative paths in $CFG->alternateloginurl will be resolved to absolute path within moodle site. Previously they
632 were resolved to absolute path within the server. That means:
633 - $CFG->wwwroot:
634 - $CFG->alternateloginurl : /my/super/login.php
635 - Login url will be: (moodle root based)
636* Database (DML) layer:
637 - new sql_equal() method available for places where case sensitive/insensitive varchar comparisons are required.
638* PostgreSQL connections now use advanced options to reduce connection overhead. These options are not compatible
639 with some connection poolers. The dbhandlesoptions parameter has been added to allow the database to configure the
640 required defaults. The parameters that are required in the database are;
641 ALTER DATABASE moodle SET client_encoding = UTF8;
642 ALTER DATABASE moodle SET standard_conforming_strings = on;
ce7863ba 643 ALTER DATABASE moodle SET search_path = 'moodle,public'; -- Optional, if you wish to use a custom schema.
f834a8f5 644 You can set these options against the database or the moodle user who connects.
645* Some form elements have been refined to better support right-to-left languages. In RTL,
646 most fields should not have their direction flipped, a URL, a path to a file, a number, ...
647 are always displayed LTR. Input fields and text areas now will best guess whether they
648 should be forced to be displayed in LTR based on the PARAM type associated with it. You
649 can call $mform->setForceLtr($elementName, true/false) on some form fields to manually
650 set the value.
370e7637 651* Action menus do_not_enhance() is deprecated, use a list of action_icon instead.
652* The user_not_fully_set_up() function has a new $strict parameter (defaulting to true) in order to decide when
653 custom fields (and other checks) should be evaluated to determine if the user has been completely setup.
654* profile_field_base class has new methods: get_field_config_for_external() and get_field_properties().
655 This two new methods should be implemented by profile field plugins to make them compatible with Web Services.
656* The minifier library used by core_minify has been switched to - there are minor differences
657 in minifier output.
8b99e163 658* context_header additional buttons can now have a class attribute provided in the link attributes.
659* The return signature for the antivirus::scan_file() function has changed.
660 The calling function will now handle removal of infected files from Moodle based on the new integer return value.
661* The first parameter $eventdata of both message_send() and \core\message\manager::send_message() should
662 be \core\message\message. Use of stdClass is deprecated.
663* The message_sent event now expects other[courseid] to be always set, exception otherwise. For BC with contrib code,
664 message_sent::create_from_ids() will show a debugging notice if the \core\message\message being sent is missing
665 the courseid property, defaulting to SITEID automatically. In Moodle 3.6 (MDL-55449) courseid will be fully mandatory
666 for all messages sent.
d6a25bc4 667* The send_confirmation_email() function has a new optional parameter $confirmationurl to provide a different confirmation URL.
668* Introduced a new hook for plugin developers:
669 - <component>_course_module_background_deletion_recommended()
670 This hook should be used in conjunction with the existing '<component>_pre_course_module_delete($mod)'. It must
671 return a boolean and is called by core to check whether a plugin's implementation of
672 <component>_pre_course_module_deleted($mod) will take a long time. A plugin should therefore only implement this
673 function if it also implements <component>_pre_course_module_delete($mod).
674 An example in current use is recyclebin, which performs what can be a lengthy backup process in
675 tool_recyclebin_pre_course_module_delete. The recyclebin, if enabled, now returns true in its implementation of
676 tool_recyclebin_course_module_background_deletion_recommended(), to indicate to core that the deletion (and
677 execution of tool_recyclebin_pre_course_module_delete) should be handled with an adhoc task, meaning it will not
678 occur in real time.
af6a4240 679
680=== 3.1 ===
682* Webservice function core_course_search_courses accepts a new parameter 'limittoenrolled' to filter the results
683 only to courses the user is enrolled in, and are visible to them.
684* External functions that are not calling external_api::validate_context are buggy and will now generate
685 exceptions. Previously they were only generating warnings in the webserver error log.
e02e7f5a 686 See
221bfffd 687* The moodle/blog:associatecourse and moodle/blog:associatemodule capabilities has been removed.
688* The following functions has been finally deprecated and can not be used any more:
689 - profile_display_badges()
690 - useredit_shared_definition_preferences()
691 - calendar_normalize_tz()
692 - get_user_timezone_offset()
693 - get_timezone_offset()
694 - get_list_of_timezones()
695 - calculate_user_dst_table()
696 - dst_changes_for_year()
697 - get_timezone_record()
698 - test_get_list_of_timezones()
699 - test_get_timezone_offset()
700 - test_get_user_timezone_offset()
701* The google api library has been updated to version 1.1.7. There was some important changes
702 on the SSL handling. Now the SSL version will be determined by the underlying library.
703 For more information see
704* The get_role_users() function will now add the $sort fields that are not part
705 of the requested fields to the query result and will throw a debugging message
706 with the added fields when that happens.
707* The core_user::fill_properties_cache() static method has been introduced to be a reference
708 and allow standard user fields data validation. Right now only type validation is supported
709 checking it against the parameter (PARAM_*) type of the target user field. MDL-52781 is
710 going to add support to null/not null and choices validation, replacing the existing code to
711 validate the user fields in different places in a common way.
712* Webservice function core_course_search_courses now returns results when the search string
713 is less than 2 chars long.
714* Webservice function core_course_search_courses accepts a new parameter 'requiredcapabilities' to filter the results
715 by the capabilities of the current user.
716* New mform element 'course' handles thousands of courses with good performance and usability.
717* The redirect() function will now redirect immediately if output has not
718 already started. Messages will be displayed on the subsequent page using
719 session notifications. The type of message output can be configured using the
720 fourth parameter to redirect().
721* The specification of extra classes in the $OUTPUT->notification()
722 function, and \core\output\notification renderable have been deprecated
723 and will be removed in a future version.
724 Notifications should use the levels found in \core\output\notification.
726 \core\output\notification have been deprecated in favour of NOTIFY_ERROR,
727 NOTIFY_WARNING, and NOTIFY_INFO respectively.
728* The following functions, previously used (exclusively) by upgrade steps are not available
729 anymore because of the upgrade cleanup performed for this version. See MDL-51580 for more info:
730 - upgrade_mysql_fix_unsigned_and_lob_columns()
731 - upgrade_course_completion_remove_duplicates()
732 - upgrade_save_orphaned_questions()
733 - upgrade_rename_old_backup_files_using_shortname()
734 - upgrade_mssql_nvarcharmax()
735 - upgrade_mssql_varbinarymax()
736 - upgrade_fix_missing_root_folders()
737 - upgrade_course_modules_sequences()
738 - upgrade_grade_item_fix_sortorder()
739 - upgrade_availability_item()
740* A new parameter $ajaxformdata was added to the constructor for moodleform. When building a
741 moodleform in a webservice or ajax script (for example using the new fragments API) we
742 cannot allow the moodleform to parse it's own data from _GET and _POST - we must pass it as
743 an array.
744* Plugins can extend the navigation for user by declaring the following callback:
745 <frankenstyle>_extend_navigation_user(navigation_node $parentnode, stdClass $user,
746 context_user $context, stdClass $course,
747 context_course $coursecontext)
c917b53a 748* The function notify() now throws a debugging message - see MDL-50269.
749* Ajax calls going through lib/ajax/* now validate the return values before sending
750 the response. If the validation does not pass an exception is raised. This behaviour
751 is consistent with web services.
752* Several changes in Moodle core, standard plugins and third party libraries to
753 ensure compatibility with PHP7. All plugins are recommended to perform testing
754 against PHP7 as well. Refer to for more
755 information. The following changes may affect you:
756 * Class moodleform, moodleform_mod and some module classes have been changed to use
757 __construct() for the constructor. Calling parent constructors by the class
758 name will display debugging message. Incorrect: parent::moodleform(),
759 correct: parent::__construct()
760 * All form elements have also changed the constructor syntax. No changes are
761 needed for using form elements, however if plugin defines new form element it
762 needs to use correct syntax. For example, incorrect: parent::HTML_QuickForm_input(),
763 HTML_QuickForm_input::HTML_QuickForm_input(), $this->HTML_QuickForm_input().
764 Correct: HTML_QuickForm_input::__construct() or parent::__construct().
765 * profile_field_base::profile_field_base() is deprecated, use parent::__construct()
766 in custom profile fields constructors. Similar deprecations in exsiting
767 profile_field_* classes.
768 * user_filter_type::user_filter_type() is deprecated, use parent::__construct() in
769 custom user filters. Similar deprecations in existing user_filter_* classes.
770 * table_default_export_format_parent::table_default_export_format_parent() is
771 deprecated, use parent::__construct() in extending classes.
772* groups_delete_group_members() $showfeedback parameter has been removed and is no longer
773 respected. Users of this function should output their own feedback if required.
774* Number of changes to Tags API, see tag/upgrade.txt for more details
775* The previous events API handlers are being deprecated in favour of events 2 API, debugging messages are being displayed if
776 there are 3rd party plugins using it. Switch to events 2 API please, see
777 Note than you will need to bump the plugin version so moodle is aware that you removed the plugin's event handlers.
778* mforms validation functions are not available in the global JS namespace anymore, event listeners
779 are assigned to fields and buttons through a self-contained JS function.
780* Added $CFG->urlrewriteclass option to config.php allowing clean / semantic urls to
781 be implemented in a plugin, eg local_cleanurls.
782* $CFG->pathtoclam global setting has been moved to clamav antivirus plugin setting of the same name.
783* clam_message_admins() and get_clam_error_code() have been deprecated, its functionality
784 is now a part of \antivirus_clamav\scanner class methods.
785* \repository::antivir_scan_file() has been deprecated, \core\antivirus\manager::scan_file() that
375223c6 786 applies antivirus plugins is replacing its functionality.
d84a657d 787* Added core_text::str_max_bytes() which safely truncates multi-byte strings to a maximum number of bytes.
b5e6ec44 788* Zend Framework has been removed completely.
322f3141 789* Any plugin can report when a scale is being used with the callback function [pluginname]_scale_used_anywhere(int $scaleid).
529ea77b 790* Changes in file_rewrite_pluginfile_urls: Passing a new option reverse = true in the $options var will make the function to convert
296ab1e2 791 actual URLs in $text to encoded URLs in the @@PLUGINFILE@@ form.
e891c838 792* behat_util::is_server_running() is removed, please use behat_util::check_server_status() instead.
793* Behat\Mink\Selector\SelectorsHandler::xpathLiteral() method is deprecated use behat_context_helper::escape instead
794 when building Xpath, or pass the unescaped value when using the named selector.',
9df4ae41 795* table_sql download process is using the new data formats plugin which you can't use if you are buffering any output
796 * flexible_table::get_download_menu(), considered private, has been deleted. Use
797 $OUTPUT->download_dataformat_selector() instead.
798 when building Xpath, or pass the unescaped value when using the named selector.
799* Add new file_is_executable(), to consistently check for executables even in Windows (PHP bug #41062).
b858b161 800* Introduced new hooks for plugin developers.
801 - <component>_pre_course_category_delete($category)
802 - <component>_pre_course_delete($course)
803 - <component>_pre_course_module_delete($cm)
804 - <component>_pre_block_delete($instance)
805 - <component>_pre_user_delete($user)
b858b161 806 These hooks allow developers to use the item in question before it is deleted by core. For example, if your plugin is
807 a module (plugins located in the mod folder) called 'xxx' and you wish to interact with the user object before it is
808 deleted then the function to create would be mod_xxx_pre_user_delete($user) in mod/xxx/lib.php.
0ddc7e55 809* pear::Net::GeoIP has been removed.
20dde5e6 810
811=== 3.0 ===
4eeea2cb 813* Minify updated to 2.2.1
7fa6b587 814* htmlpurifier upgraded to 4.7.0
df098760 815* Less.php upgraded to
f77cd371 816* The horde library has been updated to version 5.2.7.
80af92f0 817* Google libraries (lib/google) updated to 1.1.5
ec2d33df 818* Html2Text library has been updated to the latest version of the library.
819* External functions x_is_allowed_from_ajax() methods have been deprecated. Define 'ajax' => true in db/services.php instead.
820* External functions can be called without a session if they define 'loginrequired' => true in db/services.php.
821* All plugins are required to declare their frankenstyle component name via
822 the $plugin->component property in their version.php file. See
823 for details (MDL-48494).
b80b35d0 824* PHPUnit is upgraded to 4.7. Some tests using deprecated assertions etc may need changes to work correctly.
988592c5 825* Users of the text editor API to manually create a text editor should call set_text before calling use_editor.
4e8afd56 826* Javascript - SimpleYUI and the Y instance used for modules have been merged. Y is now always the same instance of Y.
f4864c1c 827* get_referer() has been deprecated, please use the get_local_referer function instead.
303936aa 828* \core\progress\null is renamed to \core\progress\none for improved PHP7 compatibility as null is a reserved word (see MDL-50453).
829* \webservice_xmlrpc_client now respects proxy server settings. If your XMLRPC server is available on your local network and not via your proxy server, you may need to add it to the list of proxy
830 server exceptions in $CFG->proxybypass. See MDL-39353 for details.
831* Group and groupings idnumbers can now be passed to and/or are returned from the following web services functions:
832 ** core_group_external::create_groups
833 ** core_group_external::get_groups
834 ** core_group_external::get_course_groups
835 ** core_group_external::create_groupings
836 ** core_group_external::update_groupings
837 ** core_group_external::get_groupings
838 ** core_group_external::get_course_groupings
839 ** core_group_external::get_course_user_groups
840* Following functions are removed from core. See MDL-50049 for details.
841 password_compat_not_supported()
842 session_get_instance()
843 session_is_legacy()
844 session_kill_all()
845 session_touch()
846 session_kill()
847 session_kill_user()
848 session_set_user()
849 session_is_loggedinas()
850 session_get_realuser()
851 session_loginas()
852 js_minify()
853 css_minify_css()
854 update_login_count()
855 reset_login_count()
188458a6 856 check_gd_version()
857 update_log_display_entry()
858 get_recent_enrolments()
859 groups_filter_users_by_course_module_visible()
860 groups_course_module_visible()
861 error()
862 formerr()
863 editorhelpbutton()
864 editorshortcutshelpbutton()
865 choose_from_menu()
866 update_event()
867 get_generic_section_name()
868 get_all_sections()
869 add_mod_to_section()
870 get_all_mods()
871 get_course_section()
872 format_weeks_get_section_dates()
873 get_print_section_cm_text()
874 print_section_add_menus()
875 make_editing_buttons()
876 print_section()
877 print_overview()
878 print_recent_activity()
879 delete_course_module()
880 update_category_button()
881 make_categories_list()
882 category_delete_move()
883 category_delete_full()
884 move_category()
885 course_category_hide()
886 course_category_show()
887 get_course_category()
888 create_course_category()
889 get_all_subcategories()
890 get_child_categories()
891 get_categories()
892 print_course_search()
893 print_my_moodle()
894 print_remote_course()
895 print_remote_host()
896 print_whole_category_list()
897 print_category_info()
b164e2ec 898 get_course_category_tree()
899 print_courses()
900 print_course()
901 get_category_courses_array()
902 get_category_courses_array_recursively()
b164e2ec 903 blog_get_context_url()
904 get_courses_wmanagers()
905 convert_tree_to_html()
906 convert_tabrows_to_tree()
907 can_use_rotated_text()
908 get_parent_contexts()
909 get_parent_contextid()
910 get_child_contexts()
188458a6 911 create_contexts()
912 cleanup_contexts()
913 build_context_path()
914 rebuild_contexts()
915 preload_course_contexts()
916 context_moved()
917 fetch_context_capabilities()
918 context_instance_preload()
919 get_contextlevel_name()
920 print_context_name()
921 mark_context_dirty()
922 delete_context()
923 get_context_url()
924 get_course_context()
925 get_user_courses_bycap()
926 get_role_context_caps()
927 get_courseid_from_context()
928 context_instance_preload_sql()
929 get_related_contexts_string()
930 get_plugin_list_with_file()
931 check_browser_operating_system()
932 check_browser_version()
933 get_device_type()
934 get_device_type_list()
935 get_selected_theme_for_device_type()
936 get_device_cfg_var_name()
188458a6 937 set_user_device_type()
938 get_user_device_type()
939 get_browser_version_classes()
940 generate_email_supportuser()
941 badges_get_issued_badge_info()
942 can_use_html_editor()
943 enrol_cohort_get_cohorts()
944 enrol_cohort_can_view_cohort()
945 cohort_get_visible_list()
946 enrol_cohort_enrol_all_users()
947 enrol_cohort_search_cohorts()
eee9e47d 948* The never unused webdav_locks table was dropped.
949* The actionmenu hideMenu() function now expects an EventFacade object to be passed to it,
950 i.e. a call to M.core.actionmenu.instance.hideMenu() should be change to M.core.actionmenu.instance.hideMenu(e)
40a15455 951* In the html_editors (tinyMCE, Atto), the manage files button can be hidden by changing the 'enable_filemanagement' option to false.
82f0f5e3 952* external_api::validate_context now is public, it can be called from other classes.
953* rss_error() now supports returning of correct HTTP status of error and will return '404 Not Found'
954 unless other status is specified.
955* Plugins can extend the navigation for categories settings by declaring the following callback:
956 <frankenstyle>_extend_navigation_category_settings(navigation_node, context_coursecat)
957* The clilib.php provides two new functions cli_write() and cli_writeln() that should be used for outputting texts from the command
958 line interface scripts.
959* External function core_course_external::get_course_contents returned parameter "name" has been changed to PARAM_RAW,
960 this is because the new external_format_string function may return raw data if the global moodlewssettingraw parameter is used.
182d9990 961* Function is_web_crawler() has been deprecated, please use core_useragent::is_web_crawler() instead.
303936aa 962
963=== 2.9.1 ===
965* New methods grade_grade::get_grade_max() and get_grade_min() must be used rather than directly the public properties rawgrademax and rawgrademin.
966* New method grade_item::is_aggregate_item() indicates when a grade_item is an aggreggated type grade.
968=== 2.9 ===
5472f9f4 970* The default home page for users has been changed to the dashboard (formely my home). See MDL-45774.
9bdcf579 971* Support for rendering templates from php or javascript has been added. See MDL-49152.
adeb96d2 972* Support for loading AMD javascript modules has been added. See MDL-49046.
cf02542d 973* Webservice core_course_delete_courses now return warning messages on any failures and does not try to rollback the entire deletion.
a74d4743 974* \core\event\course_viewed 'other' argument renamed from coursesectionid to coursesectionnumber as it contains the section number.
91fed57a 975* New API core_filetypes::add_type (etc.) allows custom filetypes to be added and modified.
976* PHPUnit: PHPMailer Sink is now started for all tests and is setup within the phpunit wrapper for advanced tests.
977 Catching debugging messages when sending mail will no longer work. Use $sink = $this->redirectEmails(); and then check
978 the message in the sink instead.
c9bd4e41 979* The file pluginlib.php was deprecated since 2.6 and has now been removed, do not include or require it.
9802bd61 980* \core_component::fetch_subsystems() now returns a valid path for completion component instead of null.
7d0d3b36 981* Deprecated JS global methods have been removed (show_item, destroy_item, hide_item, addonload, getElementsByTagName, findChildNodes).
982* For 3rd party plugin specific environment.xml files, it's now possible to specify version independent checks by using the
983 <PLUGIN name="component_name"> tag instead of the version dependent <MOODLE version="x.y"> one. If the PLUGIN tag is used any
984 Moodle specific tags will be ignored.
3451a51c 985* html_table: new API for adding captions to tables (new field, $table->caption) and subsequently hiding said captions from sighted users using accesshide (enabled using $table->captionhide).
986* The authorization procedure in the mdeploy.php script has been improved. The script
987 now relies on the main config.php when deploying an available update.
45a1a16b 988* sql_internal_reader and sql_select_reader interfaces have been deprecated in favour of sql_internal_table_reader
9fe26fb8 989 and sql_reader which use iterators to be more memory efficient.
990* $CFG->enabletgzbackups setting has been removed as now backups are stored internally using .tar.gz format by default, you can
991 set $CFG->usezipbackups to store them in zip format. This does not affect the restore process, which continues accepting both.
992* Added support for custom string manager implementations via $CFG->customstringmanager
993 directive in the config.php. See MDL-49361 for details.
70be2642 994* Add new make_request_directory() for creation of per-request files.
995* Added generate_image_thumbnail_from_string. This should be used instead of generate_image_thumbnail when the source is a string.
996 This prevents the need to write files to disk unnecessarily.
997* Added generate_image_thumbnail to stored_file class. This should be used when generating thumbnails for stored files.
998 This prevents the need to write files to disk unnecessarily.
3004a923 999* Removed pear/HTTP/WebDav. See MDL-49534 for details.
d6e7a63d 1000* Use standard PHP date time classes and methods - see new core_date class for timezone normalisation methods.
1001* Moved lib/google/Google/ to lib/google/src/Google. This is to address autoloader issues with Google's provided autoloader
1002 for the library. See MDL-49519 for details.
1003* The outdated lib/google/Google_Client.php and related files have been completely removed. To use
1004 the new client, read lib/google/readme_moodle.txt, please.
b19cc4ef 1005* profile_display_badges() has been deprecated. See MDL-48935 for details.
1006* Added a new method add_report_nodes() to pagelib.php. If you are looking to add links to the user profile page under the heading "Reports"
1007 then please use this function to ensure that the breadcrumb and navigation block are created properly for all user profile pages.
1008* process_new_icon() now does not always return a PNG file. When possible, it will try to keep the format of the original file.
1009 Set the new argument $preferpng to true to force PNG. See MDL-46763 and MDL-50041 for details.
a74d4743 1010
1011=== 2.8 ===
1013* Gradebook grade category option "aggregatesubcats" has been removed completely.
1014 This means that the database column is removed, the admin settings are removed and
1015 the properties from the grade_category object have been removed. If any courses were
1016 found to be using this setting, a warning to check the grades will be shown in the
1017 course grader report after upgrading the site. The same warning will be shown on
1018 courses restored from backup that had this setting enabled (see MDL-47503).
4051685b 1019* lib/excelllib.class.php has been updated. The class MoodleExcelWorkbook will now only produce excel 2007 files.
1020* renderers: We now remove the suffix _renderable when looking for a render method for a renderable.
1021 If you have a renderable class named like "blah_renderable" and have a method on a renderer named "render_blah_renderable"
1022 you will need to change the name of your render method to "render_blah" instead, as renderable at the end is no longer accepted.
d25c41fb 1023* New functions get_course_and_cm_from_cmid($cmorid, $modulename) and
1024 get_course_and_cm_from_instance($instanceorid, $modulename) can be used to
1025 more efficiently load these basic data objects at the start of a script.
1026* New function cm_info::create($cm) can be used when you need a cm_info
1027 object, but have a $cm which might only be a standard database record.
061e6b28 1028* $CFG->enablegroupmembersonly no longer exists.
1029* Scheduled tasks have gained support for syntax to introduce variability when a
1030 task will run across installs. When a when hour or minute are defined as 'R'
1031 they will be installed with a random hour/minute value.
1032* Several classes grade_edit_tree_column_xxx were removed since grades setup page
1033 has been significantly changed. These classes should not be used outside of
1034 gradebook or developers can copy them into their plugins from 2.7 branch.
1035* Google APIs Client Library (lib/google/) has been upgraded to 1.0.5-beta and
1036 API has changed dramatically without backward compatibility. Any code accessing
1037 it must be amended. It does not apply to lib/googleapi.php. See MDL-47297
1038* Added an extra parameter to the function get_formatted_help_string() (default null) which is used to specify
1039 additional string parameters.
b9ba26b2 1040* User settings node and course node in navigation now support callbacks from admin tools.
a7888487 1041* grade_get_grades() optional parameteres $itemtype, $itemmodule, $iteminstance are now required.
4051685b 1042
1044* completion_info->get_incomplete_criteria() is deprecated and will be removed in Moodle 3.0.
d6caf637 1045* grade_category::aggregate_values() is deprecated and will be removed in Moodle 3.0.
061e6b28 1046* groups_filter_users_by_course_module_visible() is deprecated; replace with
1047 core_availability\info::filter_user_list. Will be removed in Moodle 3.0.
1048* groups_course_module_visible() is deprecated; replace with $cm->uservisible.
1049* cm_info property $cm->groupmembersonly is deprecated and always returns 0.
1050 Use core_availability\info::filter_user_list if trying to determine which
1051 other users can see an activity.
1052* cm_info method $cm->is_user_access_restricted_by_group() is deprecated and
1053 always returns false. Use $cm->uservisible to determine whether the user can
1054 access the activity.
1055* Constant FEATURE_GROUPMEMBERSONLY (used in module _supports functions) is
1056 deprecated.
1057* cohort_get_visible_list() is deprecated. There is a better function cohort_get_available_cohorts()
1058 that respects user capabilities to view cohorts.
1059* enrol_cohort_get_cohorts() and enrol_cohort_search_cohorts() are deprecated since
1060 functionality is removed. Please use cohort_get_available_cohorts()
1061* enrol_cohort_enrol_all_users() is deprecated; enrol_manual is now responsible for this action
80f98467 1062* enrol_cohort_can_view_cohort() is deprecated; replace with cohort_can_view_cohort()
83988eb1 1063
2b55cb1b 1064=== 2.6.4 / 2.7.1 ===
83988eb1 1065
1066* setnew_password_and_mail() and update_internal_user_password() will trigger
1067 \core\event\user_password_updated. Previously they used to generate
1068 \core\event\user_updated event.
1069* update_internal_user_password() accepts optional boolean $fasthash for fast
1070 hashing.
1071* user_update_user() and user_create_user() api's accept optional param
1072 $triggerevent to avoid respective events to be triggred from the api's.
1074=== 2.7 ===
9e00d46b 1076* PHPUnit cannot be installed via PEAR any more, please use composer package manager instead.
1077* $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
1079Events and Logging:
1080* Significant changes in Logging API. For upgrading existing events_trigger() and
1081 add_to_log() see
e2cb3ffa 1082 For accessing logs from plugins see
1083* The validation of the following events is now stricter (see MDL-45445):
1084 - \core\event\blog_entry_created
1085 - \core\event\blog_entry_deleted
1086 - \core\event\blog_entry_updated
1087 - \core\event\cohort_member_added
1088 - \core\event\cohort_member_removed
1089 - \core\event\course_category_deleted
1090 - \core\event\course_completed
1091 - \core\event\course_content_deleted
1092 - \core\event\course_created
1093 - \core\event\course_deleted
1094 - \core\event\course_restored
1095 - \core\event\course_section_updated (see MDL-45229)
1096 - \core\event\email_failed
1097 - \core\event\group_member_added
1098 - \core\event\group_member_removed
1099 - \core\event\note_created
1100 - \core\event\note_deleted
1101 - \core\event\note_updated
1102 - \core\event\role_assigned
1103 - \core\event\role_deleted
1104 - \core\event\role_unassigned
1105 - \core\event\user_graded
1106 - \core\event\user_loggedinas
1107 - \core\event\user_profile_viewed
1108 - \core\event\webservice_token_created
1480f6ea 1109
a4582a51 1110DEPRECATIONS:
994e5662 1111* $module uses in mod/xxx/version.php files is now deprecated. Please use $plugin instead. It will be removed in Moodle 2.10.
3345e24f 1112* Update init methods in all event classes - "level" property was renamed to "edulevel", the level property is now deprecated.
c4b0d6dc 1113* Abstract class \core\event\course_module_instances_list_viewed is deprecated now, use \core\event\instances_list_viewed instead.
e1b16f97 1114* Abstract class core\event\content_viewed has been deprecated. Please extend base event or other relevant abstract class.
1115* mod_book\event\instances_list_viewed has been deprecated. Please use mod_book\event\course_module_instance_list_viewed instead.
1116* mod_chat\event\instances_list_viewed has been deprecated. Please use mod_chat\event\course_module_instance_list_viewed instead.
1117* mod_choice\event\instances_list_viewed has been deprecated. Please use mod_choice\event\course_module_instance_list_viewed instead.
1118* mod_feedback\event\instances_list_viewed has been deprecated. Please use mod_feedback\event\course_module_instance_list_viewed instead.
1119* mod_page\event\instances_list_viewed has been deprecated. Please use mod_page\event\course_module_instance_list_viewed instead.
8d1f33e1 1121* Conditional availability API has moved and changed. The condition_info class is
1122 replaced by \core_availability\info_module, and condition_info_section by
1123 \core_availability\info_section. (Code that uses the old classes will generally
1124 still work.)
1125* coursemodule_visible_for_user() has been deprecated but still works - replaced
1126 by a new static function \core_availability\info_module::is_user_visible()
1127* cm_info::is_user_access_restricted_by_conditional_access has been deprecated
1128 but still works (it has never done what its name suggests, and is
1129 unnecessary).
1130* cm_info and section_info property showavailability has been deprecated, but
1131 still works (with the caveat that this information is now per-user).
1132* cm_info and section_info properties availablefrom and availableuntil have been
1133 deprecated and always return zero (underlying data doesn't have these values).
1134* section_info property groupingid has been deprecated and always returns zero,
1135 same deal.
1136* Various cm_info methods have been deprecated in favour of their read-only properties (get_url(), get_content(), get_extra_classes(),
1137 get_on_click(), get_custom_data(), get_after_link, get_after_edit_icons)
af64bc61 1138* The ajaxenabled function has been deprecated and always returns true. All code should be fully functional in Javascript.
52dc1de7 1139* count_login_failures() has been deprecated, use user_count_login_failures() instead. Refer MDL-42891 for details.
c4b0d6dc 1140
8d1f33e1 1141Conditional availability (activities and sections):
1142* New conditional availability API in /availability, including new availability
1143 condition plugins in /availability/condition. The new API is very similar with
1144 regard to checking availability, but any code that modifies availability settings
1145 for an activity or section is likely to need substantial changes.
1148 * The lightbox attribute for moodle-core-notification-dialogue has been
1149 deprecated and replaced by the modal attribute. This was actually
1150 changed in Moodle 2.2, but has only been marked as deprecated now. It
1151 will be removed in Moodle 2.9.
1152 * When destroying any type of dialogue based on moodle-core-notification, the relevant content is also removed from
1153 the DOM. Previously it was left orphaned.
5947ab33 1154
1156 * The findChildNodes global function has been deprecated. Y.all should
1157 be used instead.
1158 * The callback argument to confirm_action and M.util.show_confirm_dialog has been deprecated. If you need to write a
1159 confirmation which includes a callback, please use moodle-core-notification-confirmation and attach callbacks to the
1160 events provided.
a4582a51 1161
9843e5ec 1162* New locking api and admin settings to configure the system locking type.
1163* New "Time spent waiting for the database" performance metric displayed along with the
1164 other MDL_PERF vars; the change affects both the error logs and the vars displayed in
1165 the page footer.
1166* Changes in the tag API. The component and contextid are now saved when assigning tags to an item. Please see
1167 tag/upgrade.txt for more information.
9843e5ec 1168
9e19a0f0 1169=== 2.6 ===
8e8891b7 1170
cc8fecb5 1171* Use new methods from core_component class instead of get_core_subsystems(), get_plugin_types(),
1172 get_plugin_list(), get_plugin_list_with_class(), get_plugin_directory(), normalize_component(),
1173 get_component_directory() and get_plugin_list_with_file(). The names of the new methods are
1174 exactly the same, the only differences are that core_component::get_plugin_types() now always returns
1175 full paths and core_component::get_plugin_list() does not accept empty parameter any more.
d534708f 1176* Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
af578aec 1177* Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
85b38061 1178* New $CFG->localcachedir setting useful for cluster nodes. Admins have to update X-Sendfile aliases if used.
1179* MS SQL Server drivers are now using NVARCHAR(MAX) instead of NTEXT and VARBINARY(MAX) instead of IMAGE,
1180 this change should be fully transparent and it should help significantly with add-on compatibility.
1181* The string manager classes were renamed. Note that they should not be modified or used directly,
1182 always use get_string_manager() to get instance of the string manager.
aae18d2a 1183* The ability to use an 'insecure' rc4encrypt/rc4decrypt key has been removed.
1184* Use $CFG->debugdeveloper instead of debugging('', DEBUG_DEVELOPER).
1185* Use set_debugging(DEBUG_xxx) when changing debugging level for current request.
d55f05ef 1186* Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
1187* Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
1188 behat_command::$allowedtextselectors and behat_command::$allowedselectors
ac2b2713 1189* Subplugins are supported in admin tools and local plugins.
71ab7e51 1190* file_packer/zip_packer API has been modified so that key functions support a new file_progress interface
1191 to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
1192 function that returns an approximate number of entries in the zip faster than the count() function.
d872881f 1193* Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
44ddd2a1 1194* Class course_modinfo no longer extends stdClass. All properties are read-only.
1195* Database fields modinfo and sectioncache in table course are removed. Application cache core/coursemodinfo
1196 is used instead. Course cache is still reset, rebuilt and retrieved using function rebuild_course_cache() and
1197 get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
1198 If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
1199 object.
1200* Internal (noreply and support) user support has been added for sending/receiving message.
1201 Use core_user::get_noreply_user() and core_user::get_support_user() to get noreply and support user's respectively.
1202 Real users can be used as noreply/support users by setting $CFG->noreplyuserid and $CFG->supportuserid
137885b7 1203* New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
e87214bd 1204* Use core_plugin_manager::reset_caches() when changing visibility of plugins.
1205* Implement new method get_enabled_plugins() method in subplugin info classes.
1206* Each plugin should include version information in version.php.
723a6e56 1207* Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
5fed8433 1208* $USER->password field is intentionally unset so that session data does not contain password hashes.
38fc0130 1209* Use core_shutdown_manager::register_function() instead of register_shutdown_function().
c858655d 1210* New file packer for .tar.gz files; obtain by calling get_file_packer('application/x-gzip'). Intended initially
1211 for use in backup/restore only, as there are limitations on supported filenames. Also new packer for
1212 backups which supports both compression formats; get_file_packer('application/vnd.moodle.backup').
1213* New optional parameter to stored_file::get_content_file_handle to open file handle with 'gzopen' instead
1214 of 'fopen' to read gzip-compressed files if required.
6c679d15 1215* update_internal_user_password() and setnew_password_and_mail() now trigger user_updated event.
b2858b91 1216* Add thirdpartylibs.xml file to plugins that bundle any 3rd party libraries.
1217* New class introduced to help auto generate zIndex values for modal dialogues. Class "moodle-has-zindex"
1218 should set on any element which uses a non-default zindex and needs to ensure it doesn't show above a
1219 dialogue.
1220* $CFG->filelifetime is now used consistently for most file serving operations, the default was lowered
1221 to 6 hours from 24 hours because etags and x-sendfile support should make file serving less expensive.
1222* Date format locale charset for windows server will come from calendar type and for gregorian it will use
1223 lang file.
1224* The library to interact with (class boxclient) is only compatible with their APIv1 which
1225 reaches its end of life on the 14th of Dec. You should migrate your scripts to make usage of the
1226 new class boxnet_client(). Note that the method names and return values have changed.
1227* Settings pages are now possible for Calendar type plugins. Calendar type plugins that require a settings page to
1228 work properly will need to set their requires version to a number that is equal to or grater than the 2.6.1 release version.
1229* The admin/tool/generator tool was overhauled to use testing data generators and the previous interface to create
1230 test data was removed (it was not working correctly anyway). If you were using this tool you will probably need to
1231 update your code.
1234Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
1235and will be removed in a future release (target: 2.8), a summary follows:
1238 * get_context_instance() -> context_xxxx::instance()
1239 * get_context_instance_by_id() -> context::instance_by_id($id)
1240 * get_system_context() -> context_system::instance()
1241 * context_moved() -> context::update_moved()
1242 * preload_course_contexts() -> context_helper::preload_course()
1243 * context_instance_preload() -> context_helper::preload_from_record()
1244 * context_instance_preload_sql() -> context_helper::get_preload_record_columns_sql()
1245 * get_contextlevel_name() -> context_helper::get_level_name()
1246 * create_contexts() -> context_helper::create_instances()
1247 * cleanup_contexts() -> context_helper::cleanup_instances()
1248 * build_context_path() -> context_helper::build_all_paths()
1249 * print_context_name() -> $context->get_context_name()
1250 * mark_context_dirty() -> $context->mark_dirty()
1251 * delete_context() -> $context->delete_content() or context_helper::delete_instance()
1252 * get_context_url() -> $context->get_url()
1253 * get_course_context() -> $context->get_course_context()
1254 * get_parent_contexts() -> $context->get_parent_context_ids()
1255 * get_parent_contextid() -> $context->get_parent_context()
1256 * get_child_contexts() -> $context->get_child_contexts()
1257 * rebuild_contexts() -> $context->reset_paths()
1258 * get_user_courses_bycap() -> enrol_get_users_courses()
1259 * get_courseid_from_context() -> $context->get_course_context(false)
1260 * get_role_context_caps() -> (no replacement)
1261 * load_temp_role() -> (no replacement)
1262 * remove_temp_roles() -> (no replacement)
1263 * get_related_contexts_string() -> $context->get_parent_context_ids(true)
1264 * get_recent_enrolments() -> (no replacement)
1267 * get_course_participants() -> get_enrolled_users()
1268 * is_course_participant() -> is_enrolled()
1271 * current_theme() -> $PAGE->theme->name
1272 * skip_main_destination() -> $OUTPUT->skip_link_target()
1273 * print_container() -> $OUTPUT->container()
1274 * print_container_start() -> $OUTPUT->container_start()
1275 * print_container_end() -> $OUTPUT->container_end()
1276 * print_continue() -> $OUTPUT->continue_button()
1277 * print_header() -> $PAGE methods
1278 * print_header_simple() -> $PAGE methods
1279 * print_side_block() -> $OUTPUT->block()
1280 * print_arrow() -> $OUTPUT->arrow()
1281 * print_scale_menu_helpbutton() -> $OUTPUT->help_icon_scale($courseid, $scale)
1282 * print_checkbox() -> html_writer::checkbox()
1285 * print_navigation() -> $OUTPUT->navbar()
1286 * build_navigation() -> $PAGE->navbar methods
1287 * navmenu() -> (no replacement)
1288 * settings_navigation::
1289 get_course_modules() -> (no replacement)
05226d76 1290
1291Files and repositories:
1292 * stored_file::replace_content_with() -> stored_file::replace_file_with()
1293 * stored_file::set_filesize() -> stored_file::replace_file_with()
1294 * stored_file::get_referencelifetime() -> (no replacement)
1295 * repository::sync_external_file() -> see repository::sync_reference()
1296 * repository::get_file_by_reference() -> repository::sync_reference()
1297 * repository::
1298 get_reference_file_lifetime() -> (no replacement)
1299 * repository::sync_individual_file() -> (no replacement)
1300 * repository::reset_caches() -> (no replacement)
2a68ee0e 1301
05226d76 1302Calendar:
1303 * add_event() -> calendar_event::create()
1304 * update_event() -> calendar_event->update()
1305 * delete_event() -> calendar_event->delete()
1306 * hide_event() -> calendar_event->toggle_visibility(false)
1307 * show_event() -> calendar_event->toggle_visibility(true)
1310 * filter_text() -> format_text(), format_string()...
1311 * httpsrequired() -> $PAGE->https_required()
1312 * detect_munged_arguments() -> clean_param([...], PARAM_FILE)
1313 * mygroupid() -> groups_get_all_groups()
1314 * js_minify() -> core_minify::js_files()
1315 * css_minify_css() -> core_minify::css_files()
64501eee 1316 * course_modinfo::build_section_cache() -> (no replacement)
3bcf6b3c 1317 * generate_email_supportuser() -> core_user::get_support_user()
c3d2fbf9 1318
1320 * session_get_instance()->xxx() -> \core\session\manager::xxx()
1321 * session_kill_all() -> \core\session\manager::kill_all_sessions()
1322 * session_touch() -> \core\session\manager::touch_session()
1323 * session_kill() -> \core\session\manager::kill_session()
1324 * session_kill_user() -> \core\session\manager::kill_user_sessions()
1325 * session_gc() -> \core\session\manager::gc()
1326 * session_set_user() -> \core\session\manager::set_user()
1327 * session_is_loggedinas() -> \core\session\manager::is_loggedinas()
1328 * session_get_realuser() -> \core\session\manager::get_realuser()
1329 * session_loginas() -> \core\session\manager::loginas()
1331User-agent related functions:
1332 * check_browser_operating_system() -> core_useragent::check_browser_operating_system()
1333 * check_browser_version() -> core_useragent::check_browser_version()
1334 * get_device_type() -> core_useragent::get_device_type()
1335 * get_device_type_list() -> core_useragent::get_device_type_list()
1336 * get_selected_theme_for_device_type() -> core_useragent::get_device_type_theme()
1337 * get_device_cfg_var_name() -> core_useragent::get_device_type_cfg_var_name()
1338 * set_user_device_type() -> core_useragent::set_user_device_type()
1339 * get_user_device_type() -> core_useragent::get_user_device_type()
1340 * get_browser_version_classes() -> core_useragent::get_browser_version_classes()
9e19a0f0 1341
1343 * moodle-core-notification has been deprecated with a recommendation of
73b4c1da 1344 using its subclasses instead. This is to allow for reduced page
1345 transport costs. Current subclasses include:
1346 * dialogue
1347 * alert
1348 * confirm
1349 * exception
1350 * ajaxexception
1352Event triggering and event handlers:
1353 * All existing events and event handlers should be replaced by new
1354 event classes and matching new event observers.
1355 * See for more information.
1356 * The following events will be entirely removed, though they can still
1357 be captured using handlers, but they should not be used any more.
1358 * groups_members_removed -> \core\event\group_member_removed
1359 * groups_groupings_groups_removed -> (no replacement)
1360 * groups_groups_deleted -> \core\event\group_deleted
1361 * groups_groupings_deleted -> \core\event\grouping_deleted
63deb5c3 1362 * edit_module_post_actions() does not trigger events any more.
f0f0e1fe 1363
a2602457 1364=== 2.5.1 ===
1366* New get_course() function for use when obtaining the course record from database. Will
1367 reuse existing $COURSE or $SITE globals if possible to improve performance.
1369=== 2.5 ===
1371* The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
1372 for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
1373 apply for that change.
1374* The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
1375 so any custom utility relying on the old output may require modification.
1376* Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
1377 "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
1378 an option for 0 bytes. Existing code that was replacing the 0 option in the return
1379 from this function with a more sensible message, can now use the return from this function directly.
9a36be73 1380* Functions responsible for output in course/lib.php are deprecated, the code is moved to
1381 appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
1382 make_editing_buttons()
1383 See functions' phpdocs in lib/deprecatedlib.php
1384* Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
1385* zip_packer may create empty zip archives, there is a new option to ignore
1386 problematic files when creating archive
1387* The function delete_course_module was deprecated and has been replaced with
1388 course_delete_module. The reason for this was because the function delete_course_module
1389 only partially deletes data, so wherever it was called extra code was needed to
1390 perform the whole deletion process. The function course_delete_module now takes care
1391 of the whole process.
1392* curl::setopt() does not accept constant values any more. As it never worked properly,
1393 we decided to make the type check stricter. Now, the keys of the array pass must be a string
1394 corresponding to the curl constant name.
1395* Function get_users_listing now return list of users except guest and deleted users. Previously
1396 deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
1397 and not included in get_user function, it will not be returned by get_users_listing.
1398* The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
1399 MODNAME_dndupload_register callback instead.
1400* The signature of the add() method of classes implementing the parentable_part_of_admin_tree
1401 interface (such as admin_category) has been extended. The new parameter allows the caller
1402 to prepend the new node before an existing sibling in the admin tree.
1403* condition_info:get_condition_user_fields($formatoptions) now accepts the optional
1404 param $formatoptions, that will determine if the field names are processed by
1405 format_string() with the passed options.
689096bc 1406* remove all references to $CFG->gdversion, GD PHP extension is now required
1407* Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
1408 need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
4e0b6025 1409* Functions responsible for managing and accessing course categories are moved to class coursecat
1410 in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
1411 moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
6e1d1ee0 1412 category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
8db5dcb7 1413 course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
1414 get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
1415 print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
1416 print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
1417 get_courses_wmanagers()
1418 See
0e2ca62e 1419* $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
1420* Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
1421 functions to get information for only active (excluding suspended enrolments) users. Included two
1422 helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
e87214bd 1423* The core_plugin_manager class now provides two new helper methods for getting information
d7d48b40 1424 about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
e87214bd 1425* The get_uninstall_url() method of all subclasses of \core\plugininfo\base class is now expected
1426 to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
1427 to control the availability of the 'Uninstall' link at the Plugins overview page (previously
1428 they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
1429 uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
1430 plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
1431 satisfy all plugin types.
9a36be73 1432
4efcfaa3 1433Database (DML) layer:
1434* $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
1435 please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
1436* Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
1437 Please note that internally we create indexes instead of foreign keys.
9a36be73 1438
1439YUI changes:
1440* M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
1441 instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
1442 that your help link is placed in a span which has the class 'helplink'.
1444=== 2.4 ===
1446* Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
1447 and page_generic_activity.
704533fc 1448* use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
b874d5c6 1449* Function settings_navigation::add_course_editing_links() is completely removed
1450* function global_navigation::format_display_course_content() is removed completely (the
1451 functionality is moved to course format class)
1452* in the function global_navigation::load_generic_course_sections() the argument $courseformat is
1453 removed
1454* New component and itemid columns in groups_members table - this allows plugin to create protected
1455 group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
1456 callback 'xx_yy_restore_group_member()'.
1457* New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
1458* functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
1459 are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
ee362526 1460
1461YUI changes:
1462* moodle-enrol-notification has been renamed to moodle-core-notification
3542e01a 1463* YUI2 code must now use 2in3, see
1464* M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
1465 to use moodle-core-formautosubmit
d2a27ab0 1466
1467Unit testing changes:
1468* output debugging() is not sent to standard output any more,
1469 use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
1470 $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
1472=== 2.3 ===
1474Database layer changes:
1475* objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
1478* DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
1479debug messages and will produce fatal errors
e618cdf3 1480
796495fe 1481API changes:
daefd6eb 1482
796495fe 1483* send_stored_file() has changed its interface
daefd6eb 1484* deleted several resourcelib_embed_* functions from resourcelib.php
796495fe 1485
1486=== 2.2 ===
1488removed unused libraries:
1489* odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject,, md5.js
1491API changes:
1492* new admin/tool plugin type
1493* new context API - old API is still available
8e470797 1494* deleted users do not have context any more
1495* removed global search
1498=== 2.1 ===
1500API changes:
1501* basic suport for restore from 1.9
1502* new mobile devices API
1503* new questions API
1506=== 2.0 ===
1508API changes:
1509* new DML API -
1510* new DDL API -
1511* new file API -
1512* new $PAGE and $OUTPUT API
1513* new navigation API
1514* new theme API -
1515* new javascript API -
1516* new portfolio API
1517* new local plugin type
1518* new translation support -
1519* new web service API
1520* new cohorts API
1521* new messaging API
1522* new rating API
1523* new comment API
1524* new sessions API
1525* new enrolment API
1526* new backup/restore API
1527* new blocks API
1528* new filters API
1529* improved plugin support (aka Frankenstyle)
1530* new registration and hub API
1531* new course completion API
1532* new plagiarism API
1533* changed blog API
1534* new text editor API
19526d91 1535* new my moodle and profiles API