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