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