upgrade.txt 126 KB
Newer Older
1
This files describes API changes in core libraries and APIs,
2
information provided here is intended especially for developers.
3

4
5
6
7
8
=== 4.0 ===
* New navigation classes to mimic the new navigation project. The existing navigation callbacks are still available and
  will be called. The following behaviour will be the new standard for nodes added via callbacks:
   - Module nodes added will be appended to the end and will appear within the hamburger option.
   - Course nodes added will also be appended and appear within the 'More' option/page.
9
* The core/event events have been renamed and now fire native events, in addition to the legacy YUI and jQuery events.
10
  The following events have been renamed:
11
12
  - The BLOCK_CONTENT_UPDATED event has been replaced with a new native event in the `core_block/events` AMD module
    eventTypes.blockContentUpdated.
13
14
  - The EDITOR_CONTENT_RESTORED event has been replaced with a new native event in the `core_editor/events` AMD module
    eventTypes.editorContentRestored.
15
16
  - The FILTER_CONTENT_UPDATED event has been replaced with a new native event in the `core_filters/events` AMD module
    eventTypes.filterContentUpdated.
17
18
19
20
  - The FORM_FIELD_VALIDATION event has been replaced with a new native event in the `core_form/events` AMD module
    eventTypes.formFieldValidationFailed.
  - The FORM_SUBMIT_AJAX event has been replaced with a new native event in the `core_form/events` AMD module
    eventTypes.formSubmittedByJavascript.
21
* The block template now includues a block-instanceid data attribute.
22
* The core/event::getLegacyEvents() function has been deprecated and should no longer be used.
23
* Typo3 has now been removed. Use native mbstring or iconv functions.
24
* A new index has been added on mdl_user_preferences.name. This upgrade step might take some time on big sites.
25
26
27
* The completion_info function display_help_icon() which returned the 'Your progress' help icon has been deprecated and
  should no longer be used.
* The completion_info function print_help_icon() which has been deprecated since Moodle 2.0 should no longer be used.
28
* @babel/polyfill has been removed in favour of corejs@3
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
* A new parameter $isbulkupdate has been added to the following functions:
  - grade_category::update()
  - grade_category::insert()
  - grade_grade::update()
  - grade_grade::insert()
  - grade_grade::notify_changed()
  - grade_item::insert()
  - grade_item::update()
  - grade_item::update_final_grade()
  - grade_item::update_raw_grade()
  - grade_object::update()
  - grade_object::insert()
  - grade_outcome::update()
  - grade_outcome::insert()
  - grade_scale::update()
  - grade_scale::insert()
  - grade_update()
  - completion_info::inform_grade_changed()
  - completion_info::update_state()
  - completion_info::internal_set_data()
  All functions except completion_info::internal_set_data() are only passing this parameter from very beginning of
  workflow (like grade report page where bulk grade update is possible) so this parameter is used in
  completion_info::internal_set_data() to decide if we need to mark completions instantly without waiting for cron.
* Following methods now return an int instead of bool:
  - completion_completion::_save()
  - completion_completion::mark_enrolled()
  - completion_completion::mark_inprogress()
  - completion_completion::mark_complete()
  which is needed to store id of completion record on successful update which is later beeing used by
  completion_info::internal_set_data() to reaggregate completions that have been marked for instant course completion.
59
60
* The following functions have been finally deprecated and can not be used anymore:
  - generate_uuid
61
62
* The YUI moodle-core-formchangechecker module has been deprecated and replaced with a new AMD module
  core_form/changechecker.
63
64
65
* New method \core_user::awaiting_action() has been introduced to check if the user is fully ready to use the site or
  whether there is an action (such as filling the missing profile field, changing password or agreeing to the site
  policy) needed.
66
67
* The signature of the get_name() function for grade_category and grade_item has been extended. The new parameter allows
  callers to get the name without escaped characters.
68
69
* The inplace_editable element constructor now accepts an optional pix_icon parameter to use as it's editing icon when
  rendered. The default icon for "select" types has also changed to a dropdown caret ("t/expanded").
70
71
* The function message_send() in messagelib.php now returns false if there is an error sending the message to the
  message processor (MDL-70046).
72
73
74
75
76
77
78
79
80
81
82
* The following functions are deprecated in questionlib.php and moved to the new location.
  These are marked for final deprecation on 4.4:
  - question_remove_stale_questions_from_category() =>
    qbank_managecategories\helper::question_remove_stale_questions_from_category()
  - flatten_category_tree() => qbank_managecategories\helper::flatten_category_tree()
  - add_indented_names() => qbank_managecategories\helper::add_indented_names()
  - question_category_select_menu() => qbank_managecategories\helper::question_category_select_menu()
  - get_categories_for_contexts() => qbank_managecategories\helper::get_categories_for_contexts()
  - question_category_options() => qbank_managecategories\helper::question_category_options()
  - question_add_context_in_key() => qbank_managecategories\helper::question_add_context_in_key()
  - question_fix_top_names() => qbank_managecategories\helper::question_fix_top_names()
83
84
85
86
87
* Following methods are now deprecated in questionlib and moved to the new qbank_previewquestion plugin:
  - question_preview_url() is moved to qbank_previewquestion\helper::question_preview_url()
  - question_preview_popup_params() is moved to \qbank_previewquestion\helper::question_preview_popup_params()
  Calling these functions in the question will point to the plugin, but the deprecation message will be activated in MDL-72004.
  The deprecated codes are removed from the questionlib for those two methods.
88
89
* The postgres driver now wraps calls to pg_field_type() and caches them in databasemeta to save an invisible internal
  DB call on every request.
90
* The default type of 'core/toast' messages has been changed to 'information' (callers can still explicitely set the type)
91
92
* As the message_jabber notification plugin has been moved to the plugins database, the XMPPHP library (aka Jabber) has been
completely removed from Moodle core too.
93
* The SWF media player has been completely removed (The Flash Player was deprecated in 2017 and officially discontinued
94
  on 31 December 2020).
95
96
97
* The display_size function has been improved to add new optional parameters (decimal places,
  fixed units), to always include a non-breaking space between the number and unit, and to use
  consistent rounding (always 1 decimal place by default).
98
* The persistent method get() now returns the correct type for each property defined in the persistent class.
99
100
101
* Require pass grade criteria is now part of core.
  Refer to upgrade.php to see transitioning from similar plugin criteria to core
  Refer to completion/upgrade.txt for additional information.
102

103
104
105
106
=== 3.11.2 ===
* For security reasons, filelib has been updated so all requests now use emulated redirects.
  For this reason, manually disabling emulateredirects will no longer have any effect (and will generate a debugging message).

107
=== 3.11 ===
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
* PHPUnit has been upgraded to 9.5 (see MDL-71036 for details).
  That comes with a few changes:
  - Breaking: All the changes that were deprecated with PHPUnit 8.5
    are now removed (see the 3.10 section below).
  - Breaking: assertContains() now performs stricter comparison (like assertSame()
    does). New assertContainsEquals() has been created to provide the old
    behavior.
  - Deprecation: A number of file-related assertions have been deprecated, will
    be removed with PHPUnit 10. Alternatives for all them have been created:
      - assertNotIsReadable()         -> assertIsNotReadable()
      - assertNotIsWritable()         -> assertIsNotWritable()
      - assertDirectoryNotExists()    -> assertDirectoryDoesNotExist()
      - assertDirectoryNotIsReadable()-> assertDirectoryIsNotReadable()
      - assertDirectoryNotIsWritable()-> assertDirectoryIsNotWritable()
      - assertFileNotExists()         -> assertFileDoesNotExist()
      - assertFileNotIsReadable()     -> assertFileIsNotReadable()
      - assertFileNotIsWritable()     -> assertFileIsNotWritable()
  - Deprecation: Regexp-related assertions have been deprecated, will be
    removed with PHPUnit 10. Alternatives for all them have been created:
      - assertRegExp()     -> assertMatchesRegularExpression()
      - assertNotRegExp()  -> assertDoesNotMatchRegularExpression()
  - Deprecation: The expectException() for Notice, Warning, Deprecation and
    Error is deprecated, will be removed with PHPUnit 10. New expectations
    have been created to better define the expectation:
      - expectDeprecation() for E_DEPRECATED and E_USER_DEPRECATED.
      - expectNotice() for E_NOTICE, E_USER_NOTICE, and E_STRICT.
      - expectWarning() for E_WARNING and E_USER_WARNING.
      - expectError() for everything else.
   - Deprecation: The Mock->at() matcher has been deprecated and will be
     removed with PHPUnit 10. Switch to better, more deterministic and clearer
     matchers is recommended (->once(), ->exactly(), ->never()...).
   - Deprecation: The Mock->setMethods() method has been *silently* deprecated
     and will be removed in the future. Change uses to the new Mock->onlyMethods()
     alternative. Also, it doesn't accept "null" anymore, new default must
     be [] (empty array).
   - Mostly internal: With the raise to PHP 7.3 as lower version supported,
     various internal bits perform now stricter type checking in params and
     return values. If your tests have own-created comparators, assertions...
     they may need to be adjusted.
   - Mostly internal: The phpunit.xml schema has changed, basically removing
     the old <filter> section and replacing it with a new, less confusing
     <coverage> section. Also the elements within them have been changed:
       - <whitelist> has been replaced by <include>.
       - <exclude> is not a child of <whitelist> anymore, but of <coverage>.
     Note that this only will affect if you've custom phpunit.xml files
     instead of using the automatically generated ones by Moodle.
   - Deprecation: Related to the previous point, the $whitelistxxx properties
     used by the coverage.php files have been deprecated (will continue
     working until Moodle 4.3) to follow the same pattern:
       - whitelistfolders -> includelistfolders
       - whitelistfiles   -> includelistfiles
   - Internal: Custom autoloaders are deprecated and will be removed with
     PHPUnit 10. Hence we have removed our one already.
     Note that it was not useful since PHPUnit 8.5, where the ability
     to run tests by class name was removed.
   - Warning: Because of some new restrictions about how test files and
     test classes must be named (that Moodle haven't followed ever) it's not
     possible to run individual test files any more. Use any of the alternative
     execution methods (filter, suite, config) to specify which tests
     you want to run. This will be hopefully fixed in MDL-71049
     once it has been agreed which the best way to proceed is.
169
* The horde library has been updated to version 5.2.23.
170
171
* New optional parameter $extracontent for print_collapsible_region_start(). This allows developers to add interactive HTML elements
  (e.g. a help icon) after the collapsible region's toggle link.
172
* Final deprecation i_dock_block() in behat_deprecated.php
173
174
* Final deprecation of get_courses_page. Function has been removed and core_course_category::get_courses() should be
  used instead.
175
176
177
178
* New encryption API in \core\encryption allows secure encryption and decryption of data. By
  default the key is stored in moodledata but admins can configure a different, more secure
  location in config.php if required. To get the best possible security for this feature, we
  recommend enabling the Sodium PHP extension.
179
180
  The OpenSSL alternative for this API, used when Sodium is not available, is considered deprecated
  at all effects, and will be removed in Moodle 4.2. See MDL-71421 for more information.
181
* Behat timeout constants behat_base::TIMEOUT, EXTENDED_TIMEOUT, and REDUCED_TIMEOUT, which were deprecated in 3.7, have been removed.
182
183
* \core_table\local\filter\filterset::JOINTYPE_DEFAULT is being changed from 1 (ANY) to 2 (ALL). Filterset implementations
  can override the default filterset join type by overriding \core_table\local\filter\filterset::get_join_type() instead.
184
* HTMLPurifier has been upgraded to the latest version - 4.13.0
185
* Markdown lib has been upgraded to the latest version - 1.9.0
186
* The minify lib has been upgraded to 1.3.63 and pathconvertor to 1.1.3
187
188
* A new optional parameter `$sort` has been added to all `$context->get_capabilities()` methods to be able to define order of
  returned capability array.
189
* Spout has been upgraded to the latest version - 3.1.0
190
* emoji-data has been upgraded to 6.0.0.
191
192
* The final deprecation of /message/defaultoutputs.php file and admin_page_defaultmessageoutputs.
  All their settings moved to admin/message.php (see MDL-64495). Please use admin_page_managemessageoutputs class instead.
193
194
195
* Behat now supports date selection from the date form element. Examples:
    - I set the field "<field_string>" to "##15 March 2021##"
    - I set the field "<field_string>" to "##first day of January last year##"
196
197
198
* Behat now supports date and time selection from the datetime form element. Examples:
    - I set the field "<field_string>" to "##15 March 2021 08:15##"
    - I set the field "<field_string>" to "##first day of January last year noon##"
199
* New DML driver method `$DB->sql_group_concat` for performing group concatenation of a field within a SQL query
200
201
* Added new class, AMD modules and WS that allow displaying forms in modal popups or load and submit in AJAX requests.
  See https://docs.moodle.org/dev/Modal_and_AJAX_forms for more details.
202
203
204
205
206
207
208
209
210
* New base class for defining an activity's custom completion requirements: \core_completion\activity_custom_completion.
  Activity module plugins that define custom completion conditions should implement a mod_[modname]\completion\custom_completion
  subclass and the following methods:
  - get_state(): Provides the completion state for a given custom completion rule.
  - get_defined_custom_rules(): Returns an array of the activity module's custom completion rules.
    e.g. ['completionsubmit']
  - get_custom_rule_descriptions(): Returns an associative array with values containing the user-facing textual description
    of the custom completion rules (which serve as the keys to these values).
    e.g. ['completionsubmit' => 'Must submit']
211
212
213
  - get_sort_order(): Returns an array listing the order the activity module's completion rules should be displayed to the user,
    including both custom completion and relevant core completion rules
    e.g. ['completionview', 'completionsubmit', 'completionusegrade']
214
215
* Admin setting admin_setting_configmulticheckbox now supports lazy-loading the options list by
  supplying a callback function instead of an array of options.
216
* A new core API class \core_user\fields provides ways to get lists of user fields, and SQL related to
217
218
219
  those fields. This replaces existing functions get_extra_user_fields(), get_extra_user_fields_sql(),
  get_user_field_name(), get_all_user_name_fields(), and user_picture::fields(), which have all been
  deprecated.
220
221
222
* Allow plugins to augment the curl security helper via callback. The plugin's function has to be defined as
  plugintype_pluginname_curl_security_helper in pluginname/lib.php file and the function should return a plugin's security
  helper instance.
223
224
225
* The behat transformation 'string time to timestamp' no longer supports datetime format. If provided, the format must
  be strftime compatible. Example:
    - I should see "##tomorrow noon##%A, %d %B %Y, %I:%M %p##"
226
227
* External functions implementation classes should use 'execute' as the method name, in which case the
  'methodname' property should not be specified in db/services.php file.
228
229
* The core_grades_create_gradecategory webservice has been deprecated in favour of core_grades_create_gradecategories, which is
  functionally identical but allows for parallel gradecategory creations by supplying a data array to the webservice.
230
231
232
233
* The signature of the get_context_name() function in the abstract class context and all extending classes (such as context_course)
  has been extended. The new parameter allows the to get the name without escaped characters.
* The signature of the question_category_options() has been extended. The new parameter allows the to get the categories name
  in the returned array without escaped characters.
234
235
* The \core\hub\site_registration_form::add_select_with_email() method has been deprecated in favour of
  \core\hub\site_registration_form::add_checkbox_with_email().
236

237
=== 3.10 ===
238
* PHPUnit has been upgraded to 8.5. That comes with a few changes:
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
  - Breaking change: All the "template methods" (setUp(), tearDown()...) now require to return void. This implies
    that the minimum version of PHP able to run tests will be PHP 7.1
  - A good number of assertions have been deprecated with this version
    and will be removed in a future one. In core all cases have been removed
    (so it's deprecation-warnings free). It's recommended to perform the
    switch to their new counterparts ASAP:
      - assertInternalType() has been deprecated. Use the assertIsXXX() methods instead.
      - assertArraySubset() has been deprecated. Use looping + assertArrayHasKey() or similar.
      - @expectedExceptionXXX annotations have been deprecated. Use the expectExceptionXXX()
        methods instead (and put them exactly before the line that is expected to throw the exception).
      - assertAttributeXXX() have been deprecated. If testing public attributes use normal assertions. If
        testing non-public attributes... you're doing something wrong :-)
      - assertContains() to find substrings on strings has been deprecated. Use assertStringContainsString() instead.
        (note that there are "IgnoringCase()" variants to perform case-insensitive matching.
      - assertEquals() extra params have been deprecated and new assertions for them created:
        - delta => use assertEqualsWithDelta()
        - canonicalize => use assertEqualsCanonicalizing()
        - ignoreCase => use assertEqualsIgnoringCase()
        - maxDepth => removed without replacement.
  - The custom printer that was used to show how to rerun a failure has been removed, it was old and "hacky"
    solution, for more information about how to run tests, see the docs, there are plenty of options.
260
261
262
263
264
265
266
267
268
269
270
  - phpunit/dbunit is not available any more and it has been replaced by a lightweight phpunit_dataset class, able to
    load XML/CSV and PHP arrays, send the to database and return rows to calling code (in tests). That implies the
    follwoing changes in the advanced_testcase class:
      - createFlatXMLDataSet() has been removed. No uses in core, uses can switch to createXMLDataSet() (read below).
      - createXMLDataSet() has been deprecated. Use dataset_from_files() instead.
      - createCsvDataSet() has been deprecated. Use dataset_from_files() instead.
      - createArrayDataSet() has been deprecated. This method was using the phpunit_ArrayDataSet class
        that has been also removed from core. Use dataset_from_array() instead.
      - loadDataSet() has been deprecated. Use phpunit_dataset->to_database() instead.
      - All the previous uses of phpunit/dbunit methods like Dataset:getRows(), Dataset::getRowCount()
        must be replaced by the new phpunit_dataset->get_rows() method.
271
* Retains the source course id when a course is copied from another course on the same site.
272
273
274
275
* Added function setScrollable in core/modal. This function can be used to set the modal's body to be scrollable or not
  when the modal's height exceeds the browser's height. This is also supported in core/modal_factory through the
  'scrollable' config parameter which can be set to either true or false. If not explicitly defined, the default value
  of 'scrollable' is true.
276
277
* The `$CFG->behat_retart_browser_after` configuration setting has been removed.
  The browser session is now restarted between all tests.
278
* add_to_log() has been through final deprecation, please rewrite your code to the new events API.
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
* The following functions have been finally deprecated and can not be used anymore:
  - print_textarea
  - calendar_get_all_allowed_types
  - groups_get_all_groups_for_courses
  - events_get_cached
  - events_uninstall
  - events_cleanup
  - events_dequeue
  - events_get_handlers
  - get_roles_on_exact_context
  - get_roles_with_assignment_on_context
  - message_add_contact
  - message_remove_contact
  - message_unblock_contact
  - message_block_contact
  - message_get_contact
295
296
297
* The following renamed classes have been completely removed:
    - course_in_list (now: core_course_list_element)
    - coursecat (now: core_course_category)
298
* The form element 'htmleditor', which was deprecated in 3.6, has been removed.
299
300
* The `core_output_load_fontawesome_icon_map` web service has been deprecated and replaced by
  `core_output_load_fontawesome_icon_system_map` which takes the name of the theme to generate the icon system map for.
301
302
* A new parameter `$rolenamedisplay` has been added to `get_viewable_roles()` and `get_switchable_roles` to define how role names
  should be returned.
303
* The class coursecat_sortable_records has been removed.
304
305
* Admin setting admin_setting_configselect now supports lazy-loading the options list by supplying
  a callback function instead of an array of options.
306
307
* Admin setting admin_setting_configselect now supports validating the selection by supplying a
  callback function.
308
309
310
* The task system has new functions adhoc_task_starting() and scheduled_task_starting() which must
  be called before executing a task, and a new function \core\task\manager::get_running_tasks()
  returns information about currently-running tasks.
311
* New library function rename_to_unused_name() to rename a file within its current location.
312
313
* Constant \core_h5p\file_storage::EDITOR_FILEAREA has been deprecated
  because it's not required any more.
314
* The ZipStream-PHP library has been added to Moodle core in /lib/zipstream.
315
* The php-enum library has been added to Moodle core in /lib/php-enum.
316
* The http-message library has been added to Moodle core in /lib/http-message.
317
318
* Methods `filetypes_util::is_whitelisted()` and `filetypes_util::get_not_whitelisted()` have been deprecated and
  renamed to `is_listed()` and `get_not_listed()` respectively.
319
320
* Method `mustache_helper_collection::strip_blacklisted_helpers()` has been deprecated and renamed to
  `strip_disallowed_helpers()`.
321
322
* A new admin externalpage type `\core_admin\local\externalpage\accesscallback` for use in plugin settings is available that allows
  a callback to be provided to determine whether page can be accessed.
323
* New setting $CFG->localtempdir overrides which defaults to sys_get_temp_dir()
324
* Function redirect() now emits a line of backtrace into the X-Redirect-By header when debugging is on
325
326
* New DML function $DB->delete_records_subquery() to delete records based on a subquery in a way
  that will work across databases.
327
* Add support for email DKIM signatures via $CFG->emaildkimselector
328

329
=== 3.9 ===
330
331
332
333
334
335
336
* Following function has been deprecated, please use \core\task\manager::run_from_cli().
    - cron_run_single_task()
* Following class has been deprecated, please use \core\task\manager.
    - \tool_task\run_from_cli
* Following CLI scripts has been deprecated:
  - admin/tool/task/cli/schedule_task.php please use admin/cli/scheduled_task.php
  - admin/tool/task/cli/adhoc_task.php please use admin/cli/adhoc_task.php
337
338
* Old Safe Exam Browser quiz access rule (quizaccess_safebrowser) replaced by new Safe Exam Browser access rule (quizaccess_seb).
  Experimental setting enablesafebrowserintegration was deleted.
339
* New CFPropertyList library has been added to Moodle core in /lib/plist.
340
341
* behat_data_generators::the_following_exist() has been removed, please use
  behat_data_generators::the_following_entities_exist() instead. See MDL-67691 for more info.
342
343
* admin/tool/task/cli/adhoc_task.php now observers the concurrency limits.
  If you want to get the previous (unlimited) behavior, use the --ignorelimits switch).
344
* Removed the following deprecated functions:
345
346
  - question_add_tops
  - question_is_only_toplevel_category_in_context
347
348
* format_float() now accepts a special value (-1) as the $decimalpoints parameter
  which means auto-detecting number of decimal points.
349
350
* plagiarism_save_form_elements() has been deprecated. Please use {plugin name}_coursemodule_edit_post_actions() instead.
* plagiarism_get_form_elements_module() has been deprecated. Please use {plugin name}_coursemodule_standard_elements() instead.
351
* Changed default sessiontimeout to 8 hours to cover most normal working days
352
353
354
355
356
357
358
* Plugins can now explicitly declare supported and incompatible Moodle versions in version.php
  - $plugin->supported = [37,39];
    supported takes an array of ascending numbers, that correspond to a range of branch numbers of supported versions, inclusive.
    Moodle versions that are outside of this range will produce a message notifying at install time, but will allow for installation.
  - $plugin->incompatible = 36;
    incompatible takes a single int corresponding to the first incompatible branch. Any Moodle versions including and
    above this will be prevented from installing the plugin, and a message will be given when attempting installation.
359
* Added the <component>_bulk_user_actions() callback which returns a list of custom action_links objects
360
361
362
363
364
365
* Add 'required' admin flag for mod forms allows elements to be toggled between being required or not in admin settings.
  - In mod settings, along with lock, advanced flags, the required flag can now be set with $setting->set_required_flag_options().
    The name of the admin setting must be exactly the same as the mod_form element.
  - Currently supported by:
    - mod_assign
    - mod_quiz
366
* Added a native MySQL / MariaDB lock implementation
367
368
* The database drivers (moodle_database and subclasses) don't need to implement get_columns() anymore.
  They have to implement fetch_columns instead.
369
* Added function cleanup_after_drop to the database_manager class to take care of all the cleanups that need to be done after a table is dropped.
370
* The 'xxxx_check_password_policy' callback now only fires if $CFG->passwordpolicy is true
371
* grade_item::update_final_grade() can now take an optional parameter to set the grade->timemodified. If not present the current time will carry on being used.
372
* lib/outputrequirementslib::get_jsrev now is public, it can be called from other classes.
373
* H5P libraries have been moved from /lib/h5p to h5p/h5plib as an h5plib plugintype.
374
375
* mdn-polyfills has been renamed to polyfills. The reason there is no polyfill from the MDN is
  because there is no example polyfills on the MDN for this functionality.
376
377
378
379
* AJAX pages can be called without requiring a session lock if they set READ_ONLY_SESSION to true, eg.
  define('READ_ONLY_SESSION', true); Note - this also requires $CFG->enable_read_only_sessions to be set to true.
* External functions can be called without requiring a session lock if they define 'readonlysession' => true in
  db/services.php. Note - this also requires $CFG->enable_read_only_sessions to be set to true.
380
* database_manager::check_database_schema() now checks for missing and extra indexes.
381
* Implement a more direct xsendfile_file() method for an alternative_file_system_class
382
383
* A new `dynamic` table interface has been defined, which allows any `flexible_table` to be converted into a table which
  is updatable via ajax calls. See MDL-68495 and `\core_table\dynamic` for further information.
384
385
386
* The core/notification module has been updated to use AMD modals for its confirmation and alert dialogues.
  The confirmation dialogue no longer has a configurable "No" button as per similar changes in MDL-59759.
  This set of confirmation modals was unintentionally missed from that deprecation process.
387
* The download_as_dataformat() method has been deprecated. Please use \core\dataformat::download_data() instead
388
389
390
* The following functions have been updated to support passing in an array of group IDs (but still support passing in a single ID):
  * groups_get_members_join()
  * groups_get_members_ids_sql()
391
392
393
394
* Additional parameters were added to core_get_user_dates:
    - type: specifies the calendar type. Optional, defaults to Gregorian.
    - fixday: Whether to remove leading zero for day. Optional, defaults to 1.
    - fixhour: Whether to remove leading zero for hour. Optional, defaults to 1.
395
* Legacy cron has been deprecated and will be removed in Moodle 4.1. This includes the functions:
396
397
398
  - cron_execute_plugin_type()
  - cron_bc_hack_plugin_functions()
  Please, use the Task API instead: https://docs.moodle.org/dev/Task_API
399
400
401
402
403
404
405
406
407
408
409
410
411
412
* Introduce new hooks for plugin developers:
    - <component>_can_course_category_delete($category)
    - <component>_can_course_category_delete_move($category, $newcategory)
  These hooks allow plugin developers greater control over category deletion. Plugin can return false in those
  functions if category deletion or deletion with content move to the new parent category is not permitted.
  Both $category and $newcategory params are instances of core_course_category class.
    - <component>_pre_course_category_delete_move($category, $newcategory)
  This hook is expanding functionality of existing <component>_pre_course_category_delete hook and allow plugin developers
  to execute code prior to category deletion when its content is moved to another category.
  Both $category and $newcategory params are instances of core_course_category class.
    - <component>_get_course_category_contents($category)
  This hook allow plugin developers to add information that is displayed on category deletion form. Function should
  return string, which will be added to the list of category contents shown on the form. $category param is an instance
  of core_course_category class.
413
* Data generator create_user in both unittests and behat now validates user fields and triggers user_created event
414

415
=== 3.8 ===
416
* Add CLI option to notify all cron tasks to stop: admin/cli/cron.php --stop
417
* The rotate_image function has been added to the stored_file class (MDL-63349)
418
* The yui checknet module is removed. Call \core\session\manager::keepalive instead.
419
* The generate_uuid() function has been deprecated. Please use \core\uuid::generate() instead.
420
* Remove lib/pear/auth/RADIUS.php (MDL-65746)
421
* Core components are now defined in /lib/components.json instead of coded into /lib/classes/component.php
422
* Subplugins should now be defined using /db/subplugins.json instead of /db/subplugins.php
423
424
425
426
* The following functions have been finally deprecated and can not be used anymore:
    * allow_override()
    * allow_assign()
    * allow_switch()
427
428
    * https_required()
    * verify_https_required()
429
* Remove duplicate font-awesome SCSS, Please see /theme/boost/scss/fontawesome for usage (MDL-65936)
430
* Remove lib/pear/Crypt/CHAP.php (MDL-65747)
431
432
433
434
* New output component available: \core\output\checkbox_toggleall
  - This allows developers to easily output groups of checkboxes that can be toggled by master controls in the form of a checkbox or
    a button. Action elements which perform actions on the selected checkboxes can also be enabled/disabled depending on whether
    at least a single checkbox item is selected or not.
435
* Final deprecation (removal) of the core/modal_confirm dialogue.
436
* Upgrade scssphp to v1.0.2, This involves renaming classes from Leafo => ScssPhp as the repo has changed.
437
438
* Implement supports_xsendfile() method and allow support for xsendfile in alternative_file_system_class
  independently of local files (MDL-66304).
439
440
* The methods get_local_path_from_storedfile and get_remote_path_from_storedfile in lib/filestore/file_system.php
  are now public. If you are overriding these then you will need to change your methods to public in your class.
441
442
443
444
445
446
447
448
449
450
451
* It is now possible to use sub-directories for AMD modules.
  The standard rules for Level 2 namespaces also apply to AMD modules.
  The sub-directory used must be either an valid component, or placed inside a 'local' directory to ensure that it does not conflict with other components.

    The following are all valid module names and locations in your plugin:
      mod_forum/view: mod/forum/amd/src/view.js
      mod_forum/local/views/post: mod/forum/amd/src/local/views/post
      mod_forum/form/checkbox-toggle: mod/forum/amd/src/form/checkbox-toggle.js

    The following are all invalid module names and locations in your plugin:
      mod_forum/views/post: mod/forum/amd/src/views/post
452
453
* The 'xxxx_check_password_policy' method now has an extra parameter: $user. It contains the user object to perform password
validation against and defaults to null (so, no user needed) if not provided.
454
455
456
457
458
459
460
461
* It is now possible to use sub-directories when creating mustache templates.
  The standard rules for Level 2 namespaces also apply to templates.
  The sub-directory used must be either an valid component, or placed inside a 'local' directory to ensure that it does not conflict with other components.

    The following are all valid template names and locations in your plugin:
      mod_forum/forum_post: mod/forum/templates/forum_post.mustache
      mod_forum/local/post/user: mod/forum/templates/local/post/user.mustache
      mod_forum/form/checkbox_toggle: mod/forum/templates/form/checkbox_toggle.mustache
462

463
464
    The following are _invalid_ template names and locations:
      mod_forum/post/user: mod/forum/templates/local/post/user.mustache
465
466
* Following behat steps have been removed from core:
    - I go to "<gradepath_string>" in the course gradebook
467
* A new admin setting widget 'core_admin\local\settings\filesize' is added.
468
* Core capabilities 'moodle/community:add' and 'moodle/community:download' have been removed from core as part of Moodle.net sunsetting.
469
470
471
472
473
474
475
* As part of Moodle.net sunsetting process the following hub api functions have been deprecated:
    - get_courses
    - unregister_courses
    - register_course
    - add_screenshot
    - download_course_backup
    - upload_course_backup
476
477
478
* A new setting 'Cache templates' was added (see MDL-66367). This setting determines if templates are cached or not.
  This setting can be set via the UI or by defining $CFG->cachetemplates in your config.php file. It is a boolean
  and should be set to either false or true. Developers will probably want to set this to false.
479
* The core_enrol_edit_user_enrolment webservice has been deprecated. Please use core_enrol_submit_user_enrolment_form instead.
480
* \single_button constructor has a new attributes param to add attributes to the button HTML tag.
481
* Improved url matching behaviour for profiled urls and excluded urls
482
* Attempting to use xsendfile via the 3rd param of readstring_accel() is now ignored.
483
484
* New H5P libraries have been added to Moodle core in /lib/h5p.
* New H5P core subsystem have been added.
485
486
487
488
* Introduced new callback for plugin developers '<component>_get_path_from_pluginfile($filearea, $args)': This will return
the itemid and filepath for the filearea and path defined in $args. It has been added in order to get the correct itemid and
filepath because some components, such as mod_page or mod_resource, add the revision to the URL where the itemid should be placed
(to prevent caching problems), but then they don't store it in database.
489
490
491
492
493
494
495
* New utility function \core_form\util::form_download_complete should be called if your code sends
  a file with Content-Disposition: Attachment in response to a Moodle form submit button (to ensure
  that disabled submit buttons get re-enabled in that case). It is automatically called by the
  filelib.php send_xx functions.
* If you have a form which sends a file in response to a Moodle form submit button, but you cannot
  call the above function because the file is sent by a third party library, then you should add
  the attribute data-double-submit-protection="off" to your form.
496

497
=== 3.7 ===
498

499
* Nodes in the navigation api can have labels for each group. See set/get_collectionlabel().
500
* The method core_user::is_real_user() now returns false for userid = 0 parameter
501
502
* 'mform1' dependencies (in themes, js...) will stop working because a randomly generated string has been added to the id
attribute on forms to avoid collisions in forms loaded in AJAX requests.
503
504
* A new method to allow queueing or rescheduling of an existing scheduled task was added. This allows an existing task
  to be updated or queued as required. This new functionality can be found in \core\task\manager::reschedule_or_queue_adhoc_task.
505
* 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.
506
* 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.
507
508
509
510
* The \core_rating provider's get_sql_join function now accepts an optional $innerjoin parameter.
  It is recommended that privacy providers using this function call rewrite any long query into a number of separate
  calls to add_from_sql for improved performance, and that the new argument is used.
  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.
511
512
* /message/defaultoutputs.php file and admin_page_defaultmessageoutputs class have been deprecated
  and all their settings moved to admin/message.php (see MDL-64495). Please use admin_page_managemessageoutputs class instead.
513
514
* A new parameter $lang has been added to mustache_template_source_loader->load_with_dependencies() method
  so it is possible for Mustache to request string in a specific language.
515
516
517
* Behat timeout constants behat_base::TIMEOUT, EXTENDED_TIMEOUT, and REDUCED_TIMEOUT have been
  deprecated. Please instead use the functions behat_base::get_timeout(), get_extended_timeout(),
  and get_reduced_timeout(). These allow for timeouts to be increased by a setting in config.php.
518
519
* The $draftitemid parameter of file_save_draft_area_files() function now supports the constant IGNORE_FILE_MERGE:
  When the parameter is set to that constant, the function won't process file merging, keeping the original state of the file area.
520
  Notice also than when $text is set, pluginfile rewrite won't be processed so the text will not be modified.
521
522
* Introduced new callback for plugin developers '<component>_pre_processor_message_send($procname, $proceventdata)':
  This will allow any plugin to manipulate messages or notifications before they are sent by a processor (email, mobile...)
523
* New capability 'moodle/category:viewcourselist' in category context that controls whether user is able to browse list of courses
524
525
526
  in this category. To work with list of courses use API methods in core_course_category and also 'course' form element.
* It is possible to pass additional conditions to get_courses_search();
  core_course_category::search_courses() now allows to search only among courses with completion enabled.
527
* Add support for a new xxx_after_require_login callback
528
529
530
531
532
533
534
535
* A new conversation type has been created for self-conversations. During the upgrading process:
  - Firstly, the existing self-conversations will be starred and migrated to the new type, removing the duplicated members in the
  message_conversation_members table.
  - Secondly, the legacy self conversations will be migrated from the legacy 'message_read' table. They will be created using the
  new conversation type and will be favourited.
  - Finally, the self-conversations for all remaining users without them will be created and starred.
Besides, from now, a self-conversation will be created and starred by default to all the new users (even when $CFG->messaging
is disabled).
536
537
538
* New optional parameter $throwexception for \get_complete_user_data(). If true, an exception will be thrown when there's no
  matching record found or when there are multiple records found for the given field value. If false, it will simply return false.
  Defaults to false when not set.
539
* Exposed submit button to allow custom styling (via customclassoverride variable) which can override btn-primary/btn-secondary classes
540
541
542
543
544
545
* `$includetoken` parameter type has been changed. Now supports:
   boolean: False indicates to not include the token, true indicates to generate a token for the current user ($USER).
   integer: Indicates to generate a token for the user whose id is the integer value.
* The following functions have been updated to support the new usage:
    - make_pluginfile_url
    - file_rewrite_pluginfile_urls
546
* New mform element 'float' handles localised floating point numbers.
547

548
549
=== 3.6 ===

550
551
552
553
554
555
* A new token-based version of pluginfile.php has been added which can be used for out-of-session file serving by
  setting the `$includetoken` parameter to true on the `moodle_url::make_pluginfile_url()`, and
  `moodle_url::make_file_url()` functions.
* The following picture functions have been updated to support use of the new token-based file serving:
    - print_group_picture
    - get_group_picture_url
556
557
* The `user_picture` class has a new public `$includetoken` property which can be set to make use of the new token-based
  file serving.
558
* Custom AJAX handlers for the form autocomplete fields can now optionally return string in their processResults()
559
  callback. If a string is returned, it is displayed instead of the list of suggested items. This can be used, for
560
  example, to inform the user that there are too many items matching the current search criteria.
561
* The form element 'htmleditor' has been deprecated. Please use the 'editor' element instead.
562
* The print_textarea() function has been deprecated. Please use $OUTPUT->print_textarea() instead.
563
* The following functions have been finally deprecated and can not be used any more:
564
565
    - external_function_info()
    - core_renderer::update_module_button()
566
567
568
569
570
571
572
573
574
575
    - events_trigger()
    - events_cron()
    - events_dispatch()
    - events_is_registered()
    - events_load_def()
    - events_pending_count()
    - events_process_queued_handler()
    - events_queue_handler()
    - events_trigger_legacy()
    - events_update_definition()
576
577
578
579
580
581
    - get_file_url()
    - course_get_cm_rename_action()
    - course_scale_used()
    - site_scale_used()
    - clam_message_admins()
    - get_clam_error_code()
582
583
584
585
586
587
588
589
590
591
592
593
    - get_records_csv()
    - put_records_csv()
    - print_log()
    - print_mnet_log()
    - print_log_csv()
    - print_log_xls()
    - print_log_ods()
    - build_logs_array()
    - get_logs_usercourse()
    - get_logs_userday()
    - get_logs()
    - prevent_form_autofill_password()
594
    - prefixed_tablenode_transformations()
595
596
    - core_media_renderer
    - core_media
597
598
599
600
601
602
603
604
605
606
* Following api's have been removed in behat_config_manager, please use behat_config_util instead.
    - get_features_with_tags()
    - get_components_steps_definitions()
    - get_config_file_contents()
    - merge_behat_config()
    - get_behat_profile()
    - profile_guided_allocate()
    - merge_config()
    - clean_path()
    - get_behat_tests_path()
607
608
609
* Following behat steps have been removed from core:
    - I set the field "<field_string>" to multiline
    - I follow "<link_string>"" in the open menu
610
611
612
613
614
615
616
617
618
619
620
* The following behat steps have been deprecated, please do not use these step definitions any more:
    - behat_navigation.php: i_navigate_to_node_in()
    - theme/boost/tests/behat/behat_theme_boost_behat_navigation.php: i_navigate_to_node_in()
  Use one of the following steps instead:
    - I navigate to "PATH > ITEM" in current page administration
    - I navigate to "PATH > ITEM" in site administration
    - I navigate to course participants
    - I navigate to "TAB1 > TAB2" in the course gradebook
  If some items are not available without Navigation block at all, one can use combination of:
    - I add the "Navigation" block if not present
    - I click on "LINK" "link" in the "Navigation" "block"
621
622
* The core\session\util class has been removed. This contained one function only used by the memcached class which has
  been moved there instead (connection_string_to_memcache_servers).
623
* Removed the lib/password_compat/lib/password.php file.
624
625
626
627
628
629
* The eventslib.php file has been deleted and its functions have been moved to deprecatedlib.php. The affected functions are:
  - events_get_cached()
  - events_uninstall()
  - events_cleanup()
  - events_dequeue()
  - events_get_handlers()
630
631
* coursecat::get() now has optional $user parameter.
* coursecat::is_uservisible() now has optional $user parameter.
632
* Removed the lib/form/submitlink.php element which was deprecated in 3.2.
633
634
635
636
* The user_selector classes do not support custom list of extra identity fields any more. They obey the configured user
  policy and respect the privacy setting made by site administrators. The list of user identifiers should never be
  hard-coded. Instead, the setting $CFG->showuseridentity should be always respected, which has always been the default
  behaviour (MDL-59847).
637
638
639
640
* The function message_send() in messagelib.php will now only take the object \core\message\message as a parameter.
* The method message_sent::create_from_ids() parameter courseid is now required. A debugging
  message was previously displayed, and the SITEID was used, when not provided.
* The method \core\message\manager::send_message() now only takes the object \core\message\message as the first parameter.
641
642
643
* Following functions have been deprecated, please use get_roles_used_in_context.
    - get_roles_on_exact_context()
    - get_roles_with_assignment_on_context()
644
* New functions to support the merging of user draft areas from the interface; see MDL-45170 for details:
jun's avatar
jun committed
645
646
647
648
  - file_copy_file_to_file_area()
  - file_merge_draft_areas()
  - file_replace_file_area_in_text()
  - extract_draft_file_urls_from_text()
649
650
* Class coursecat is now alias to autoloaded class core_course_category, course_in_list is an alias to
  core_course_list_element, class coursecat_sortable_records is deprecated without replacement.
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
* \core_user_external::create_users() and \core_user_external::update_users() can now accept more user profile fields so user
  creation/update via web service can now be very similar to the edit profile page's functionality. The new fields that have been
  added are:
  - maildisplay
  - interests
  - url
  - icq
  - skype
  - aim
  - yahoo
  - msn
  - institution
  - department
  - phone1
  - phone2
  - address
667
668
669
* New function mark_user_dirty() must be called after changing data that gets cached in user sessions. Examples:
  - Assigning roles to users.
  - Unassigning roles from users.
670
671
  - Enrolling users into courses.
  - Unenrolling users from courses.
672
673
674
* New optional parameter $context for the groups_get_members_join() function and ability to filter users that are not members of
any group. Besides, groups_get_members_ids_sql, get_enrolled_sql and get_enrolled_users now accepts -1 (USERSWITHOUTGROUP) for
the groupid field.
675
676
* Added $CFG->conversionattemptlimit setting to config.php allowing a maximum number of retries before giving up conversion
  of a given document by the assignfeedback_editpdf\task\convert_submissions task. Default value: 3.
677
678
679
680
681
* The following events have been deprecated and should not be used any more:
  - message_contact_blocked
  - message_contact_unblocked
  The reason for this is because you can now block/unblock users without them necessarily being a contact. These events
  have been replaced with message_user_blocked and message_user_unblocked respectively.
682
683
684
* The event message_deleted has been changed, it no longer records the value of the 'useridto' due to
  the introduction of group messaging. Please, if you have any observers or are triggering this event
  in your code you will have to make some changes!
685
686
687
688
689
690
691
692
693
694
* The gradebook now supports the ability to accept files as feedback. This can be achieved by adding
  'feedbackfiles' to the $grades parameter passed to grade_update().
    For example -
        $grades['feedbackfiles'] = [
            'contextid' => 1,
            'component' => 'mod_xyz',
            'filearea' => 'mod_xyz_feedback',
            'itemid' => 2
        ];
  These files will be then copied to the gradebook file area.
695
696
697
698
699
700
701
702
703
704
705
* Allow users to choose who can message them for privacy reasons, with a 'growing circle of contactability':
  - Added $CFG->messagingallusers, for enabling messaging to all site users. Default value: 0.
    When $CFG->messagingallusers = false users can choose being contacted by only contacts or contacts and users sharing a course with them.
    In that case, the default user preference is MESSAGE_PRIVACY_COURSEMEMBER (users sharing a course).
    When $CFG->messagingallusers = true users have a new option for the privacy messaging preferences: "Anyone on the site". In that case,
    the default user preference is MESSAGE_PRIVACY_SITE (all site users).
  - Added $CFG->keepmessagingallusersenabled setting to config.php to force enabling $CFG->messagingallusers during the upgrading process.
    Default value: 0.
    When $CFG->keepmessagingallusersenabled is set to true, $CFG->messagingallusers will be also set to true to enable messaging site users.
    However, when it is empty, $CFG->messagingallusers will be disabled during the upgrading process, so the users will only be able to
    message contacts and users sharing a course with them.
706
707
708
709
710
711
* There has been interface and functional changes to admin_apply_default_settings() (/lib/adminlib.php).  The function now takes two
  additional optional parameters, $admindefaultsettings and $settingsoutput.  It also has a return value $settingsoutput.
  The function now does not need to be called twice to ensure all default settings are set.  Instead the function calls itself recursively
  until all settings have been set. The additional parameters are used recursively and shouldn't be need to be explicitly passed in when calling
  the function from other parts of Moodle.
  The return value: $settingsoutput is an array of setting names and the values that were set by the function.
712
* Webservices no longer update the lastaccess time for a user in a course. Call core_course_view_course() manually if needed.
713
* 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.
714

715
716
=== 3.5 ===

717
718
719
720
* There is a new privacy API that every subsystem and plugin has to implement so that the site can become GDPR
  compliant. Plugins use this API to report what information they store or process regarding users, and provide ability
  to export and delete personal data. See https://docs.moodle.org/dev/Privacy_API for guidelines on how to implement the
  privacy API in your plugin.
721
* The cron runner now sets up a fresh PAGE and OUTPUT between each task.
722
723
* The core_renderer methods notify_problem(), notify_success(), notify_message() and notify_redirect() that were
  deprecated in Moodle 3.1 have been removed. Use \core\notification::add(), or \core\output\notification as required.
724
725
726
* The maximum supported precision (the total number of digits) for XMLDB_TYPE_NUMBER ("number") fields raised from 20 to
  38 digits. Additionally, the whole number part (precision minus scale) must not be longer than the maximum length of
  integer fields (20 digits). Note that PHP floats commonly support precision of roughly 15 digits only (MDL-32113).
727
728
729
* Event triggering and event handlers:
    - The following events, deprecated since moodle 2.6, have been finally removed: groups_members_removed,
      groups_groupings_groups_removed, groups_groups_deleted, groups_groupings_deleted.
730
731
* The following functions have been finally deprecated and can not be used any more:
  - notify()
732
733
* XMLDB now validates the PATH attribute on every install.xml file. Both the XMLDB editor and installation will fail
  when a problem is detected with it. Please ensure your plugins contain correct directory relative paths.
734
* Add recaptchalib_v2.php for support of reCAPTCHA v2.
735
736
737
* Plugins can define class 'PLUGINNAME\privacy\local\sitepolicy\handler' if they implement an alternative mechanisms for
  site policies managements and agreements. Administrators can define which component is to be used for handling site
  policies and agreements. See https://docs.moodle.org/dev/Site_policy_handler
738
739
740
* Scripts can define a constant NO_SITEPOLICY_CHECK and set it to true before requiring the main config.php file. It
  will make the require_login() skipping the test for the user's policyagreed status. This is useful for plugins that
  act as a site policy handler.
741
742
* There is a new is_fulltext_search_supported() DML function. The default implementation returns false. This function
  is used by 'Simple search' global search engine to determine if the database full-text search capabilities can be used.
743
744
745
* The following have been removed from the list of core subsystems:
   - core_register
   - core_publish
746
747
  Following this change, \core_register_renderer and \core_publish_renderer have been removed and their methods have been
  moved to \core_admin_renderer and \core_course_renderer respectively.
748

749
=== 3.4 ===
750

751
* oauth2_client::request method has an extra parameter to specify the accept header for the response (MDL-60733)
752
753
754
755
756
757
758
* The following functions, previously used (exclusively) by upgrade steps are not available
  anymore because of the upgrade cleanup performed for this version. See MDL-57432 for more info:
    - upgrade_mimetypes()
    - upgrade_fix_missing_root_folders_draft()
    - upgrade_minmaxgrade()
    - upgrade_course_tags()

759
760
761
762
* Added new moodleform element 'filetypes' and new admin setting widget 'admin_setting_filetypes'. These new widgets
  allow users to define a list of file types; either by typing them manually or selecting them from a list. The widgets
  directly support the syntax used to feed the 'accepted_types' option of the filemanager and filepicker elements. File
  types can be specified as extensions (.jpg or just jpg), mime types (text/plain) or groups (image).
763
764
765
* Removed accesslib private functions: load_course_context(), load_role_access_by_context(), dedupe_user_access() (MDL-49398).
* Internal "accessdata" structure format has changed to improve ability to perform role definition caching (MDL-49398).
* Role definitions are no longer cached in user session (MDL-49398).
766
767
* External function core_group_external::get_activity_allowed_groups now returns an additional field: canaccessallgroups.
  It indicates whether the user will be able to access all the activity groups.
768
* file_get_draft_area_info does not sum the root folder anymore when calculating the foldercount.
769
770
771
772
* The moodleform element classes can now optionally provide a public function validateSubmitValue(). This method can be
  used to perform implicit validation of submitted values - without the need to explicitly add the validation rules to
  every form. The method should accept a single parameter with the submitted value. It should return a string with the
  eventual validation error, or an empty value if the validation passes.
773
* New user_picture attribute $includefullname to determine whether to include the user's full name with the user's picture.
774
775
776
777
778
779
780
* Enrol plugins which provide enrolment actions can now declare the following "data-action" attributes in their implementation of
  enrol_plugin::get_user_enrolment_actions() whenever applicable:
  * "editenrolment" - For editing a user'e enrolment details. Defined by constant ENROL_ACTION_EDIT.
  * "unenrol" - For unenrolling a student. Defined by constant ENROL_ACTION_UNENROL.
  These attributes enable enrol actions to be rendered via modals. If not added, clicking on the enrolment action buttons will still
  redirect the user to the appropriate enrolment action page. Though optional, it is recommended to add these attributes for a
  better user experience when performing enrol actions.
781
782
783
784
785
786
787
* The enrol_plugin::get_user_enrolment_actions() implementations for core enrol plugins have been removed and moved to
  the parent method itself. New enrol plugins don't have to implement get_user_enrolment_actions(), but just need to
  make sure that they override:
  - enrol_plugin::allow_manage(), and/or
  - enrol_plugin::allow_unenrol_user() or enrol_plugin::allow_unenrol()
  Existing enrol plugins that override enrol_plugin::get_user_enrolment_actions() don't have to do anything, but can
  also opt to remove their own implementation of the method if they basically have the same logic as the parent method.
788
789
790
791
792
793
* New optional parameter $enrolid for the following functions:
  - get_enrolled_join()
  - get_enrolled_sql()
  - get_enrolled_with_capabilities_join()
  Setting this parameter to a non-zero value will add a condition to the query such that only users that were enrolled
  with this enrolment method will be returned.
794
795
796
* New optional parameter 'closeSuggestionsOnSelect' for the enhance() function for form-autocomplete. Setting this to true will
  close the suggestions popup immediately after an option has been selected. If not specified, it defaults to true for single-select
  elements and false for multiple-select elements.
797
* user_can_view_profile() now also checks the moodle/user:viewalldetails capability.
798
799
* The core/modal_confirm dialogue has been deprecated. Please use the core/modal_save_cancel dialogue instead. Please ensure you
  update to use the ModalEvents.save and ModalEvents.cancel events instead of their yes/no counterparts.
800
801
* Instead of checking the 'moodle/course:viewparticipants' and 'moodle/site:viewparticipants' capabilities use the
  new functions course_can_view_participants() and course_require_view_participants().
802
* $stored_file->add_to_curl_request() now adds the filename to the curl request.
803
804
* The option for Login HTTPS (authentication-only SSL) has been removed
* $CFG->loginhttps is now deprecated, do not use it.
805
* $PAGE->https_required and $PAGE->verify_https_required() are now deprecated. They are no longer used and will throw a coding_exception.
806
* $CFG->httpswwwroot is now deprecated and will always result in the same value as wwwroot.
807
808
809
* Added function core_role_set_view_allowed() to check if a user should be able to see a given role.
  This should be checked whenever displaying a list of roles to a user, however, core_role_set_assign_allowed may need to override it
  in some cases.
810
* Deprecated allow_override, allow_assign and allow_switch and replaced with core_role_set_*_allowed to avoid function names conflicting.
811

812
813
814
815
816
=== 3.3.1 ===

* ldap_get_entries_moodle() now always returns lower-cased attribute names in the returned entries.
  It was suppposed to do so before, but it actually didn't.

817
=== 3.3 ===
818

819
820
* Behat compatibility changes are now being documented at
  https://docs.moodle.org/dev/Acceptance_testing/Compatibility_changes
821
822
* PHPUnit's bootstrap has been changed to use HTTPS wwwroot (https://www.example.com/moodle) from previous HTTP version. Any
  existing test expecting the old HTTP URLs will need to be switched to the new HTTPS value (reference: MDL-54901).
823
824
* The information returned by the idp list has changed. This is usually only rendered by the login page and login block.
  The icon attribute is removed and an iconurl attribute has been added.
825
* Support added for a new type of external file: FILE_CONTROLLED_LINK. This is an external file that Moodle can control
826
  the permissions. Moodle makes files read-only but can grant temporary write access.
827
828
    When accessing a URL, the info from file_browser::get_file_info will be checked to determine if the user has write access,
    if they do - the remote file will have access controls set to allow editing.
829
830
* The method moodleform::after_definition() has been added and can now be used to add some logic
  to be performed after the form's definition was set. This is useful for intermediate subclasses.
831
832
833
834
835
836
* Moodle has support for font-awesome icons. Plugins should use the xxx_get_fontawesome_icon_map callback
  to map their custom icons to one from font-awesome.
* $OUTPUT->pix_url() has been deprecated because it is was used mostly to manually generate image tags for icons.
  We now distinguish between icons and "small images". The difference is that an icon does not have to be rendered as an image tag
  with a source. It is OK to still have "small images" - if this desired use $OUTPUT->image_icon() and $OUTPUT->image_url(). For
  other uses - use $OUTPUT->pix_icon() or the pix helper in mustache templates {{#pix}}...{{/pix}}
837
  For other valid use cases use $OUTPUT->image_url().
838
* Activity icons have been split from standard icons. Use $OUTPUT->image_icon instead of $OUTPUT->pix_icon for these
839
  type of icons (the coloured main icon for each activity).
840
841
* YUI module moodle-core-formautosubmit has been removed, use jquery .change() instead (see lib/templates/url_select.mustache for
  an example)
842
843
* $mform->init_javascript_enhancement() is deprecated and no longer does anything. Existing uses of smartselect enhancement
  should be switched to the searchableselector form element or other solutions.
844
* Return value of the validate_email() is now proper boolean as documented. Previously the function could return 1, 0 or false.
845
846
847
* The mcore YUI rollup which included various YUI modules such as moodle-core-notification is no longer included on every
  page. Missing YUI depdencies may be exposed by this change (e.g. missing a requirement on moodle-core-notification when
  using M.core.dialogue).
848
849
850
851
852
853
854
855
* Various legacy javascript functions have been removed:
    * M.util.focus_login_form and M.util.focus_login_error no longer do anything. Please use jquery instead. See
      lib/templates/login.mustache for an example.
    * Some outdated global JS functions have been removed and should be replaced with calls to jquery
      or alternative approaches:
        checkall, checknone, select_all_in_element_with_id, select_all_in, deselect_all_in, confirm_if, findParentNode,
        filterByParent, stripHTML
    * M.util.init_toggle_class_on_click has been removed.
856
857
858
859
* The following functions have been deprecated and should not be used any more:
  - file_storage::try_content_recovery  - See MDL-46375 for more information
  - file_storage::content_exists        - See MDL-46375 for more information
  - file_storage::deleted_file_cleanup  - See MDL-46375 for more information
860
861
862
863
864
  - file_storage::get_converted_document
  - file_storage::is_format_supported_by_unoconv
  - file_storage::can_convert_documents
  - file_storage::send_test_pdf
  - file_storage::test_unoconv_path
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
* Following behat steps have been removed from core:
    - I click on "<element_string>" "<selector_string>" in the "<row_text_string>" table row
    - I go to notifications page
    - I add "<filename_string>" file from recent files to "<filepicker_field_string>" filepicker
    - I upload "<filepath_string>" file to "<filepicker_field_string>" filepicker
    - I create "<foldername_string>" folder in "<filepicker_field_string>" filepicker
    - I open "<foldername_string>" folder from "<filepicker_field_string>" filepicker
    - I unzip "<filename_string>" file from "<filepicker_field_string>" filepicker
    - I zip "<filename_string>" folder from "<filepicker_field_string>" filepicker
    - I delete "<file_or_folder_name_string>" from "<filepicker_field_string>" filepicker
    - I send "<message_contents_string>" message to "<username_string>"
    - I add "<user_username_string>" user to "<cohort_idnumber_string>" cohort
    - I add "<username_string>" user to "<group_name_string>" group
    - I fill in "<field_string>" with "<value_string>"
    - I select "<option_string>" from "<select_string>"
    - I select "<radio_button_string>" radio button
    - I check "<option_string>"
    - I uncheck "<option_string>"
    - the "<field_string>" field should match "<value_string>" value
    - the "<checkbox_string>" checkbox should be checked
    - the "<checkbox_string>" checkbox should not be checked
    - I fill the moodle form with:
    - "<element_string>" "<selector_string>" should exists
    - "<element_string>" "<selector_string>" should not exists
    - the following "<element_string>" exists:
890
891
* get_user_capability_course() now has an additional parameter 'limit'. This can be used to return a set number of records with
  the submitted capability. The parameter 'fieldsexceptid' will now accept context fields which can be used for preloading.
892
* The caching option 'immutable' has been added to send_stored_file() and send_file().
893
* New adhoc task refresh_mod_calendar_events_task that updates existing calendar events of modules.
894
* New 'priority' column for the event table to determine which event to show in case of events with user and group overrides.
895
* Webservices core_course_search_courses and core_course_get_courses_by_field will always return the sortorder field.
896
* core_course_external::get_activities_overview has been deprecated. Please do not call this function any more.
897
* Changed the pix mustache template helper to accept context variables for the key, component and alt text.
898
899
900
* New auth_plugin_base helper methods:
  - get_identity_providers() - Retrieves available auth identity providers.
  - prepare_identity_providers_for_output() - Prepares auth identity provider data for output (e.g. to templates, WS, etc.).
901

902
903
=== 3.2 ===

904
905
* Custom roles with access to any part of site administration that do not use the manager archetype will need
  moodle/site:configview capability added.
906
* Admin setting "Show My courses expanded on Dashboard" has been removed.
907
908
909
* Some backwards and forwards compatibility has been added for different bootstrap versions.
  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
  with bootstrap classes to keep working in the new theme. See MDL-56004 for the list of supported classes.
910
* MForms element 'submitlink' has been deprecated.
911
912
913
* Searchable selector form element is now a wrapper for autocomplete. A "No selection" option is automatically
  added to the options list for best backwards compatibility - if you were manually adding a "no selection" option you will need
  to remove it.
914
* Node.js versions >=4 are now required to run grunt.
915
916
* JQuery has been updated to 3.1.0. JQuery migrate plugins are no longer shipped - please read
  https://jquery.com/upgrade-guide/3.0/ and update your javascript.
917
* New option 'blanktarget' added to format_text. This option adds target="_blank" to links
918
919
920
921
* A new webservice structure `external_files` has been created which provides a standardised view of files in Moodle and
  should be used for all file return descriptions.
  Files matching this format can be retrieved via the new `external_util::get_area_files` method.
  See MDL-54951 for further information.
922
923
924
* The parameter $usepost of the following functions has been deprecated and is not used any more:
  - get_max_upload_file_size()
  - get_user_max_upload_file_size()
925
926
* The following classes have been removed and should not be used any more:
    - boxclient - See MDL-49599 for more information.
927
928
* The following functions have been removed and should not be used any more:
    - file_modify_html_header() - See MDL-29738 for more information.
929
* core_grades_external::get_grades has been deprecated. Please do not call this function any more.
930
  External function gradereport_user_external::get_grade_items can be used for retrieving the course grades information.
931
* New option 'escape' added to format_string. When true (default), escapes HTML entities from the string
932
933
934
* The following functions have been deprecated and are not used any more:
  - get_records_csv() Please use csv_import_reader::load_csv_content() instead.
  - put_records_csv() Please use download_as_dataformat (lib/dataformatlib.php) instead.
935
936
  - zip_files()   - See MDL-24343 for more information.
  - unzip_file()  - See MDL-24343 for more information.
937
938
939
940
941
942
943
944
945
  - print_log()           - See MDL-43681 for more information
  - print_log_csv()       - See MDL-43681 for more information
  - print_log_ods()       - See MDL-43681 for more information
  - print_log_xls()       - See MDL-43681 for more information
  - print_mnet_log()      - See MDL-43681 for more information
  - build_logs_array()    - See MDL-43681 for more information
  - get_logs()            - See MDL-43681 for more information
  - get_logs_usercourse() - See MDL-43681 for more information
  - get_logs_userday()    - See MDL-43681 for more information
946
  - prevent_form_autofill_password() Please do not use anymore.
947
* The password_compat library was removed as it is no longer required.
948
949
950
951
* Phpunit has been upgraded to 5.4.x and following has been deprecated and is not used any more:
  - setExpectedException(), use @expectedException or $this->expectException() and $this->expectExceptionMessage()
  - getMock(), use createMock() or getMockBuilder()->getMock()
  - UnitTestCase class is removed.
952
953
954
955
956
957
958
959
960
961
962
963
964
965
* The following methods have been finally deprecated and should no longer be used:
  - course_modinfo::build_section_cache()
  - cm_info::get_deprecated_group_members_only()
  - cm_info::is_user_access_restricted_by_group()
* The following methods in cm_info::standardmethods have also been finally deprecated and should no longer be used:
  - cm_info::get_after_edit_icons()
  - cm_info::get_after_link()
  - cm_info::get_content()
  - cm_info::get_custom_data()
  - cm_info::get_extra_classes()
  - cm_info::get_on_click()
  - cm_info::get_url()
  - cm_info::obtain_dynamic_data()
  Calling them through the magic method __call() will throw a coding exception.
966
967
* The alfresco library has been removed from core. It was an old version of
  the library which was not compatible with newer versions of Alfresco.
968
* Added down arrow: $OUTPUT->darrow.
969
970
* All file_packer implementations now accept an additional parameter to allow a simple boolean return value instead of
  an array of individual file statuses.
971
* "I set the field "field_string" to multiline:" now end with colon (:), as PyStrings is supposed to end with ":"
972
973
974
* New functions to support deprecation of events have been added to the base event. See MDL-46214 for further details.
* A new function `get_name_with_info` has been added to the base event. This function adds information about event
  deprecations and should be used where this information is relevant.
975
976
977
978
979
980
981
982
983
984
* Following api's have been deprecated in behat_config_manager, please use behat_config_util instead.
  - get_features_with_tags
  - get_components_steps_definitions
  - get_config_file_contents
  - merge_behat_config
  - get_behat_profile
  - profile_guided_allocate
  - merge_config
  - clean_path
  - get_behat_tests_path
985
986
987
988
989
* behat_util::start_test_mode() accepts 3 options now:
  - 1. Theme sute with all features: If behat should initialise theme suite with all core features.
  - 2. Parallel runs: How many parallel runs will be running.
  - 3. Run: Which process behat should be initialise for.
* behat_context_helper::set_session() has been deprecated, please use behat_context_helper::set_environment() instead.
990
* data-fieldtype="type" attribute has been added to form field default template.
991
992
* form elements extending MoodleQuickForm_group must call $this->createFormElement() instead of
  @MoodleQuickForm::createElement() in order to be compatible with PHP 7.1
993
994
* Relative paths in $CFG->alternateloginurl will be resolved to absolute path within moodle site. Previously they
  were resolved to absolute path within the server. That means:
995
996
997
  - $CFG->wwwroot: http://example.com/moodle
  - $CFG->alternateloginurl : /my/super/login.php
  - Login url will be: http://example.com/moodle/my/super/login.php (moodle root based)
998
999
* Database (DML) layer:
  - new sql_equal() method available for places where case sensitive/insensitive varchar comparisons are required.
1000
1001
1002
1003
1004
* PostgreSQL connections now use advanced options to reduce connection overhead.  These options are not compatible
  with some connection poolers.  The dbhandlesoptions parameter has been added to allow the database to configure the
  required defaults. The parameters that are required in the database are;
    ALTER DATABASE moodle SET client_encoding = UTF8;
    ALTER DATABASE moodle SET standard_conforming_strings = on;
1005
    ALTER DATABASE moodle SET search_path = 'moodle,public';  -- Optional, if you wish to use a custom schema.
1006
  You can set these options against the database or the moodle user who connects.
1007
1008
1009
1010
1011
1012
* Some form elements have been refined to better support right-to-left languages. In RTL,
  most fields should not have their direction flipped, a URL, a path to a file, a number, ...
  are always displayed LTR. Input fields and text areas now will best guess whether they
  should be forced to be displayed in LTR based on the PARAM type associated with it. You
  can call $mform->setForceLtr($elementName, true/false) on some form fields to manually
  set the value.
1013
* Action menus do_not_enhance() is deprecated, use a list of action_icon instead.
1014
1015
* The user_not_fully_set_up() function has a new $strict parameter (defaulting to true) in order to decide when
  custom fields (and other checks) should be evaluated to determine if the user has been completely setup.
1016
1017
* profile_field_base class has new methods: get_field_config_for_external() and get_field_properties().
  This two new methods should be implemented by profile field plugins to make them compatible with Web Services.
1018
1019
* The minifier library used by core_minify has been switched to https://github.com/matthiasmullie/minify - there are minor differences
  in minifier output.
1020
* context_header additional buttons can now have a class attribute provided in the link attributes.
1021
1022
* The return signature for the antivirus::scan_file() function has changed.
  The calling function will now handle removal of infected files from Moodle based on the new integer return value.
1023
1024
1025
1026
1027
1028
* The first parameter $eventdata of both message_send() and \core\message\manager::send_message() should
  be \core\message\message. Use of stdClass is deprecated.
* The message_sent event now expects other[courseid] to be always set, exception otherwise. For BC with contrib code,
  message_sent::create_from_ids() will show a debugging notice if the \core\message\message being sent is missing
  the courseid property, defaulting to SITEID automatically. In Moodle 3.6 (MDL-55449) courseid will be fully mandatory
  for all messages sent.
1029
* The send_confirmation_email() function has a new optional parameter $confirmationurl to provide a different confirmation URL.
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
* Introduced a new hook for plugin developers:
    - <component>_course_module_background_deletion_recommended()
  This hook should be used in conjunction with the existing '<component>_pre_course_module_delete($mod)'. It must
  return a boolean and is called by core to check whether a plugin's implementation of
  <component>_pre_course_module_deleted($mod) will take a long time. A plugin should therefore only implement this
  function if it also implements <component>_pre_course_module_delete($mod).
  An example in current use is recyclebin, which performs what can be a lengthy backup process in
  tool_recyclebin_pre_course_module_delete. The recyclebin, if enabled, now returns true in its implementation of
  tool_recyclebin_course_module_background_deletion_recommended(), to indicate to core that the deletion (and
  execution of tool_recyclebin_pre_course_module_delete) should be handled with an adhoc task, meaning it will not
  occur in real time.
1041

1042
1043
=== 3.1 ===

1044
1045
* Webservice function core_course_search_courses accepts a new parameter 'limittoenrolled' to filter the results
  only to courses the user is enrolled in, and are visible to them.
1046
1047
* External functions that are not calling external_api::validate_context are buggy and will now generate
  exceptions. Previously they were only generating warnings in the webserver error log.
1048
  See https://docs.moodle.org/dev/External_functions_API#Security
1049
* The moodle/blog:associatecourse and moodle/blog:associatemodule capabilities has been removed.
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
* The following functions has been finally deprecated and can not be used any more:
    - profile_display_badges()
    - useredit_shared_definition_preferences()
    - calendar_normalize_tz()
    - get_user_timezone_offset()
    - get_timezone_offset()
    - get_list_of_timezones()
    - calculate_user_dst_table()
    - dst_changes_for_year()
    - get_timezone_record()
    - test_get_list_of_timezones()
    - test_get_timezone_offset()
    - test_get_user_timezone_offset()
1063
1064
1065
* The google api library has been updated to version 1.1.7. There was some important changes
  on the SSL handling. Now the SSL version will be determined by the underlying library.
  For more information see https://github.com/google/google-api-php-client/pull/644
1066
1067
1068
* The get_role_users() function will now add the $sort fields that are not part
  of the requested fields to the query result and will throw a debugging message
  with the added fields when that happens.
1069
1070
1071
1072
1073
* The core_user::fill_properties_cache() static method has been introduced to be a reference
  and allow standard user fields data validation. Right now only type validation is supported
  checking it against the parameter (PARAM_*) type of the target user field. MDL-52781 is
  going to add support to null/not null and choices validation, replacing the existing code to
  validate the user fields in different places in a common way.
1074
1075
1076
1077
1078
* Webservice function core_course_search_courses now returns results when the search string
  is less than 2 chars long.
* Webservice function core_course_search_courses accepts a new parameter 'requiredcapabilities' to filter the results
  by the capabilities of the current user.
* New mform element 'course' handles thousands of courses with good performance and usability.
1079
1080
1081
1082
* The redirect() function will now redirect immediately if output has not
  already started. Messages will be displayed on the subsequent page using
  session notifications. The type of message output can be configured using the
  fourth parameter to redirect().
1083
1084
1085
1086
1087
1088
1089
* The specification of extra classes in the $OUTPUT->notification()
  function, and \core\output\notification renderable have been deprecated
  and will be removed in a future version.
  Notifications should use the levels found in \core\output\notification.
* The constants for NOTIFY_PROBLEM, NOTIFY_REDIRECT, and NOTIFY_MESSAGE in
  \core\output\notification have been deprecated in favour of NOTIFY_ERROR,
  NOTIFY_WARNING, and NOTIFY_INFO respectively.
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
* The following functions, previously used (exclusively) by upgrade steps are not available
  anymore because of the upgrade cleanup performed for this version. See MDL-51580 for more info:
    - upgrade_mysql_fix_unsigned_and_lob_columns()
    - upgrade_course_completion_remove_duplicates()
    - upgrade_save_orphaned_questions()
    - upgrade_rename_old_backup_files_using_shortname()
    - upgrade_mssql_nvarcharmax()
    - upgrade_mssql_varbinarymax()
    - upgrade_fix_missing_root_folders()
    - upgrade_course_modules_sequences()
    - upgrade_grade_item_fix_sortorder()
    - upgrade_availability_item()
1102
1103
1104
1105
* A new parameter $ajaxformdata was added to the constructor for moodleform. When building a
  moodleform in a webservice or ajax script (for example using the new fragments API) we
  cannot allow the moodleform to parse it's own data from _GET and _POST - we must pass it as
  an array.
1106
1107
1108
1109
* Plugins can extend the navigation for user by declaring the following callback:
  <frankenstyle>_extend_navigation_user(navigation_node $parentnode, stdClass $user,
                                        context_user $context, stdClass $course,
                                        context_course $coursecontext)
1110
* The function notify() now throws a debugging message - see MDL-50269.
1111
1112
1113
* Ajax calls going through lib/ajax/* now validate the return values before sending
  the response. If the validation does not pass an exception is raised. This behaviour
  is consistent with web services.
1114
1115
* Several changes in Moodle core, standard plugins and third party libraries to
  ensure compatibility with PHP7. All plugins are recommended to perform testing
1116
1117
  against PHP7 as well. Refer to https://docs.moodle.org/dev/Moodle_and_PHP7 for more
  information. The following changes may affect you:
1118
1119
1120
1121
1122
1123
1124
1125
1126
  * Class moodleform, moodleform_mod and some module classes have been changed to use
    __construct() for the constructor. Calling parent constructors by the class
    name will display debugging message. Incorrect: parent::moodleform(),
    correct: parent::__construct()
  * All form elements have also changed the constructor syntax. No changes are
    needed for using form elements, however if plugin defines new form element it
    needs to use correct syntax. For example, incorrect: parent::HTML_QuickForm_input(),
    HTML_QuickForm_input::HTML_QuickForm_input(), $this->HTML_QuickForm_input().
    Correct: HTML_QuickForm_input::__construct() or parent::__construct().
1127
1128
1129
1130
1131
1132
1133
  * profile_field_base::profile_field_base() is deprecated, use parent::__construct()
    in custom profile fields constructors. Similar deprecations in exsiting
    profile_field_* classes.
  * user_filter_type::user_filter_type() is deprecated, use parent::__construct() in
    custom user filters. Similar deprecations in existing user_filter_* classes.
  * table_default_export_format_parent::table_default_export_format_parent() is
    deprecated, use parent::__construct() in extending classes.
1134
1135
1136
* groups_delete_group_members() $showfeedback parameter has been removed and is no longer
  respected. Users of this function should output their own feedback if required.
* Number of changes to Tags API, see tag/upgrade.txt for more details
1137
1138
1139
* The previous events API handlers are being deprecated in favour of events 2 API, debugging messages are being displayed if
  there are 3rd party plugins using it. Switch to events 2 API please, see https://docs.moodle.org/dev/Event_2#Event_dispatching_and_observers
  Note than you will need to bump the plugin version so moodle is aware that you removed the plugin's event handlers.
1140
1141
* mforms validation functions are not available in the global JS namespace anymore, event listeners
  are assigned to fields and buttons through a self-contained JS function.
1142
1143
* Added $CFG->urlrewriteclass option to config.php allowing clean / semantic urls to
  be implemented in a plugin, eg local_cleanurls.
1144
1145
1146
1147
* $CFG->pathtoclam global setting has been moved to clamav antivirus plugin setting of the same name.
* clam_message_admins() and get_clam_error_code() have been deprecated, its functionality
  is now a part of \antivirus_clamav\scanner class methods.
* \repository::antivir_scan_file() has been deprecated, \core\antivirus\manager::scan_file() that
1148
  applies antivirus plugins is replacing its functionality.
1149
* Added core_text::str_max_bytes() which safely truncates multi-byte strings to a maximum number of bytes.
1150
* Zend Framework has been removed completely.
1151
* Any plugin can report when a scale is being used with the callback function [pluginname]_scale_used_anywhere(int $scaleid).
1152
* Changes in file_rewrite_pluginfile_urls: Passing a new option reverse = true in the $options var will make the function to convert
1153
  actual URLs in $text to encoded URLs in the @@PLUGINFILE@@ form.
1154
* behat_util::is_server_running() is removed, please use behat_util::check_server_status() instead.
1155
1156
* Behat\Mink\Selector\SelectorsHandler::xpathLiteral() method is deprecated use behat_context_helper::escape instead
  when building Xpath, or pass the unescaped value when using the named selector.',
1157
* table_sql download process is using the new data formats plugin which you can't use if you are buffering any output
1158
1159
    * flexible_table::get_download_menu(), considered private, has been deleted. Use
      $OUTPUT->download_dataformat_selector() instead.
1160
1161
  when building Xpath, or pass the unescaped value when using the named selector.
* Add new file_is_executable(), to consistently check for executables even in Windows (PHP bug #41062).
1162
* Introduced new hooks for plugin developers.
1163
1164
1165
1166
1167
    - <component>_pre_course_category_delete($category)
    - <component>_pre_course_delete($course)
    - <component>_pre_course_module_delete($cm)
    - <component>_pre_block_delete($instance)
    - <component>_pre_user_delete($user)
1168
  These hooks allow developers to use the item in question before it is deleted by core. For example, if your plugin is
1169
1170
  a module (plugins located in the mod folder) called 'xxx' and you wish to interact with the user object before it is
  deleted then the function to create would be mod_xxx_pre_user_delete($user) in mod/xxx/lib.php.
1171
* pear::Net::GeoIP has been removed.
1172

1173
1174
=== 3.0 ===

1175
* Minify updated to 2.2.1
1176
* htmlpurifier upgraded to 4.7.0
1177
* Less.php upgraded to 1.7.0.9
1178
* The horde library has been updated to version 5.2.7.
1179
* Google libraries (lib/google) updated to 1.1.5
1180
* Html2Text library has been updated to the latest version of the library.
1181
1182
* External functions x_is_allowed_from_ajax() methods have been deprecated. Define 'ajax' => true in db/services.php instead.
* External functions can be called without a session if they define 'loginrequired' => true in db/services.php.
1183
1184
1185
* All plugins are required to declare their frankenstyle component name via
  the $plugin->component property in their version.php file. See
  https://docs.moodle.org/dev/version.php for details (MDL-48494).
1186
* PHPUnit is upgraded to 4.7. Some tests using deprecated assertions etc may need changes to work correctly.
1187
* Users of the text editor API to manually create a text editor should call set_text before calling use_editor.
1188
* Javascript - SimpleYUI and the Y instance used for modules have been merged. Y is now always the same instance of Y.
1189
* get_referer() has been deprecated, please use the get_local_referer function instead.
1190
* \core\progress\null is renamed to \core\progress\none for improved PHP7 compatibility as null is a reserved word (see MDL-50453).
1191
1192
* \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
  server exceptions in $CFG->proxybypass. See MDL-39353 for details.
1193
1194
1195
1196
1197
1198
1199
1200
1201
* Group and groupings idnumbers can now be passed to and/or are returned from the following web services functions:
  ** core_group_external::create_groups
  ** core_group_external::get_groups
  ** core_group_external::get_course_groups
  ** core_group_external::create_groupings
  ** core_group_external::update_groupings
  ** core_group_external::get_groupings
  ** core_group_external::get_course_groupings
  ** core_group_external::get_course_user_groups
1202
1203
1204
1205
1206
* Following functions are removed from core. See MDL-50049 for details.
    password_compat_not_supported()
    session_get_instance()
    session_is_legacy()
    session_kill_all()
1207
1208
    session_touch()
    session_kill()
1209
1210
1211
1212
1213
1214
1215
1216
1217
    session_kill_user()
    session_set_user()
    session_is_loggedinas()
    session_get_realuser()
    session_loginas()
    js_minify()
    css_minify_css()
    update_login_count()
    reset_login_count()
1218
    check_gd_version()
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
    update_log_display_entry()
    get_recent_enrolments()
    groups_filter_users_by_course_module_visible()
    groups_course_module_visible()
    error()
    formerr()
    editorhelpbutton()
    editorshortcutshelpbutton()
    choose_from_menu()
    update_event()
    get_generic_section_name()
    get_all_sections()
    add_mod_to_section()
    get_all_mods()
    get_course_section()
    format_weeks_get_section_dates()
    get_print_section_cm_text()
    print_section_add_menus()
    make_editing_buttons()
    print_section()
    print_overview()
    print_recent_activity()
    delete_course_module()
    update_category_button()
    make_categories_list()
    category_delete_move()
    category_delete_full()
    move_category()
    course_category_hide()
    course_category_show()
    get_course_category()
    create_course_category()
    get_all_subcategories()
    get_child_categories()
    get_categories()
    print_course_search()
    print_my_moodle()
    print_remote_course()
    print_remote_host()
    print_whole_category_list()
    print_category_info()
1260
    get_course_category_tree()
1261
1262
1263