Merge branch 'wip-MDL-62742-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.6 ===
6 * A new token-based version of pluginfile.php has been added which can be used for out-of-session file serving by
7   setting the `$includetoken` parameter to true on the `moodle_url::make_pluginfile_url()`, and
8   `moodle_url::make_file_url()` functions.
9 * The following picture functions have been updated to support use of the new token-based file serving:
10     - print_group_picture
11     - get_group_picture_url
12 * The `user_picture` class has a new public `$includetoken` property which can be set to make use of the new token-based
13   file serving.
14 * Custom AJAX handlers for the form autocomplete fields can now optionally return string in their processResults()
15   callback. If a string is returned, it is displayed instead of the list of suggested items. This can be used, for
16   example, to inform the user that there are too many items matching the current search criteria.
17 * The form element 'htmleditor' has been deprecated. Please use the 'editor' element instead.
18 * The print_textarea() function has been deprecated. Please use $OUTPUT->print_textarea() instead.
19 * The following functions have been finally deprecated and can not be used any more:
20     - external_function_info()
21     - core_renderer::update_module_button()
22     - events_trigger()
23     - events_cron()
24     - events_dispatch()
25     - events_is_registered()
26     - events_load_def()
27     - events_pending_count()
28     - events_process_queued_handler()
29     - events_queue_handler()
30     - events_trigger_legacy()
31     - events_update_definition()
32     - get_file_url()
33     - course_get_cm_rename_action()
34     - course_scale_used()
35     - site_scale_used()
36     - clam_message_admins()
37     - get_clam_error_code()
38     - get_records_csv()
39     - put_records_csv()
40     - print_log()
41     - print_mnet_log()
42     - print_log_csv()
43     - print_log_xls()
44     - print_log_ods()
45     - build_logs_array()
46     - get_logs_usercourse()
47     - get_logs_userday()
48     - get_logs()
49     - prevent_form_autofill_password()
50     - prefixed_tablenode_transformations()
51     - core_media_renderer
52     - core_media
53 * Following api's have been removed in behat_config_manager, please use behat_config_util instead.
54     - get_features_with_tags()
55     - get_components_steps_definitions()
56     - get_config_file_contents()
57     - merge_behat_config()
58     - get_behat_profile()
59     - profile_guided_allocate()
60     - merge_config()
61     - clean_path()
62     - get_behat_tests_path()
63 * Following behat steps have been removed from core:
64     - I set the field "<field_string>" to multiline
65     - I follow "<link_string>"" in the open menu
66 * The following behat steps have been deprecated, please do not use these step definitions any more:
67     - behat_navigation.php: i_navigate_to_node_in()
68     - theme/boost/tests/behat/behat_theme_boost_behat_navigation.php: i_navigate_to_node_in()
69   Use one of the following steps instead:
70     - I navigate to "PATH > ITEM" in current page administration
71     - I navigate to "PATH > ITEM" in site administration
72     - I navigate to course participants
73     - I navigate to "TAB1 > TAB2" in the course gradebook
75   If some items are not available without Navigation block at all, one can use combination of:
76     - I add the "Navigation" block if not present
77     - I click on "LINK" "link" in the "Navigation" "block"
78 * Removed the lib/password_compat/lib/password.php file.
79 * The eventslib.php file has been deleted and its functions have been moved to deprecatedlib.php. The affected functions are:
80   - events_get_cached()
81   - events_uninstall()
82   - events_cleanup()
83   - events_dequeue()
84   - events_get_handlers()
85 * coursecat::get() now has optional $user parameter.
86 * coursecat::is_uservisible() now has optional $user parameter.
87 * Removed the lib/form/submitlink.php element which was deprecated in 3.2.
88 * The user_selector classes do not support custom list of extra identity fields any more. They obey the configured user
89   policy and respect the privacy setting made by site administrators. The list of user identifiers should never be
90   hard-coded. Instead, the setting $CFG->showuseridentity should be always respected, which has always been the default
91   behaviour (MDL-59847).
92 * The function message_send() in messagelib.php will now only take the object \core\message\message as a parameter.
93 * The method message_sent::create_from_ids() parameter courseid is now required. A debugging
94   message was previously displayed, and the SITEID was used, when not provided.
95 * The method \core\message\manager::send_message() now only takes the object \core\message\message as the first parameter.
96 * Following functions have been deprecated, please use get_roles_used_in_context.
97     - get_roles_on_exact_context()
98     - get_roles_with_assignment_on_context()
99 * New functions to support the merging of user draft areas from the interface; see MDL-45170 for details:
100   - file_copy_file_to_file_area()
101   - file_merge_draft_areas()
102   - file_replace_file_area_in_text()
103   - extract_draft_file_urls_from_text()
104 * Class coursecat is now alias to autoloaded class core_course_category, course_in_list is an alias to
105   core_course_list_element, class coursecat_sortable_records is deprecated without replacement.
107 === 3.5 ===
109 * There is a new privacy API that every subsystem and plugin has to implement so that the site can become GDPR
110   compliant. Plugins use this API to report what information they store or process regarding users, and provide ability
111   to export and delete personal data. See for guidelines on how to implement the
112   privacy API in your plugin.
113 * The cron runner now sets up a fresh PAGE and OUTPUT between each task.
114 * The core_renderer methods notify_problem(), notify_success(), notify_message() and notify_redirect() that were
115   deprecated in Moodle 3.1 have been removed. Use \core\notification::add(), or \core\output\notification as required.
116 * The maximum supported precision (the total number of digits) for XMLDB_TYPE_NUMBER ("number") fields raised from 20 to
117   38 digits. Additionally, the whole number part (precision minus scale) must not be longer than the maximum length of
118   integer fields (20 digits). Note that PHP floats commonly support precision of roughly 15 digits only (MDL-32113).
119 * Event triggering and event handlers:
120     - The following events, deprecated since moodle 2.6, have been finally removed: groups_members_removed,
121       groups_groupings_groups_removed, groups_groups_deleted, groups_groupings_deleted.
122 * The following functions have been finally deprecated and can not be used any more:
123   - notify()
124 * XMLDB now validates the PATH attribute on every install.xml file. Both the XMLDB editor and installation will fail
125   when a problem is detected with it. Please ensure your plugins contain correct directory relative paths.
126 * Add recaptchalib_v2.php for support of reCAPTCHA v2.
127 * Plugins can define class 'PLUGINNAME\privacy\local\sitepolicy\handler' if they implement an alternative mechanisms for
128   site policies managements and agreements. Administrators can define which component is to be used for handling site
129   policies and agreements. See
130 * Scripts can define a constant NO_SITEPOLICY_CHECK and set it to true before requiring the main config.php file. It
131   will make the require_login() skipping the test for the user's policyagreed status. This is useful for plugins that
132   act as a site policy handler.
133 * There is a new is_fulltext_search_supported() DML function. The default implementation returns false. This function
134   is used by 'Simple search' global search engine to determine if the database full-text search capabilities can be used.
135 * The following have been removed from the list of core subsystems:
136    - core_register
137    - core_publish
138   Following this change, \core_register_renderer and \core_publish_renderer have been removed and their methods have been
139   moved to \core_admin_renderer and \core_course_renderer respectively.
141 === 3.4 ===
143 * oauth2_client::request method has an extra parameter to specify the accept header for the response (MDL-60733)
144 * The following functions, previously used (exclusively) by upgrade steps are not available
145   anymore because of the upgrade cleanup performed for this version. See MDL-57432 for more info:
146     - upgrade_mimetypes()
147     - upgrade_fix_missing_root_folders_draft()
148     - upgrade_minmaxgrade()
149     - upgrade_course_tags()
151 * Added new moodleform element 'filetypes' and new admin setting widget 'admin_setting_filetypes'. These new widgets
152   allow users to define a list of file types; either by typing them manually or selecting them from a list. The widgets
153   directly support the syntax used to feed the 'accepted_types' option of the filemanager and filepicker elements. File
154   types can be specified as extensions (.jpg or just jpg), mime types (text/plain) or groups (image).
155 * Removed accesslib private functions: load_course_context(), load_role_access_by_context(), dedupe_user_access() (MDL-49398).
156 * Internal "accessdata" structure format has changed to improve ability to perform role definition caching (MDL-49398).
157 * Role definitions are no longer cached in user session (MDL-49398).
158 * External function core_group_external::get_activity_allowed_groups now returns an additional field: canaccessallgroups.
159   It indicates whether the user will be able to access all the activity groups.
160 * file_get_draft_area_info does not sum the root folder anymore when calculating the foldercount.
161 * The moodleform element classes can now optionally provide a public function validateSubmitValue(). This method can be
162   used to perform implicit validation of submitted values - without the need to explicitly add the validation rules to
163   every form. The method should accept a single parameter with the submitted value. It should return a string with the
164   eventual validation error, or an empty value if the validation passes.
165 * New user_picture attribute $includefullname to determine whether to include the user's full name with the user's picture.
166 * Enrol plugins which provide enrolment actions can now declare the following "data-action" attributes in their implementation of
167   enrol_plugin::get_user_enrolment_actions() whenever applicable:
168   * "editenrolment" - For editing a user'e enrolment details. Defined by constant ENROL_ACTION_EDIT.
169   * "unenrol" - For unenrolling a student. Defined by constant ENROL_ACTION_UNENROL.
170   These attributes enable enrol actions to be rendered via modals. If not added, clicking on the enrolment action buttons will still
171   redirect the user to the appropriate enrolment action page. Though optional, it is recommended to add these attributes for a
172   better user experience when performing enrol actions.
173 * The enrol_plugin::get_user_enrolment_actions() implementations for core enrol plugins have been removed and moved to
174   the parent method itself. New enrol plugins don't have to implement get_user_enrolment_actions(), but just need to
175   make sure that they override:
176   - enrol_plugin::allow_manage(), and/or
177   - enrol_plugin::allow_unenrol_user() or enrol_plugin::allow_unenrol()
178   Existing enrol plugins that override enrol_plugin::get_user_enrolment_actions() don't have to do anything, but can
179   also opt to remove their own implementation of the method if they basically have the same logic as the parent method.
180 * New optional parameter $enrolid for the following functions:
181   - get_enrolled_join()
182   - get_enrolled_sql()
183   - get_enrolled_with_capabilities_join()
184   Setting this parameter to a non-zero value will add a condition to the query such that only users that were enrolled
185   with this enrolment method will be returned.
186 * New optional parameter 'closeSuggestionsOnSelect' for the enhance() function for form-autocomplete. Setting this to true will
187   close the suggestions popup immediately after an option has been selected. If not specified, it defaults to true for single-select
188   elements and false for multiple-select elements.
189 * user_can_view_profile() now also checks the moodle/user:viewalldetails capability.
190 * The core/modal_confirm dialogue has been deprecated. Please use the core/modal_save_cancel dialogue instead. Please ensure you
191   update to use the and ModalEvents.cancel events instead of their yes/no counterparts.
192 * Instead of checking the 'moodle/course:viewparticipants' and 'moodle/site:viewparticipants' capabilities use the
193   new functions course_can_view_participants() and course_require_view_participants().
194 * $stored_file->add_to_curl_request() now adds the filename to the curl request.
195 * The option for Login HTTPS (authentication-only SSL) has been removed
196 * $CFG->loginhttps is now deprecated, do not use it.
197 * $PAGE->https_required and $PAGE->verify_https_required() are now deprecated. They are no longer used and will throw a coding_exception.
198 * $CFG->httpswwwroot is now deprecated and will always result in the same value as wwwroot.
199 * Added function core_role_set_view_allowed() to check if a user should be able to see a given role.
200   This should be checked whenever displaying a list of roles to a user, however, core_role_set_assign_allowed may need to override it
201   in some cases.
202 * Deprecated allow_override, allow_assign and allow_switch and replaced with core_role_set_*_allowed to avoid function names conflicting.
204 === 3.3.1 ===
206 * ldap_get_entries_moodle() now always returns lower-cased attribute names in the returned entries.
207   It was suppposed to do so before, but it actually didn't.
209 === 3.3 ===
211 * Behat compatibility changes are now being documented at
213 * PHPUnit's bootstrap has been changed to use HTTPS wwwroot ( from previous HTTP version. Any
214   existing test expecting the old HTTP URLs will need to be switched to the new HTTPS value (reference: MDL-54901).
215 * The information returned by the idp list has changed. This is usually only rendered by the login page and login block.
216   The icon attribute is removed and an iconurl attribute has been added.
217 * Support added for a new type of external file: FILE_CONTROLLED_LINK. This is an external file that Moodle can control
218   the permissions. Moodle makes files read-only but can grant temporary write access.
219     When accessing a URL, the info from file_browser::get_file_info will be checked to determine if the user has write access,
220     if they do - the remote file will have access controls set to allow editing.
221 * The method moodleform::after_definition() has been added and can now be used to add some logic
222   to be performed after the form's definition was set. This is useful for intermediate subclasses.
223 * Moodle has support for font-awesome icons. Plugins should use the xxx_get_fontawesome_icon_map callback
224   to map their custom icons to one from font-awesome.
225 * $OUTPUT->pix_url() has been deprecated because it is was used mostly to manually generate image tags for icons.
226   We now distinguish between icons and "small images". The difference is that an icon does not have to be rendered as an image tag
227   with a source. It is OK to still have "small images" - if this desired use $OUTPUT->image_icon() and $OUTPUT->image_url(). For
228   other uses - use $OUTPUT->pix_icon() or the pix helper in mustache templates {{#pix}}...{{/pix}}
229   For other valid use cases use $OUTPUT->image_url().
230 * Activity icons have been split from standard icons. Use $OUTPUT->image_icon instead of $OUTPUT->pix_icon for these
231   type of icons (the coloured main icon for each activity).
232 * YUI module moodle-core-formautosubmit has been removed, use jquery .change() instead (see lib/templates/url_select.mustache for
233   an example)
234 * $mform->init_javascript_enhancement() is deprecated and no longer does anything. Existing uses of smartselect enhancement
235   should be switched to the searchableselector form element or other solutions.
236 * Return value of the validate_email() is now proper boolean as documented. Previously the function could return 1, 0 or false.
237 * The mcore YUI rollup which included various YUI modules such as moodle-core-notification is no longer included on every
238   page. Missing YUI depdencies may be exposed by this change (e.g. missing a requirement on moodle-core-notification when
239   using M.core.dialogue).
240 * Various legacy javascript functions have been removed:
241     * M.util.focus_login_form and M.util.focus_login_error no longer do anything. Please use jquery instead. See
242       lib/templates/login.mustache for an example.
243     * Some outdated global JS functions have been removed and should be replaced with calls to jquery
244       or alternative approaches:
245         checkall, checknone, select_all_in_element_with_id, select_all_in, deselect_all_in, confirm_if, findParentNode,
246         filterByParent, stripHTML
247     * M.util.init_toggle_class_on_click has been removed.
248 * The following functions have been deprecated and should not be used any more:
249   - file_storage::try_content_recovery  - See MDL-46375 for more information
250   - file_storage::content_exists        - See MDL-46375 for more information
251   - file_storage::deleted_file_cleanup  - See MDL-46375 for more information
252   - file_storage::get_converted_document
253   - file_storage::is_format_supported_by_unoconv
254   - file_storage::can_convert_documents
255   - file_storage::send_test_pdf
256   - file_storage::test_unoconv_path
257 * Following behat steps have been removed from core:
258     - I click on "<element_string>" "<selector_string>" in the "<row_text_string>" table row
259     - I go to notifications page
260     - I add "<filename_string>" file from recent files to "<filepicker_field_string>" filepicker
261     - I upload "<filepath_string>" file to "<filepicker_field_string>" filepicker
262     - I create "<foldername_string>" folder in "<filepicker_field_string>" filepicker
263     - I open "<foldername_string>" folder from "<filepicker_field_string>" filepicker
264     - I unzip "<filename_string>" file from "<filepicker_field_string>" filepicker
265     - I zip "<filename_string>" folder from "<filepicker_field_string>" filepicker
266     - I delete "<file_or_folder_name_string>" from "<filepicker_field_string>" filepicker
267     - I send "<message_contents_string>" message to "<username_string>"
268     - I add "<user_username_string>" user to "<cohort_idnumber_string>" cohort
269     - I add "<username_string>" user to "<group_name_string>" group
270     - I fill in "<field_string>" with "<value_string>"
271     - I select "<option_string>" from "<select_string>"
272     - I select "<radio_button_string>" radio button
273     - I check "<option_string>"
274     - I uncheck "<option_string>"
275     - the "<field_string>" field should match "<value_string>" value
276     - the "<checkbox_string>" checkbox should be checked
277     - the "<checkbox_string>" checkbox should not be checked
278     - I fill the moodle form with:
279     - "<element_string>" "<selector_string>" should exists
280     - "<element_string>" "<selector_string>" should not exists
281     - the following "<element_string>" exists:
282 * get_user_capability_course() now has an additional parameter 'limit'. This can be used to return a set number of records with
283   the submitted capability. The parameter 'fieldsexceptid' will now accept context fields which can be used for preloading.
284 * The caching option 'immutable' has been added to send_stored_file() and send_file().
285 * New adhoc task refresh_mod_calendar_events_task that updates existing calendar events of modules.
286 * New 'priority' column for the event table to determine which event to show in case of events with user and group overrides.
287 * Webservices core_course_search_courses and core_course_get_courses_by_field will always return the sortorder field.
288 * core_course_external::get_activities_overview has been deprecated. Please do not call this function any more.
289 * Changed the pix mustache template helper to accept context variables for the key, component and alt text.
290 * New auth_plugin_base helper methods:
291   - get_identity_providers() - Retrieves available auth identity providers.
292   - prepare_identity_providers_for_output() - Prepares auth identity provider data for output (e.g. to templates, WS, etc.).
294 === 3.2 ===
296 * Custom roles with access to any part of site administration that do not use the manager archetype will need
297   moodle/site:configview capability added.
298 * Admin setting "Show My courses expanded on Dashboard" has been removed.
299 * Some backwards and forwards compatibility has been added for different bootstrap versions.
300   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
301   with bootstrap classes to keep working in the new theme. See MDL-56004 for the list of supported classes.
302 * MForms element 'submitlink' has been deprecated.
303 * Searchable selector form element is now a wrapper for autocomplete. A "No selection" option is automatically
304   added to the options list for best backwards compatibility - if you were manually adding a "no selection" option you will need
305   to remove it.
306 * Node.js versions >=4 are now required to run grunt.
307 * JQuery has been updated to 3.1.0. JQuery migrate plugins are no longer shipped - please read
308 and update your javascript.
309 * New option 'blanktarget' added to format_text. This option adds target="_blank" to links
310 * A new webservice structure `external_files` has been created which provides a standardised view of files in Moodle and
311   should be used for all file return descriptions.
312   Files matching this format can be retrieved via the new `external_util::get_area_files` method.
313   See MDL-54951 for further information.
314 * The parameter $usepost of the following functions has been deprecated and is not used any more:
315   - get_max_upload_file_size()
316   - get_user_max_upload_file_size()
317 * The following classes have been removed and should not be used any more:
318     - boxclient - See MDL-49599 for more information.
319 * The following functions have been removed and should not be used any more:
320     - file_modify_html_header() - See MDL-29738 for more information.
321 * core_grades_external::get_grades has been deprecated. Please do not call this function any more.
322   External function gradereport_user_external::get_grade_items can be used for retrieving the course grades information.
323 * New option 'escape' added to format_string. When true (default), escapes HTML entities from the string
324 * The following functions have been deprecated and are not used any more:
325   - get_records_csv() Please use csv_import_reader::load_csv_content() instead.
326   - put_records_csv() Please use download_as_dataformat (lib/dataformatlib.php) instead.
327   - zip_files()   - See MDL-24343 for more information.
328   - unzip_file()  - See MDL-24343 for more information.
329   - print_log()           - See MDL-43681 for more information
330   - print_log_csv()       - See MDL-43681 for more information
331   - print_log_ods()       - See MDL-43681 for more information
332   - print_log_xls()       - See MDL-43681 for more information
333   - print_mnet_log()      - See MDL-43681 for more information
334   - build_logs_array()    - See MDL-43681 for more information
335   - get_logs()            - See MDL-43681 for more information
336   - get_logs_usercourse() - See MDL-43681 for more information
337   - get_logs_userday()    - See MDL-43681 for more information
338   - prevent_form_autofill_password() Please do not use anymore.
339 * The password_compat library was removed as it is no longer required.
340 * Phpunit has been upgraded to 5.4.x and following has been deprecated and is not used any more:
341   - setExpectedException(), use @expectedException or $this->expectException() and $this->expectExceptionMessage()
342   - getMock(), use createMock() or getMockBuilder()->getMock()
343   - UnitTestCase class is removed.
344 * The following methods have been finally deprecated and should no longer be used:
345   - course_modinfo::build_section_cache()
346   - cm_info::get_deprecated_group_members_only()
347   - cm_info::is_user_access_restricted_by_group()
348 * The following methods in cm_info::standardmethods have also been finally deprecated and should no longer be used:
349   - cm_info::get_after_edit_icons()
350   - cm_info::get_after_link()
351   - cm_info::get_content()
352   - cm_info::get_custom_data()
353   - cm_info::get_extra_classes()
354   - cm_info::get_on_click()
355   - cm_info::get_url()
356   - cm_info::obtain_dynamic_data()
357   Calling them through the magic method __call() will throw a coding exception.
358 * The alfresco library has been removed from core. It was an old version of
359   the library which was not compatible with newer versions of Alfresco.
360 * Added down arrow: $OUTPUT->darrow.
361 * All file_packer implementations now accept an additional parameter to allow a simple boolean return value instead of
362   an array of individual file statuses.
363 * "I set the field "field_string" to multiline:" now end with colon (:), as PyStrings is supposed to end with ":"
364 * New functions to support deprecation of events have been added to the base event. See MDL-46214 for further details.
365 * A new function `get_name_with_info` has been added to the base event. This function adds information about event
366   deprecations and should be used where this information is relevant.
367 * Following api's have been deprecated in behat_config_manager, please use behat_config_util instead.
368   - get_features_with_tags
369   - get_components_steps_definitions
370   - get_config_file_contents
371   - merge_behat_config
372   - get_behat_profile
373   - profile_guided_allocate
374   - merge_config
375   - clean_path
376   - get_behat_tests_path
377 * behat_util::start_test_mode() accepts 3 options now:
378   - 1. Theme sute with all features: If behat should initialise theme suite with all core features.
379   - 2. Parallel runs: How many parallel runs will be running.
380   - 3. Run: Which process behat should be initialise for.
381 * behat_context_helper::set_session() has been deprecated, please use behat_context_helper::set_environment() instead.
382 * data-fieldtype="type" attribute has been added to form field default template.
383 * form elements extending MoodleQuickForm_group must call $this->createFormElement() instead of
384   @MoodleQuickForm::createElement() in order to be compatible with PHP 7.1
385 * Relative paths in $CFG->alternateloginurl will be resolved to absolute path within moodle site. Previously they
386   were resolved to absolute path within the server. That means:
387   - $CFG->wwwroot:
388   - $CFG->alternateloginurl : /my/super/login.php
389   - Login url will be: (moodle root based)
390 * Database (DML) layer:
391   - new sql_equal() method available for places where case sensitive/insensitive varchar comparisons are required.
392 * PostgreSQL connections now use advanced options to reduce connection overhead.  These options are not compatible
393   with some connection poolers.  The dbhandlesoptions parameter has been added to allow the database to configure the
394   required defaults. The parameters that are required in the database are;
395     ALTER DATABASE moodle SET client_encoding = UTF8;
396     ALTER DATABASE moodle SET standard_conforming_strings = on;
397     ALTER DATABASE moodle SET search_path = 'moodle,public';  -- Optional, if you wish to use a custom schema.
398   You can set these options against the database or the moodle user who connects.
399 * Some form elements have been refined to better support right-to-left languages. In RTL,
400   most fields should not have their direction flipped, a URL, a path to a file, a number, ...
401   are always displayed LTR. Input fields and text areas now will best guess whether they
402   should be forced to be displayed in LTR based on the PARAM type associated with it. You
403   can call $mform->setForceLtr($elementName, true/false) on some form fields to manually
404   set the value.
405 * Action menus do_not_enhance() is deprecated, use a list of action_icon instead.
406 * The user_not_fully_set_up() function has a new $strict parameter (defaulting to true) in order to decide when
407   custom fields (and other checks) should be evaluated to determine if the user has been completely setup.
408 * profile_field_base class has new methods: get_field_config_for_external() and get_field_properties().
409   This two new methods should be implemented by profile field plugins to make them compatible with Web Services.
410 * The minifier library used by core_minify has been switched to - there are minor differences
411   in minifier output.
412 * context_header additional buttons can now have a class attribute provided in the link attributes.
413 * The return signature for the antivirus::scan_file() function has changed.
414   The calling function will now handle removal of infected files from Moodle based on the new integer return value.
415 * The first parameter $eventdata of both message_send() and \core\message\manager::send_message() should
416   be \core\message\message. Use of stdClass is deprecated.
417 * The message_sent event now expects other[courseid] to be always set, exception otherwise. For BC with contrib code,
418   message_sent::create_from_ids() will show a debugging notice if the \core\message\message being sent is missing
419   the courseid property, defaulting to SITEID automatically. In Moodle 3.6 (MDL-55449) courseid will be fully mandatory
420   for all messages sent.
421 * The send_confirmation_email() function has a new optional parameter $confirmationurl to provide a different confirmation URL.
422 * Introduced a new hook for plugin developers:
423     - <component>_course_module_background_deletion_recommended()
424   This hook should be used in conjunction with the existing '<component>_pre_course_module_delete($mod)'. It must
425   return a boolean and is called by core to check whether a plugin's implementation of
426   <component>_pre_course_module_deleted($mod) will take a long time. A plugin should therefore only implement this
427   function if it also implements <component>_pre_course_module_delete($mod).
428   An example in current use is recyclebin, which performs what can be a lengthy backup process in
429   tool_recyclebin_pre_course_module_delete. The recyclebin, if enabled, now returns true in its implementation of
430   tool_recyclebin_course_module_background_deletion_recommended(), to indicate to core that the deletion (and
431   execution of tool_recyclebin_pre_course_module_delete) should be handled with an adhoc task, meaning it will not
432   occur in real time.
434 === 3.1 ===
436 * Webservice function core_course_search_courses accepts a new parameter 'limittoenrolled' to filter the results
437   only to courses the user is enrolled in, and are visible to them.
438 * External functions that are not calling external_api::validate_context are buggy and will now generate
439   exceptions. Previously they were only generating warnings in the webserver error log.
440   See
441 * The moodle/blog:associatecourse and moodle/blog:associatemodule capabilities has been removed.
442 * The following functions has been finally deprecated and can not be used any more:
443     - profile_display_badges()
444     - useredit_shared_definition_preferences()
445     - calendar_normalize_tz()
446     - get_user_timezone_offset()
447     - get_timezone_offset()
448     - get_list_of_timezones()
449     - calculate_user_dst_table()
450     - dst_changes_for_year()
451     - get_timezone_record()
452     - test_get_list_of_timezones()
453     - test_get_timezone_offset()
454     - test_get_user_timezone_offset()
455 * The google api library has been updated to version 1.1.7. There was some important changes
456   on the SSL handling. Now the SSL version will be determined by the underlying library.
457   For more information see
458 * The get_role_users() function will now add the $sort fields that are not part
459   of the requested fields to the query result and will throw a debugging message
460   with the added fields when that happens.
461 * The core_user::fill_properties_cache() static method has been introduced to be a reference
462   and allow standard user fields data validation. Right now only type validation is supported
463   checking it against the parameter (PARAM_*) type of the target user field. MDL-52781 is
464   going to add support to null/not null and choices validation, replacing the existing code to
465   validate the user fields in different places in a common way.
466 * Webservice function core_course_search_courses now returns results when the search string
467   is less than 2 chars long.
468 * Webservice function core_course_search_courses accepts a new parameter 'requiredcapabilities' to filter the results
469   by the capabilities of the current user.
470 * New mform element 'course' handles thousands of courses with good performance and usability.
471 * The redirect() function will now redirect immediately if output has not
472   already started. Messages will be displayed on the subsequent page using
473   session notifications. The type of message output can be configured using the
474   fourth parameter to redirect().
475 * The specification of extra classes in the $OUTPUT->notification()
476   function, and \core\output\notification renderable have been deprecated
477   and will be removed in a future version.
478   Notifications should use the levels found in \core\output\notification.
480   \core\output\notification have been deprecated in favour of NOTIFY_ERROR,
481   NOTIFY_WARNING, and NOTIFY_INFO respectively.
482 * The following functions, previously used (exclusively) by upgrade steps are not available
483   anymore because of the upgrade cleanup performed for this version. See MDL-51580 for more info:
484     - upgrade_mysql_fix_unsigned_and_lob_columns()
485     - upgrade_course_completion_remove_duplicates()
486     - upgrade_save_orphaned_questions()
487     - upgrade_rename_old_backup_files_using_shortname()
488     - upgrade_mssql_nvarcharmax()
489     - upgrade_mssql_varbinarymax()
490     - upgrade_fix_missing_root_folders()
491     - upgrade_course_modules_sequences()
492     - upgrade_grade_item_fix_sortorder()
493     - upgrade_availability_item()
494 * A new parameter $ajaxformdata was added to the constructor for moodleform. When building a
495   moodleform in a webservice or ajax script (for example using the new fragments API) we
496   cannot allow the moodleform to parse it's own data from _GET and _POST - we must pass it as
497   an array.
498 * Plugins can extend the navigation for user by declaring the following callback:
499   <frankenstyle>_extend_navigation_user(navigation_node $parentnode, stdClass $user,
500                                         context_user $context, stdClass $course,
501                                         context_course $coursecontext)
502 * The function notify() now throws a debugging message - see MDL-50269.
503 * Ajax calls going through lib/ajax/* now validate the return values before sending
504   the response. If the validation does not pass an exception is raised. This behaviour
505   is consistent with web services.
506 * Several changes in Moodle core, standard plugins and third party libraries to
507   ensure compatibility with PHP7. All plugins are recommended to perform testing
508   against PHP7 as well. Refer to for more
509   information. The following changes may affect you:
510   * Class moodleform, moodleform_mod and some module classes have been changed to use
511     __construct() for the constructor. Calling parent constructors by the class
512     name will display debugging message. Incorrect: parent::moodleform(),
513     correct: parent::__construct()
514   * All form elements have also changed the constructor syntax. No changes are
515     needed for using form elements, however if plugin defines new form element it
516     needs to use correct syntax. For example, incorrect: parent::HTML_QuickForm_input(),
517     HTML_QuickForm_input::HTML_QuickForm_input(), $this->HTML_QuickForm_input().
518     Correct: HTML_QuickForm_input::__construct() or parent::__construct().
519   * profile_field_base::profile_field_base() is deprecated, use parent::__construct()
520     in custom profile fields constructors. Similar deprecations in exsiting
521     profile_field_* classes.
522   * user_filter_type::user_filter_type() is deprecated, use parent::__construct() in
523     custom user filters. Similar deprecations in existing user_filter_* classes.
524   * table_default_export_format_parent::table_default_export_format_parent() is
525     deprecated, use parent::__construct() in extending classes.
526 * groups_delete_group_members() $showfeedback parameter has been removed and is no longer
527   respected. Users of this function should output their own feedback if required.
528 * Number of changes to Tags API, see tag/upgrade.txt for more details
529 * The previous events API handlers are being deprecated in favour of events 2 API, debugging messages are being displayed if
530   there are 3rd party plugins using it. Switch to events 2 API please, see
531   Note than you will need to bump the plugin version so moodle is aware that you removed the plugin's event handlers.
532 * mforms validation functions are not available in the global JS namespace anymore, event listeners
533   are assigned to fields and buttons through a self-contained JS function.
534 * Added $CFG->urlrewriteclass option to config.php allowing clean / semantic urls to
535   be implemented in a plugin, eg local_cleanurls.
536 * $CFG->pathtoclam global setting has been moved to clamav antivirus plugin setting of the same name.
537 * clam_message_admins() and get_clam_error_code() have been deprecated, its functionality
538   is now a part of \antivirus_clamav\scanner class methods.
539 * \repository::antivir_scan_file() has been deprecated, \core\antivirus\manager::scan_file() that
540   applies antivirus plugins is replacing its functionality.
541 * Added core_text::str_max_bytes() which safely truncates multi-byte strings to a maximum number of bytes.
542 * Zend Framework has been removed completely.
543 * Any plugin can report when a scale is being used with the callback function [pluginname]_scale_used_anywhere(int $scaleid).
544 * Changes in file_rewrite_pluginfile_urls: Passing a new option reverse = true in the $options var will make the function to convert
545   actual URLs in $text to encoded URLs in the @@PLUGINFILE@@ form.
546 * behat_util::is_server_running() is removed, please use behat_util::check_server_status() instead.
547 * Behat\Mink\Selector\SelectorsHandler::xpathLiteral() method is deprecated use behat_context_helper::escape instead
548   when building Xpath, or pass the unescaped value when using the named selector.',
549 * table_sql download process is using the new data formats plugin which you can't use if you are buffering any output
550     * flexible_table::get_download_menu(), considered private, has been deleted. Use
551       $OUTPUT->download_dataformat_selector() instead.
552   when building Xpath, or pass the unescaped value when using the named selector.
553 * Add new file_is_executable(), to consistently check for executables even in Windows (PHP bug #41062).
554 * Introduced new hooks for plugin developers.
555     - <component>_pre_course_category_delete($category)
556     - <component>_pre_course_delete($course)
557     - <component>_pre_course_module_delete($cm)
558     - <component>_pre_block_delete($instance)
559     - <component>_pre_user_delete($user)
560   These hooks allow developers to use the item in question before it is deleted by core. For example, if your plugin is
561   a module (plugins located in the mod folder) called 'xxx' and you wish to interact with the user object before it is
562   deleted then the function to create would be mod_xxx_pre_user_delete($user) in mod/xxx/lib.php.
563 * pear::Net::GeoIP has been removed.
565 === 3.0 ===
567 * Minify updated to 2.2.1
568 * htmlpurifier upgraded to 4.7.0
569 * Less.php upgraded to
570 * The horde library has been updated to version 5.2.7.
571 * Google libraries (lib/google) updated to 1.1.5
572 * Html2Text library has been updated to the latest version of the library.
573 * External functions x_is_allowed_from_ajax() methods have been deprecated. Define 'ajax' => true in db/services.php instead.
574 * External functions can be called without a session if they define 'loginrequired' => true in db/services.php.
575 * All plugins are required to declare their frankenstyle component name via
576   the $plugin->component property in their version.php file. See
577 for details (MDL-48494).
578 * PHPUnit is upgraded to 4.7. Some tests using deprecated assertions etc may need changes to work correctly.
579 * Users of the text editor API to manually create a text editor should call set_text before calling use_editor.
580 * Javascript - SimpleYUI and the Y instance used for modules have been merged. Y is now always the same instance of Y.
581 * get_referer() has been deprecated, please use the get_local_referer function instead.
582 * \core\progress\null is renamed to \core\progress\none for improved PHP7 compatibility as null is a reserved word (see MDL-50453).
583 * \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
584   server exceptions in $CFG->proxybypass. See MDL-39353 for details.
585 * Group and groupings idnumbers can now be passed to and/or are returned from the following web services functions:
586   ** core_group_external::create_groups
587   ** core_group_external::get_groups
588   ** core_group_external::get_course_groups
589   ** core_group_external::create_groupings
590   ** core_group_external::update_groupings
591   ** core_group_external::get_groupings
592   ** core_group_external::get_course_groupings
593   ** core_group_external::get_course_user_groups
594 * Following functions are removed from core. See MDL-50049 for details.
595     password_compat_not_supported()
596     session_get_instance()
597     session_is_legacy()
598     session_kill_all()
599     session_touch()
600     session_kill()
601     session_kill_user()
602     session_set_user()
603     session_is_loggedinas()
604     session_get_realuser()
605     session_loginas()
606     js_minify()
607     css_minify_css()
608     update_login_count()
609     reset_login_count()
610     check_gd_version()
611     update_log_display_entry()
612     get_recent_enrolments()
613     groups_filter_users_by_course_module_visible()
614     groups_course_module_visible()
615     error()
616     formerr()
617     editorhelpbutton()
618     editorshortcutshelpbutton()
619     choose_from_menu()
620     update_event()
621     get_generic_section_name()
622     get_all_sections()
623     add_mod_to_section()
624     get_all_mods()
625     get_course_section()
626     format_weeks_get_section_dates()
627     get_print_section_cm_text()
628     print_section_add_menus()
629     make_editing_buttons()
630     print_section()
631     print_overview()
632     print_recent_activity()
633     delete_course_module()
634     update_category_button()
635     make_categories_list()
636     category_delete_move()
637     category_delete_full()
638     move_category()
639     course_category_hide()
640     course_category_show()
641     get_course_category()
642     create_course_category()
643     get_all_subcategories()
644     get_child_categories()
645     get_categories()
646     print_course_search()
647     print_my_moodle()
648     print_remote_course()
649     print_remote_host()
650     print_whole_category_list()
651     print_category_info()
652     get_course_category_tree()
653     print_courses()
654     print_course()
655     get_category_courses_array()
656     get_category_courses_array_recursively()
657     blog_get_context_url()
658     get_courses_wmanagers()
659     convert_tree_to_html()
660     convert_tabrows_to_tree()
661     can_use_rotated_text()
662     get_parent_contexts()
663     get_parent_contextid()
664     get_child_contexts()
665     create_contexts()
666     cleanup_contexts()
667     build_context_path()
668     rebuild_contexts()
669     preload_course_contexts()
670     context_moved()
671     fetch_context_capabilities()
672     context_instance_preload()
673     get_contextlevel_name()
674     print_context_name()
675     mark_context_dirty()
676     delete_context()
677     get_context_url()
678     get_course_context()
679     get_user_courses_bycap()
680     get_role_context_caps()
681     get_courseid_from_context()
682     context_instance_preload_sql()
683     get_related_contexts_string()
684     get_plugin_list_with_file()
685     check_browser_operating_system()
686     check_browser_version()
687     get_device_type()
688     get_device_type_list()
689     get_selected_theme_for_device_type()
690     get_device_cfg_var_name()
691     set_user_device_type()
692     get_user_device_type()
693     get_browser_version_classes()
694     generate_email_supportuser()
695     badges_get_issued_badge_info()
696     can_use_html_editor()
697     enrol_cohort_get_cohorts()
698     enrol_cohort_can_view_cohort()
699     cohort_get_visible_list()
700     enrol_cohort_enrol_all_users()
701     enrol_cohort_search_cohorts()
702 * The never unused webdav_locks table was dropped.
703 * The actionmenu hideMenu() function now expects an EventFacade object to be passed to it,
704   i.e. a call to M.core.actionmenu.instance.hideMenu() should be change to M.core.actionmenu.instance.hideMenu(e)
705 * In the html_editors (tinyMCE, Atto), the manage files button can be hidden by changing the 'enable_filemanagement' option to false.
706 * external_api::validate_context now is public, it can be called from other classes.
707 * rss_error() now supports returning of correct HTTP status of error and will return '404 Not Found'
708   unless other status is specified.
709 * Plugins can extend the navigation for categories settings by declaring the following callback:
710   <frankenstyle>_extend_navigation_category_settings(navigation_node, context_coursecat)
711 * The clilib.php provides two new functions cli_write() and cli_writeln() that should be used for outputting texts from the command
712   line interface scripts.
713 * External function core_course_external::get_course_contents returned parameter "name" has been changed to PARAM_RAW,
714   this is because the new external_format_string function may return raw data if the global moodlewssettingraw parameter is used.
715 * Function is_web_crawler() has been deprecated, please use core_useragent::is_web_crawler() instead.
717 === 2.9.1 ===
719 * New methods grade_grade::get_grade_max() and get_grade_min() must be used rather than directly the public properties rawgrademax and rawgrademin.
720 * New method grade_item::is_aggregate_item() indicates when a grade_item is an aggreggated type grade.
722 === 2.9 ===
724 * The default home page for users has been changed to the dashboard (formely my home). See MDL-45774.
725 * Support for rendering templates from php or javascript has been added. See MDL-49152.
726 * Support for loading AMD javascript modules has been added. See MDL-49046.
727 * Webservice core_course_delete_courses now return warning messages on any failures and does not try to rollback the entire deletion.
728 * \core\event\course_viewed 'other' argument renamed from coursesectionid to coursesectionnumber as it contains the section number.
729 * New API core_filetypes::add_type (etc.) allows custom filetypes to be added and modified.
730 * PHPUnit: PHPMailer Sink is now started for all tests and is setup within the phpunit wrapper for advanced tests.
731   Catching debugging messages when sending mail will no longer work. Use $sink = $this->redirectEmails(); and then check
732   the message in the sink instead.
733 * The file pluginlib.php was deprecated since 2.6 and has now been removed, do not include or require it.
734 * \core_component::fetch_subsystems() now returns a valid path for completion component instead of null.
735 * Deprecated JS global methods have been removed (show_item, destroy_item, hide_item, addonload, getElementsByTagName, findChildNodes).
736 * For 3rd party plugin specific environment.xml files, it's now possible to specify version independent checks by using the
737   <PLUGIN name="component_name"> tag instead of the version dependent <MOODLE version="x.y"> one. If the PLUGIN tag is used any
738   Moodle specific tags will be ignored.
739 * 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).
740 * The authorization procedure in the mdeploy.php script has been improved. The script
741   now relies on the main config.php when deploying an available update.
742 * sql_internal_reader and sql_select_reader interfaces have been deprecated in favour of sql_internal_table_reader
743   and sql_reader which use iterators to be more memory efficient.
744 * $CFG->enabletgzbackups setting has been removed as now backups are stored internally using .tar.gz format by default, you can
745   set $CFG->usezipbackups to store them in zip format. This does not affect the restore process, which continues accepting both.
746 * Added support for custom string manager implementations via $CFG->customstringmanager
747   directive in the config.php. See MDL-49361 for details.
748 * Add new make_request_directory() for creation of per-request files.
749 * Added generate_image_thumbnail_from_string. This should be used instead of generate_image_thumbnail when the source is a string.
750   This prevents the need to write files to disk unnecessarily.
751 * Added generate_image_thumbnail to stored_file class. This should be used when generating thumbnails for stored files.
752   This prevents the need to write files to disk unnecessarily.
753 * Removed pear/HTTP/WebDav. See MDL-49534 for details.
754 * Use standard PHP date time classes and methods - see new core_date class for timezone normalisation methods.
755 * Moved lib/google/Google/ to lib/google/src/Google. This is to address autoloader issues with Google's provided autoloader
756   for the library. See MDL-49519 for details.
757 * The outdated lib/google/Google_Client.php and related files have been completely removed. To use
758   the new client, read lib/google/readme_moodle.txt, please.
759 * profile_display_badges() has been deprecated. See MDL-48935 for details.
760 * 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"
761   then please use this function to ensure that the breadcrumb and navigation block are created properly for all user profile pages.
762 * process_new_icon() now does not always return a PNG file. When possible, it will try to keep the format of the original file.
763   Set the new argument $preferpng to true to force PNG. See MDL-46763 and MDL-50041 for details.
765 === 2.8 ===
767 * Gradebook grade category option "aggregatesubcats" has been removed completely.
768   This means that the database column is removed, the admin settings are removed and
769   the properties from the grade_category object have been removed. If any courses were
770   found to be using this setting, a warning to check the grades will be shown in the
771   course grader report after upgrading the site. The same warning will be shown on
772   courses restored from backup that had this setting enabled (see MDL-47503).
773 * lib/excelllib.class.php has been updated. The class MoodleExcelWorkbook will now only produce excel 2007 files.
774 * renderers: We now remove the suffix _renderable when looking for a render method for a renderable.
775   If you have a renderable class named like "blah_renderable" and have a method on a renderer named "render_blah_renderable"
776   you will need to change the name of your render method to "render_blah" instead, as renderable at the end is no longer accepted.
777 * New functions get_course_and_cm_from_cmid($cmorid, $modulename) and
778   get_course_and_cm_from_instance($instanceorid, $modulename) can be used to
779   more efficiently load these basic data objects at the start of a script.
780 * New function cm_info::create($cm) can be used when you need a cm_info
781   object, but have a $cm which might only be a standard database record.
782 * $CFG->enablegroupmembersonly no longer exists.
783 * Scheduled tasks have gained support for syntax to introduce variability when a
784   task will run across installs. When a when hour or minute are defined as 'R'
785   they will be installed with a random hour/minute value.
786 * Several classes grade_edit_tree_column_xxx were removed since grades setup page
787   has been significantly changed. These classes should not be used outside of
788   gradebook or developers can copy them into their plugins from 2.7 branch.
789 * Google APIs Client Library (lib/google/) has been upgraded to 1.0.5-beta and
790   API has changed dramatically without backward compatibility. Any code accessing
791   it must be amended. It does not apply to lib/googleapi.php. See MDL-47297
792 * Added an extra parameter to the function get_formatted_help_string() (default null) which is used to specify
793   additional string parameters.
794 * User settings node and course node in navigation now support callbacks from admin tools.
795 * grade_get_grades() optional parameteres $itemtype, $itemmodule, $iteminstance are now required.
798 * completion_info->get_incomplete_criteria() is deprecated and will be removed in Moodle 3.0.
799 * grade_category::aggregate_values() is deprecated and will be removed in Moodle 3.0.
800 * groups_filter_users_by_course_module_visible() is deprecated; replace with
801   core_availability\info::filter_user_list. Will be removed in Moodle 3.0.
802 * groups_course_module_visible() is deprecated; replace with $cm->uservisible.
803 * cm_info property $cm->groupmembersonly is deprecated and always returns 0.
804   Use core_availability\info::filter_user_list if trying to determine which
805   other users can see an activity.
806 * cm_info method $cm->is_user_access_restricted_by_group() is deprecated and
807   always returns false. Use $cm->uservisible to determine whether the user can
808   access the activity.
809 * Constant FEATURE_GROUPMEMBERSONLY (used in module _supports functions) is
810   deprecated.
811 * cohort_get_visible_list() is deprecated. There is a better function cohort_get_available_cohorts()
812   that respects user capabilities to view cohorts.
813 * enrol_cohort_get_cohorts() and enrol_cohort_search_cohorts() are deprecated since
814   functionality is removed. Please use cohort_get_available_cohorts()
815 * enrol_cohort_enrol_all_users() is deprecated; enrol_manual is now responsible for this action
816 * enrol_cohort_can_view_cohort() is deprecated; replace with cohort_can_view_cohort()
818 === 2.6.4 / 2.7.1 ===
820 * setnew_password_and_mail() and update_internal_user_password() will trigger
821   \core\event\user_password_updated. Previously they used to generate
822   \core\event\user_updated event.
823 * update_internal_user_password() accepts optional boolean $fasthash for fast
824   hashing.
825 * user_update_user() and user_create_user() api's accept optional param
826   $triggerevent to avoid respective events to be triggred from the api's.
828 === 2.7 ===
830 * PHPUnit cannot be installed via PEAR any more, please use composer package manager instead.
831 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
833 Events and Logging:
834 * Significant changes in Logging API. For upgrading existing events_trigger() and
835   add_to_log() see
836   For accessing logs from plugins see
837 * The validation of the following events is now stricter (see MDL-45445):
838     - \core\event\blog_entry_created
839     - \core\event\blog_entry_deleted
840     - \core\event\blog_entry_updated
841     - \core\event\cohort_member_added
842     - \core\event\cohort_member_removed
843     - \core\event\course_category_deleted
844     - \core\event\course_completed
845     - \core\event\course_content_deleted
846     - \core\event\course_created
847     - \core\event\course_deleted
848     - \core\event\course_restored
849     - \core\event\course_section_updated (see MDL-45229)
850     - \core\event\email_failed
851     - \core\event\group_member_added
852     - \core\event\group_member_removed
853     - \core\event\note_created
854     - \core\event\note_deleted
855     - \core\event\note_updated
856     - \core\event\role_assigned
857     - \core\event\role_deleted
858     - \core\event\role_unassigned
859     - \core\event\user_graded
860     - \core\event\user_loggedinas
861     - \core\event\user_profile_viewed
862     - \core\event\webservice_token_created
865 * $module uses in mod/xxx/version.php files is now deprecated. Please use $plugin instead. It will be removed in Moodle 2.10.
866 * Update init methods in all event classes - "level" property was renamed to "edulevel", the level property is now deprecated.
867 * Abstract class \core\event\course_module_instances_list_viewed is deprecated now, use \core\event\instances_list_viewed instead.
868 * Abstract class core\event\content_viewed has been deprecated. Please extend base event or other relevant abstract class.
869 * mod_book\event\instances_list_viewed has been deprecated. Please use mod_book\event\course_module_instance_list_viewed instead.
870 * mod_chat\event\instances_list_viewed has been deprecated. Please use mod_chat\event\course_module_instance_list_viewed instead.
871 * mod_choice\event\instances_list_viewed has been deprecated. Please use mod_choice\event\course_module_instance_list_viewed instead.
872 * mod_feedback\event\instances_list_viewed has been deprecated. Please use mod_feedback\event\course_module_instance_list_viewed instead.
873 * mod_page\event\instances_list_viewed has been deprecated. Please use mod_page\event\course_module_instance_list_viewed instead.
875 * Conditional availability API has moved and changed. The condition_info class is
876   replaced by \core_availability\info_module, and condition_info_section by
877   \core_availability\info_section. (Code that uses the old classes will generally
878   still work.)
879 * coursemodule_visible_for_user() has been deprecated but still works - replaced
880   by a new static function \core_availability\info_module::is_user_visible()
881 * cm_info::is_user_access_restricted_by_conditional_access has been deprecated
882   but still works (it has never done what its name suggests, and is
883   unnecessary).
884 * cm_info and section_info property showavailability has been deprecated, but
885   still works (with the caveat that this information is now per-user).
886 * cm_info and section_info properties availablefrom and availableuntil have been
887   deprecated and always return zero (underlying data doesn't have these values).
888 * section_info property groupingid has been deprecated and always returns zero,
889   same deal.
890 * Various cm_info methods have been deprecated in favour of their read-only properties (get_url(), get_content(), get_extra_classes(),
891   get_on_click(), get_custom_data(), get_after_link, get_after_edit_icons)
892 * The ajaxenabled function has been deprecated and always returns true. All code should be fully functional in Javascript.
893 * count_login_failures() has been deprecated, use user_count_login_failures() instead. Refer MDL-42891 for details.
895 Conditional availability (activities and sections):
896 * New conditional availability API in /availability, including new availability
897   condition plugins in /availability/condition. The new API is very similar with
898   regard to checking availability, but any code that modifies availability settings
899   for an activity or section is likely to need substantial changes.
901 YUI:
902   * The lightbox attribute for moodle-core-notification-dialogue has been
903     deprecated and replaced by the modal attribute. This was actually
904     changed in Moodle 2.2, but has only been marked as deprecated now. It
905     will be removed in Moodle 2.9.
906   * When destroying any type of dialogue based on moodle-core-notification, the relevant content is also removed from
907     the DOM. Previously it was left orphaned.
909 JavaSript:
910     * The findChildNodes global function has been deprecated. Y.all should
911       be used instead.
912     * The callback argument to confirm_action and M.util.show_confirm_dialog has been deprecated. If you need to write a
913       confirmation which includes a callback, please use moodle-core-notification-confirmation and attach callbacks to the
914       events provided.
916 * New locking api and admin settings to configure the system locking type.
917 * New "Time spent waiting for the database" performance metric displayed along with the
918   other MDL_PERF vars; the change affects both the error logs and the vars displayed in
919   the page footer.
920 * Changes in the tag API. The component and contextid are now saved when assigning tags to an item. Please see
921   tag/upgrade.txt for more information.
923 === 2.6 ===
925 * Use new methods from core_component class instead of get_core_subsystems(), get_plugin_types(),
926   get_plugin_list(), get_plugin_list_with_class(), get_plugin_directory(), normalize_component(),
927   get_component_directory() and get_plugin_list_with_file(). The names of the new methods are
928   exactly the same, the only differences are that core_component::get_plugin_types() now always returns
929   full paths and core_component::get_plugin_list() does not accept empty parameter any more.
930 * Use core_text::* instead of textlib:: and also core_collator::* instead of collatorlib::*.
931 * Use new function moodleform::mock_submit() to simulate form submission in unit tests (backported).
932 * New $CFG->localcachedir setting useful for cluster nodes. Admins have to update X-Sendfile aliases if used.
933 * MS SQL Server drivers are now using NVARCHAR(MAX) instead of NTEXT and VARBINARY(MAX) instead of IMAGE,
934   this change should be fully transparent and it should help significantly with add-on compatibility.
935 * The string manager classes were renamed. Note that they should not be modified or used directly,
936   always use get_string_manager() to get instance of the string manager.
937 * The ability to use an 'insecure' rc4encrypt/rc4decrypt key has been removed.
938 * Use $CFG->debugdeveloper instead of debugging('', DEBUG_DEVELOPER).
939 * Use set_debugging(DEBUG_xxx) when changing debugging level for current request.
940 * Function moveto_module() does not modify $mod argument and instead now returns the new module visibility value.
941 * Use behat_selectors::get_allowed_text_selectors() and behat_selectors::get_allowed_selectors() instead of
942   behat_command::$allowedtextselectors and behat_command::$allowedselectors
943 * Subplugins are supported in admin tools and local plugins.
944 * file_packer/zip_packer API has been modified so that key functions support a new file_progress interface
945   to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
946   function that returns an approximate number of entries in the zip faster than the count() function.
947 * Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
948 * Class course_modinfo no longer extends stdClass. All properties are read-only.
949 * Database fields modinfo and sectioncache in table course are removed. Application cache core/coursemodinfo
950   is used instead. Course cache is still reset, rebuilt and retrieved using function rebuild_course_cache() and
951   get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
952   If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
953   object.
954 * Internal (noreply and support) user support has been added for sending/receiving message.
955   Use core_user::get_noreply_user() and core_user::get_support_user() to get noreply and support user's respectively.
956   Real users can be used as noreply/support users by setting $CFG->noreplyuserid and $CFG->supportuserid
957 * New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
958 * Use core_plugin_manager::reset_caches() when changing visibility of plugins.
959 * Implement new method get_enabled_plugins() method in subplugin info classes.
960 * Each plugin should include version information in version.php.
961 * Module and block tables do not contain version column any more, use get_config('xx_yy', 'version') instead.
962 * $USER->password field is intentionally unset so that session data does not contain password hashes.
963 * Use core_shutdown_manager::register_function() instead of register_shutdown_function().
964 * New file packer for .tar.gz files; obtain by calling get_file_packer('application/x-gzip'). Intended initially
965   for use in backup/restore only, as there are limitations on supported filenames. Also new packer for
966   backups which supports both compression formats; get_file_packer('application/vnd.moodle.backup').
967 * New optional parameter to stored_file::get_content_file_handle to open file handle with 'gzopen' instead
968   of 'fopen' to read gzip-compressed files if required.
969 * update_internal_user_password() and setnew_password_and_mail() now trigger user_updated event.
970 * Add thirdpartylibs.xml file to plugins that bundle any 3rd party libraries.
971 * New class introduced to help auto generate zIndex values for modal dialogues. Class "moodle-has-zindex"
972   should set on any element which uses a non-default zindex and needs to ensure it doesn't show above a
973   dialogue.
974 * $CFG->filelifetime is now used consistently for most file serving operations, the default was lowered
975   to 6 hours from 24 hours because etags and x-sendfile support should make file serving less expensive.
976 * Date format locale charset for windows server will come from calendar type and for gregorian it will use
977   lang file.
978 * The library to interact with (class boxclient) is only compatible with their APIv1 which
979   reaches its end of life on the 14th of Dec. You should migrate your scripts to make usage of the
980   new class boxnet_client(). Note that the method names and return values have changed.
981 * Settings pages are now possible for Calendar type plugins. Calendar type plugins that require a settings page to
982   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.
983 * The admin/tool/generator tool was overhauled to use testing data generators and the previous interface to create
984   test data was removed (it was not working correctly anyway). If you were using this tool you will probably need to
985   update your code.
988 Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
989 and will be removed in a future release (target: 2.8), a summary follows:
991 Accesslib:
992     * get_context_instance()                ->  context_xxxx::instance()
993     * get_context_instance_by_id()          ->  context::instance_by_id($id)
994     * get_system_context()                  ->  context_system::instance()
995     * context_moved()                       ->  context::update_moved()
996     * preload_course_contexts()             ->  context_helper::preload_course()
997     * context_instance_preload()            ->  context_helper::preload_from_record()
998     * context_instance_preload_sql()        ->  context_helper::get_preload_record_columns_sql()
999     * get_contextlevel_name()               ->  context_helper::get_level_name()
1000     * create_contexts()                     ->  context_helper::create_instances()
1001     * cleanup_contexts()                    ->  context_helper::cleanup_instances()
1002     * build_context_path()                  ->  context_helper::build_all_paths()
1003     * print_context_name()                  ->  $context->get_context_name()
1004     * mark_context_dirty()                  ->  $context->mark_dirty()
1005     * delete_context()                      ->  $context->delete_content() or context_helper::delete_instance()
1006     * get_context_url()                     ->  $context->get_url()
1007     * get_course_context()                  ->  $context->get_course_context()
1008     * get_parent_contexts()                 ->  $context->get_parent_context_ids()
1009     * get_parent_contextid()                ->  $context->get_parent_context()
1010     * get_child_contexts()                  ->  $context->get_child_contexts()
1011     * rebuild_contexts()                    ->  $context->reset_paths()
1012     * get_user_courses_bycap()              ->  enrol_get_users_courses()
1013     * get_courseid_from_context()           ->  $context->get_course_context(false)
1014     * get_role_context_caps()               ->  (no replacement)
1015     * load_temp_role()                      ->  (no replacement)
1016     * remove_temp_roles()                   ->  (no replacement)
1017     * get_related_contexts_string()         ->  $context->get_parent_context_ids(true)
1018     * get_recent_enrolments()               ->  (no replacement)
1020 Enrollment:
1021     * get_course_participants()             -> get_enrolled_users()
1022     * is_course_participant()               -> is_enrolled()
1024 Output:
1025     * current_theme()                       -> $PAGE->theme->name
1026     * skip_main_destination()               -> $OUTPUT->skip_link_target()
1027     * print_container()                     -> $OUTPUT->container()
1028     * print_container_start()               -> $OUTPUT->container_start()
1029     * print_container_end()                 -> $OUTPUT->container_end()
1030     * print_continue()                      -> $OUTPUT->continue_button()
1031     * print_header()                        -> $PAGE methods
1032     * print_header_simple()                 -> $PAGE methods
1033     * print_side_block()                    -> $OUTPUT->block()
1034     * print_arrow()                         -> $OUTPUT->arrow()
1035     * print_scale_menu_helpbutton()         -> $OUTPUT->help_icon_scale($courseid, $scale)
1036     * print_checkbox()                      -> html_writer::checkbox()
1038 Navigation:
1039     * print_navigation()                    -> $OUTPUT->navbar()
1040     * build_navigation()                    -> $PAGE->navbar methods
1041     * navmenu()                             -> (no replacement)
1042     * settings_navigation::
1043           get_course_modules()              -> (no replacement)
1045 Files and repositories:
1046     * stored_file::replace_content_with()   -> stored_file::replace_file_with()
1047     * stored_file::set_filesize()           -> stored_file::replace_file_with()
1048     * stored_file::get_referencelifetime()  -> (no replacement)
1049     * repository::sync_external_file()      -> see repository::sync_reference()
1050     * repository::get_file_by_reference()   -> repository::sync_reference()
1051     * repository::
1052           get_reference_file_lifetime()     -> (no replacement)
1053     * repository::sync_individual_file()    -> (no replacement)
1054     * repository::reset_caches()            -> (no replacement)
1056 Calendar:
1057     * add_event()                           -> calendar_event::create()
1058     * update_event()                        -> calendar_event->update()
1059     * delete_event()                        -> calendar_event->delete()
1060     * hide_event()                          -> calendar_event->toggle_visibility(false)
1061     * show_event()                          -> calendar_event->toggle_visibility(true)
1063 Misc:
1064     * filter_text()                         -> format_text(), format_string()...
1065     * httpsrequired()                       -> $PAGE->https_required()
1066     * detect_munged_arguments()             -> clean_param([...], PARAM_FILE)
1067     * mygroupid()                           -> groups_get_all_groups()
1068     * js_minify()                           -> core_minify::js_files()
1069     * css_minify_css()                      -> core_minify::css_files()
1070     * course_modinfo::build_section_cache() -> (no replacement)
1071     * generate_email_supportuser()          -> core_user::get_support_user()
1073 Sessions:
1074     * session_get_instance()->xxx()         -> \core\session\manager::xxx()
1075     * session_kill_all()                    -> \core\session\manager::kill_all_sessions()
1076     * session_touch()                       -> \core\session\manager::touch_session()
1077     * session_kill()                        -> \core\session\manager::kill_session()
1078     * session_kill_user()                   -> \core\session\manager::kill_user_sessions()
1079     * session_gc()                          -> \core\session\manager::gc()
1080     * session_set_user()                    -> \core\session\manager::set_user()
1081     * session_is_loggedinas()               -> \core\session\manager::is_loggedinas()
1082     * session_get_realuser()                -> \core\session\manager::get_realuser()
1083     * session_loginas()                     -> \core\session\manager::loginas()
1085 User-agent related functions:
1086     * check_browser_operating_system()      -> core_useragent::check_browser_operating_system()
1087     * check_browser_version()               -> core_useragent::check_browser_version()
1088     * get_device_type()                     -> core_useragent::get_device_type()
1089     * get_device_type_list()                -> core_useragent::get_device_type_list()
1090     * get_selected_theme_for_device_type()  -> core_useragent::get_device_type_theme()
1091     * get_device_cfg_var_name()             -> core_useragent::get_device_type_cfg_var_name()
1092     * set_user_device_type()                -> core_useragent::set_user_device_type()
1093     * get_user_device_type()                -> core_useragent::get_user_device_type()
1094     * get_browser_version_classes()         -> core_useragent::get_browser_version_classes()
1096 YUI:
1097     * moodle-core-notification has been deprecated with a recommendation of
1098       using its subclasses instead. This is to allow for reduced page
1099       transport costs. Current subclasses include:
1100       * dialogue
1101       * alert
1102       * confirm
1103       * exception
1104       * ajaxexception
1106 Event triggering and event handlers:
1107     * All existing events and event handlers should be replaced by new
1108       event classes and matching new event observers.
1109     * See for more information.
1110     * The following events will be entirely removed, though they can still
1111       be captured using handlers, but they should not be used any more.
1112       * groups_members_removed          -> \core\event\group_member_removed
1113       * groups_groupings_groups_removed -> (no replacement)
1114       * groups_groups_deleted           -> \core\event\group_deleted
1115       * groups_groupings_deleted        -> \core\event\grouping_deleted
1116     * edit_module_post_actions() does not trigger events any more.
1118 === 2.5.1 ===
1120 * New get_course() function for use when obtaining the course record from database. Will
1121   reuse existing $COURSE or $SITE globals if possible to improve performance.
1123 === 2.5 ===
1125 * The database drivers (moodle_database and subclasses) aren't using anymore the ::columns property
1126   for caching database metadata. MUC (databasemeta) is used instead. Any custom DB driver should
1127   apply for that change.
1128 * The cron output has been changed to include time and memory usage (see cron_trace_time_and_memory()),
1129   so any custom utility relying on the old output may require modification.
1130 * Function get_max_file_sizes now returns an option for (for example) "Course limit (500MB)" or
1131   "Site limit (200MB)" when appropriate with the option set to 0. This function no longer returns
1132   an option for 0 bytes. Existing code that was replacing the 0 option in the return
1133   from this function with a more sensible message, can now use the return from this function directly.
1134 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
1135   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
1136   make_editing_buttons()
1137   See functions' phpdocs in lib/deprecatedlib.php
1138 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
1139 * zip_packer may create empty zip archives, there is a new option to ignore
1140   problematic files when creating archive
1141 * The function delete_course_module was deprecated and has been replaced with
1142   course_delete_module. The reason for this was because the function delete_course_module
1143   only partially deletes data, so wherever it was called extra code was needed to
1144   perform the whole deletion process. The function course_delete_module now takes care
1145   of the whole process.
1146 * curl::setopt() does not accept constant values any more. As it never worked properly,
1147   we decided to make the type check stricter. Now, the keys of the array pass must be a string
1148   corresponding to the curl constant name.
1149 * Function get_users_listing now return list of users except guest and deleted users. Previously
1150   deleted users were excluded by get_users_listing. As guest user is not expected while browsing users,
1151   and not included in get_user function, it will not be returned by get_users_listing.
1152 * The add_* functions in course/dnduploadlib.php have been deprecated. Plugins should be using the
1153   MODNAME_dndupload_register callback instead.
1154 * The signature of the add() method of classes implementing the parentable_part_of_admin_tree
1155   interface (such as admin_category) has been extended. The new parameter allows the caller
1156   to prepend the new node before an existing sibling in the admin tree.
1157 * condition_info:get_condition_user_fields($formatoptions) now accepts the optional
1158   param $formatoptions, that will determine if the field names are processed by
1159   format_string() with the passed options.
1160 * remove all references to $CFG->gdversion, GD PHP extension is now required
1161 * Formslib will now throw a developer warning if a PARAM_ type hasn't been set for elements which
1162   need it. Please set PARAM_RAW explicitly if you do not want any cleaning.
1163 * Functions responsible for managing and accessing course categories are moved to class coursecat
1164   in lib/coursecatlib.php, functions responsible for rendering courses and categories lists are
1165   moved to course/renderer.php. The following global functions are deprecated: make_categories_list(),
1166   category_delete_move(), category_delete_full(), move_category(), course_category_hide(),
1167   course_category_show(), get_course_category(), create_course_category(), get_all_subcategories(),
1168   get_child_categories(), get_categories(), print_my_moodle(), print_remote_course(),
1169   print_remote_host(), print_whole_category_list(), print_category_info(), get_course_category_tree(),
1170   print_courses(), print_course(), get_category_courses_array(), get_category_courses_array_recursively(),
1171   get_courses_wmanagers()
1172   See
1173 * $core_renderer->block_move_target() changed to support more verbose move-block-here descriptions.
1174 * Additional (optional) param $onlyactive has been added to get_enrolled_users, count_enrolled_users
1175   functions to get information for only active (excluding suspended enrolments) users. Included two
1176   helper functions extract_suspended_users, get_suspended_userids to extract suspended user information.
1177 * The core_plugin_manager class now provides two new helper methods for getting information
1178   about known plugins: get_plugins_of_type() and get_subplugins_of_plugin().
1179 * The get_uninstall_url() method of all subclasses of \core\plugininfo\base class is now expected
1180   to always return moodle_url. Subclasses can use the new method is_uninstall_allowed()
1181   to control the availability of the 'Uninstall' link at the Plugins overview page (previously
1182   they would do it by get_uninstall_url() returning null). By default, URL to a new general plugin
1183   uninstall tool is returned. Unless the plugin type needs extra steps that can't be handled by
1184   plugininfo_xxx::uninstall() method or xmldb_xxx_uninstall() function, this default URL should
1185   satisfy all plugin types.
1187 Database (DML) layer:
1188 * $DB->sql_empty() is deprecated, you have to use sql parameters with empty values instead,
1189   please note hardcoding of empty strings in SQL queries breaks execution in Oracle database.
1190 * Indexes must not be defined on the same columns as keys, this is now reported as fatal problem.
1191   Please note that internally we create indexes instead of foreign keys.
1193 YUI changes:
1194 * M.util.help_icon has been deprecated. Code should be updated to use moodle-core-popuphelp
1195   instead. To do so, remove any existing JS calls to M.util.help_icon from your PHP and ensure
1196   that your help link is placed in a span which has the class 'helplink'.
1198 === 2.4 ===
1200 * Pagelib: Numerous deprecated functions were removed as classes page_base, page_course
1201   and page_generic_activity.
1202 * use $CFG->googlemapkey3 instead of removed $CFG->googlemapkey and migrate to Google Maps API V3
1203 * Function settings_navigation::add_course_editing_links() is completely removed
1204 * function global_navigation::format_display_course_content() is removed completely (the
1205   functionality is moved to course format class)
1206 * in the function global_navigation::load_generic_course_sections() the argument $courseformat is
1207   removed
1208 * New component and itemid columns in groups_members table - this allows plugin to create protected
1209   group memberships using 'xx_yy_allow_group_member_remove' callback and there is also a new restore
1210   callback 'xx_yy_restore_group_member()'.
1211 * New general role assignment restore plugin callback 'xx_yy_restore_role_assignment()'.
1212 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
1213   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
1215 YUI changes:
1216 * moodle-enrol-notification has been renamed to moodle-core-notification
1217 * YUI2 code must now use 2in3, see
1218 * M.util.init_select_autosubmit() and M.util.init_url_select() have been deprecated. Code using this should be updated
1219   to use moodle-core-formautosubmit
1221 Unit testing changes:
1222 * output debugging() is not sent to standard output any more,
1223   use $this->assertDebuggingCalled(), $this->assertDebuggingNotCalled(),
1224   $this->getDebuggingMessages() or $this->assertResetDebugging() instead.
1226 === 2.3 ===
1228 Database layer changes:
1229 * objects are not allowed in paramters of DML functions, use explicit casting to strings if necessary
1231 Note:
1232 * DDL and DML methods which were deprecated in 2.0 have now been removed, they will no longer produce
1233 debug messages and will produce fatal errors
1235 API changes:
1237 * send_stored_file() has changed its interface
1238 * deleted several resourcelib_embed_* functions from resourcelib.php
1240 === 2.2 ===
1242 removed unused libraries:
1243 * odbc, base32, CodeSniffer, overlib, apd profiling, kses, Smarty, PEAR Console, swfobject,, md5.js
1245 API changes:
1246 * new admin/tool plugin type
1247 * new context API - old API is still available
1248 * deleted users do not have context any more
1249 * removed global search
1252 === 2.1 ===
1254 API changes:
1255 * basic suport for restore from 1.9
1256 * new mobile devices API
1257 * new questions API
1260 === 2.0 ===
1262 API changes:
1263 * new DML API -
1264 * new DDL API -
1265 * new file API -
1266 * new $PAGE and $OUTPUT API
1267 * new navigation API
1268 * new theme API -
1269 * new javascript API -
1270 * new portfolio API
1271 * new local plugin type
1272 * new translation support -
1273 * new web service API
1274 * new cohorts API
1275 * new messaging API
1276 * new rating API
1277 * new comment API
1278 * new sessions API
1279 * new enrolment API
1280 * new backup/restore API
1281 * new blocks API
1282 * new filters API
1283 * improved plugin support (aka Frankenstyle)
1284 * new registration and hub API
1285 * new course completion API
1286 * new plagiarism API
1287 * changed blog API
1288 * new text editor API
1289 * new my moodle and profiles API