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