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