mirrored from git://git.moodle.org/moodle.git
/
upgrade.txt
1799 lines (1716 loc) · 119 KB
/
upgrade.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
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
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
This files describes API changes in core libraries and APIs,
information provided here is intended especially for developers.
=== 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).
=== 3.11 ===
* 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.
* The horde library has been updated to version 5.2.23.
* 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.
* Final deprecation i_dock_block() in behat_deprecated.php
* Final deprecation of get_courses_page. Function has been removed and core_course_category::get_courses() should be
used instead.
* 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.
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.
* Behat timeout constants behat_base::TIMEOUT, EXTENDED_TIMEOUT, and REDUCED_TIMEOUT, which were deprecated in 3.7, have been removed.
* \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.
* HTMLPurifier has been upgraded to the latest version - 4.13.0
* Markdown lib has been upgraded to the latest version - 1.9.0
* The minify lib has been upgraded to 1.3.63 and pathconvertor to 1.1.3
* A new optional parameter `$sort` has been added to all `$context->get_capabilities()` methods to be able to define order of
returned capability array.
* Spout has been upgraded to the latest version - 3.1.0
* emoji-data has been upgraded to 6.0.0.
* 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.
* 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##"
* 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##"
* New DML driver method `$DB->sql_group_concat` for performing group concatenation of a field within a SQL query
* 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.
* 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']
- 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']
* Admin setting admin_setting_configmulticheckbox now supports lazy-loading the options list by
supplying a callback function instead of an array of options.
* A new core API class \core_user\fields provides ways to get lists of user fields, and SQL related to
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.
* 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.
* 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##"
* 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.
* 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.
* 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.
* 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().
* A new index has been added on mdl_user_preferences.name. This upgrade step might take some time on big sites.
=== 3.10 ===
* PHPUnit has been upgraded to 8.5. That comes with a few changes:
- 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.
- 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.
* Retains the source course id when a course is copied from another course on the same site.
* 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.
* The `$CFG->behat_retart_browser_after` configuration setting has been removed.
The browser session is now restarted between all tests.
* add_to_log() has been through final deprecation, please rewrite your code to the new events API.
* 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
* The following renamed classes have been completely removed:
- course_in_list (now: core_course_list_element)
- coursecat (now: core_course_category)
* The form element 'htmleditor', which was deprecated in 3.6, has been removed.
* 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.
* A new parameter `$rolenamedisplay` has been added to `get_viewable_roles()` and `get_switchable_roles` to define how role names
should be returned.
* The class coursecat_sortable_records has been removed.
* Admin setting admin_setting_configselect now supports lazy-loading the options list by supplying
a callback function instead of an array of options.
* Admin setting admin_setting_configselect now supports validating the selection by supplying a
callback function.
* 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.
* New library function rename_to_unused_name() to rename a file within its current location.
* Constant \core_h5p\file_storage::EDITOR_FILEAREA has been deprecated
because it's not required any more.
* The ZipStream-PHP library has been added to Moodle core in /lib/zipstream.
* The php-enum library has been added to Moodle core in /lib/php-enum.
* The http-message library has been added to Moodle core in /lib/http-message.
* Methods `filetypes_util::is_whitelisted()` and `filetypes_util::get_not_whitelisted()` have been deprecated and
renamed to `is_listed()` and `get_not_listed()` respectively.
* Method `mustache_helper_collection::strip_blacklisted_helpers()` has been deprecated and renamed to
`strip_disallowed_helpers()`.
* 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.
* New setting $CFG->localtempdir overrides which defaults to sys_get_temp_dir()
* Function redirect() now emits a line of backtrace into the X-Redirect-By header when debugging is on
* New DML function $DB->delete_records_subquery() to delete records based on a subquery in a way
that will work across databases.
* Add support for email DKIM signatures via $CFG->emaildkimselector
=== 3.9 ===
* 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
* Old Safe Exam Browser quiz access rule (quizaccess_safebrowser) replaced by new Safe Exam Browser access rule (quizaccess_seb).
Experimental setting enablesafebrowserintegration was deleted.
* New CFPropertyList library has been added to Moodle core in /lib/plist.
* 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.
* 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).
* Removed the following deprecated functions:
- question_add_tops
- question_is_only_toplevel_category_in_context
* format_float() now accepts a special value (-1) as the $decimalpoints parameter
which means auto-detecting number of decimal points.
* 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.
* Changed default sessiontimeout to 8 hours to cover most normal working days
* 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.
* Added the <component>_bulk_user_actions() callback which returns a list of custom action_links objects
* 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
* Added a native MySQL / MariaDB lock implementation
* The database drivers (moodle_database and subclasses) don't need to implement get_columns() anymore.
They have to implement fetch_columns instead.
* 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.
* The 'xxxx_check_password_policy' callback now only fires if $CFG->passwordpolicy is true
* 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.
* lib/outputrequirementslib::get_jsrev now is public, it can be called from other classes.
* H5P libraries have been moved from /lib/h5p to h5p/h5plib as an h5plib plugintype.
* 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.
* 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.
* database_manager::check_database_schema() now checks for missing and extra indexes.
* Implement a more direct xsendfile_file() method for an alternative_file_system_class
* 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.
* 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.
* The download_as_dataformat() method has been deprecated. Please use \core\dataformat::download_data() instead
* 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()
* 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.
* Legacy cron has been deprecated and will be removed in Moodle 4.1. This includes the functions:
- cron_execute_plugin_type()
- cron_bc_hack_plugin_functions()
Please, use the Task API instead: https://docs.moodle.org/dev/Task_API
* 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.
* Data generator create_user in both unittests and behat now validates user fields and triggers user_created event
=== 3.8 ===
* Add CLI option to notify all cron tasks to stop: admin/cli/cron.php --stop
* The rotate_image function has been added to the stored_file class (MDL-63349)
* The yui checknet module is removed. Call \core\session\manager::keepalive instead.
* The generate_uuid() function has been deprecated. Please use \core\uuid::generate() instead.
* Remove lib/pear/auth/RADIUS.php (MDL-65746)
* Core components are now defined in /lib/components.json instead of coded into /lib/classes/component.php
* Subplugins should now be defined using /db/subplugins.json instead of /db/subplugins.php
* The following functions have been finally deprecated and can not be used anymore:
* allow_override()
* allow_assign()
* allow_switch()
* https_required()
* verify_https_required()
* Remove duplicate font-awesome SCSS, Please see /theme/boost/scss/fontawesome for usage (MDL-65936)
* Remove lib/pear/Crypt/CHAP.php (MDL-65747)
* 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.
* Final deprecation (removal) of the core/modal_confirm dialogue.
* Upgrade scssphp to v1.0.2, This involves renaming classes from Leafo => ScssPhp as the repo has changed.
* Implement supports_xsendfile() method and allow support for xsendfile in alternative_file_system_class
independently of local files (MDL-66304).
* 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.
* 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
* 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.
* 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
The following are _invalid_ template names and locations:
mod_forum/post/user: mod/forum/templates/local/post/user.mustache
* Following behat steps have been removed from core:
- I go to "<gradepath_string>" in the course gradebook
* A new admin setting widget 'core_admin\local\settings\filesize' is added.
* Core capabilities 'moodle/community:add' and 'moodle/community:download' have been removed from core as part of Moodle.net sunsetting.
* 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
* 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.
* The core_enrol_edit_user_enrolment webservice has been deprecated. Please use core_enrol_submit_user_enrolment_form instead.
* \single_button constructor has a new attributes param to add attributes to the button HTML tag.
* Improved url matching behaviour for profiled urls and excluded urls
* Attempting to use xsendfile via the 3rd param of readstring_accel() is now ignored.
* New H5P libraries have been added to Moodle core in /lib/h5p.
* New H5P core subsystem have been added.
* 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.
* 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.
=== 3.7 ===
* Nodes in the navigation api can have labels for each group. See set/get_collectionlabel().
* The method core_user::is_real_user() now returns false for userid = 0 parameter
* '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.
* 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.
* 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.
* 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.
* 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.
* /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.
* 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.
* 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.
* 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.
Notice also than when $text is set, pluginfile rewrite won't be processed so the text will not be modified.
* 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...)
* New capability 'moodle/category:viewcourselist' in category context that controls whether user is able to browse list of courses
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.
* Add support for a new xxx_after_require_login callback
* 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).
* 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.
* Exposed submit button to allow custom styling (via customclassoverride variable) which can override btn-primary/btn-secondary classes
* `$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
* New mform element 'float' handles localised floating point numbers.
=== 3.6 ===
* 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
* The `user_picture` class has a new public `$includetoken` property which can be set to make use of the new token-based
file serving.
* Custom AJAX handlers for the form autocomplete fields can now optionally return string in their processResults()
callback. If a string is returned, it is displayed instead of the list of suggested items. This can be used, for
example, to inform the user that there are too many items matching the current search criteria.
* The form element 'htmleditor' has been deprecated. Please use the 'editor' element instead.
* The print_textarea() function has been deprecated. Please use $OUTPUT->print_textarea() instead.
* The following functions have been finally deprecated and can not be used any more:
- external_function_info()
- core_renderer::update_module_button()
- 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()
- get_file_url()
- course_get_cm_rename_action()
- course_scale_used()
- site_scale_used()
- clam_message_admins()
- get_clam_error_code()
- 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()
- prefixed_tablenode_transformations()
- core_media_renderer
- core_media
* 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()
* Following behat steps have been removed from core:
- I set the field "<field_string>" to multiline
- I follow "<link_string>"" in the open menu
* 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"
* 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).
* Removed the lib/password_compat/lib/password.php file.
* 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()
* coursecat::get() now has optional $user parameter.
* coursecat::is_uservisible() now has optional $user parameter.
* Removed the lib/form/submitlink.php element which was deprecated in 3.2.
* 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).
* 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.
* Following functions have been deprecated, please use get_roles_used_in_context.
- get_roles_on_exact_context()
- get_roles_with_assignment_on_context()
* New functions to support the merging of user draft areas from the interface; see MDL-45170 for details:
- file_copy_file_to_file_area()
- file_merge_draft_areas()
- file_replace_file_area_in_text()
- extract_draft_file_urls_from_text()
* 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.
* \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
* 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.
- Enrolling users into courses.
- Unenrolling users from courses.
* 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.
* 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.
* 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.
* 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!
* 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.
* 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.
* 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.
* Webservices no longer update the lastaccess time for a user in a course. Call core_course_view_course() manually if needed.
* 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.
=== 3.5 ===
* 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.
* The cron runner now sets up a fresh PAGE and OUTPUT between each task.
* 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.
* 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).
* 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.
* The following functions have been finally deprecated and can not be used any more:
- notify()
* 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.
* Add recaptchalib_v2.php for support of reCAPTCHA v2.
* 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
* 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.
* 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.
* The following have been removed from the list of core subsystems:
- core_register
- core_publish
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.
=== 3.4 ===
* oauth2_client::request method has an extra parameter to specify the accept header for the response (MDL-60733)
* 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()
* 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).
* 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).
* 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.
* file_get_draft_area_info does not sum the root folder anymore when calculating the foldercount.
* 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.
* New user_picture attribute $includefullname to determine whether to include the user's full name with the user's picture.
* 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.
* 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.
* 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.
* 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.
* user_can_view_profile() now also checks the moodle/user:viewalldetails capability.
* 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.
* 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().
* $stored_file->add_to_curl_request() now adds the filename to the curl request.
* The option for Login HTTPS (authentication-only SSL) has been removed
* $CFG->loginhttps is now deprecated, do not use it.
* $PAGE->https_required and $PAGE->verify_https_required() are now deprecated. They are no longer used and will throw a coding_exception.
* $CFG->httpswwwroot is now deprecated and will always result in the same value as wwwroot.
* 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.
* Deprecated allow_override, allow_assign and allow_switch and replaced with core_role_set_*_allowed to avoid function names conflicting.
=== 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.
=== 3.3 ===
* Behat compatibility changes are now being documented at
https://docs.moodle.org/dev/Acceptance_testing/Compatibility_changes
* 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).
* 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.
* Support added for a new type of external file: FILE_CONTROLLED_LINK. This is an external file that Moodle can control
the permissions. Moodle makes files read-only but can grant temporary write access.
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.
* 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.
* 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}}
For other valid use cases use $OUTPUT->image_url().
* Activity icons have been split from standard icons. Use $OUTPUT->image_icon instead of $OUTPUT->pix_icon for these
type of icons (the coloured main icon for each activity).
* YUI module moodle-core-formautosubmit has been removed, use jquery .change() instead (see lib/templates/url_select.mustache for
an example)
* $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.
* Return value of the validate_email() is now proper boolean as documented. Previously the function could return 1, 0 or false.
* 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).
* 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.
* 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
- 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
* 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:
* 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.
* The caching option 'immutable' has been added to send_stored_file() and send_file().
* New adhoc task refresh_mod_calendar_events_task that updates existing calendar events of modules.
* New 'priority' column for the event table to determine which event to show in case of events with user and group overrides.
* Webservices core_course_search_courses and core_course_get_courses_by_field will always return the sortorder field.
* core_course_external::get_activities_overview has been deprecated. Please do not call this function any more.
* Changed the pix mustache template helper to accept context variables for the key, component and alt text.
* 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.).
=== 3.2 ===
* Custom roles with access to any part of site administration that do not use the manager archetype will need
moodle/site:configview capability added.
* Admin setting "Show My courses expanded on Dashboard" has been removed.
* 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.
* MForms element 'submitlink' has been deprecated.
* 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.
* Node.js versions >=4 are now required to run grunt.
* 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.
* New option 'blanktarget' added to format_text. This option adds target="_blank" to links
* 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.
* 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()
* The following classes have been removed and should not be used any more:
- boxclient - See MDL-49599 for more information.
* The following functions have been removed and should not be used any more:
- file_modify_html_header() - See MDL-29738 for more information.
* core_grades_external::get_grades has been deprecated. Please do not call this function any more.
External function gradereport_user_external::get_grade_items can be used for retrieving the course grades information.
* New option 'escape' added to format_string. When true (default), escapes HTML entities from the string
* 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.
- zip_files() - See MDL-24343 for more information.
- unzip_file() - See MDL-24343 for more information.
- 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
- prevent_form_autofill_password() Please do not use anymore.
* The password_compat library was removed as it is no longer required.
* 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.
* 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.
* 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.
* Added down arrow: $OUTPUT->darrow.
* All file_packer implementations now accept an additional parameter to allow a simple boolean return value instead of
an array of individual file statuses.
* "I set the field "field_string" to multiline:" now end with colon (:), as PyStrings is supposed to end with ":"
* 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.
* 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
* 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.
* data-fieldtype="type" attribute has been added to form field default template.
* form elements extending MoodleQuickForm_group must call $this->createFormElement() instead of
@MoodleQuickForm::createElement() in order to be compatible with PHP 7.1
* 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:
- $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)
* Database (DML) layer:
- new sql_equal() method available for places where case sensitive/insensitive varchar comparisons are required.
* 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;
ALTER DATABASE moodle SET search_path = 'moodle,public'; -- Optional, if you wish to use a custom schema.
You can set these options against the database or the moodle user who connects.
* 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.
* Action menus do_not_enhance() is deprecated, use a list of action_icon instead.
* 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.
* 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.
* The minifier library used by core_minify has been switched to https://github.com/matthiasmullie/minify - there are minor differences
in minifier output.
* context_header additional buttons can now have a class attribute provided in the link attributes.
* 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.
* 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.
* The send_confirmation_email() function has a new optional parameter $confirmationurl to provide a different confirmation URL.
* 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.
=== 3.1 ===
* 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.
* 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.
See https://docs.moodle.org/dev/External_functions_API#Security
* The moodle/blog:associatecourse and moodle/blog:associatemodule capabilities has been removed.
* 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()
* 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
* 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.
* 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.
* 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.
* 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().
* 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.
* 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()