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