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