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