MDL-69240 tool_moodlenet: Clean MoodleNet profile field
[moodle.git] / filter / upgrade.txt
CommitLineData
dd3fafbd
EL
1This file describes API changes in core filter API and plugins,
2information provided here is intended especially for developers.
3
08bc1f11
SA
4=== 3.9 ===
5
6* The following functions, previously used (exclusively) by upgrade steps are not available anymore because of the upgrade cleanup performed for this version. See MDL-65809 for more info:
7 - filter_mathjaxloader_upgrade_cdn_cloudflare()
8 - filter_mathjaxloader_upgrade_mathjaxconfig_equal()
9
3923151a
TH
10=== 3.6 ===
11
12* Although there is no API change that require you to update your filter,
13 if you use the filter_phrases() helper method, you may wish to take
14 advantage of the changes that were made in MDL-47962 to improve performance.
15
16 Now, instead of having to compute the replacement HTML for each phrase before
17 you construct the filterobject for it. You can instead pass a callback to
18 the filterobject constructor which is only called if the phrase is used.
19
20 To understand how to use this, see the comment on filterobject::__construct and
21 look at the filter_glossary changes as an example:
6ef77520 22 https://github.com/moodle/moodle/commit/5a8c44d000ecc5669db26aefebe447f688e8f2ce
3923151a 23
502561d6
TH
24=== 3.0 ===
25
7d94679f
TH
26* New argument $skipfilters to filter_manager::filter_text to allow applying
27 the filters with a given one omitted.
a94b2cb8
TH
28
29* New admin setting class admin_setting_filter_types which can be used if you
30 want to make the disablefilters value in your code configurable.
31
502561d6
TH
32* Methods filter_manager::text_filtering_hash and moodle_text_filter::hash have been
33 deprecated. There were use by the old Moodle filtered text caching system
34 that was removed several releases ago.
35
62c80325
36=== 2.7 ===
37
38* Finally filter may use $PAGE and $OUTPUT, yay!
39* Old global text caching was removed, each filter is now responsible
40 for own caching.
41
c169e580
PS
42=== 2.6 ===
43
44* filtersettings.php is now deprecated, migrate to standard settings.php
45
0662bd67
PS
46=== 2.5 ===
47
48* legacy_filter emulation was removed
49* support for 'mod/*' filters was removed
50* use short filter name instead of old path, ex.: 'filter/tex' ---> 'tex'
51 in all filter API functions and methods
52
d24f821e
EL
53=== 2.3 ===
54
55* new setup() method added to moodle_text_filter, invoked before
56 filtering happens, used to add all the requirements to the page
57 (js, css...) and/or other init tasks. See filter/glossary for
58 an example using the API (and MDL-32279 for its justification).
59
dd3fafbd
EL
60=== 2.2 ===
61
62* legacy filters and legacy locations have been deprecated, so any
63 old filter should be updated to use the new moodle_text_filter,
64 and any filter bundled under mod/xxxx directories be moved to
65 /filter/xxxx (MDL-29995). They will stop working completely in
66 Moodle 2.3 (MDL-29996). See the glossary or data filters for
67 examples of legacy module filters and locations already updated.