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