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