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