Merge branch 'MDL-50805_master' of https://github.com/crazyserver/moodle
[moodle.git] / filter / upgrade.txt
blobddfbd82c4bcefd5d0f2380f2201589ecb53a7fba
1 This file describes API changes in core filter API and plugins,
2 information provided here is intended especially for developers.
4 === 3.0 ===
6 * New argument $skipfilters to filter_manager::filter_text to allow applying
7   the filters with a given one omitted.
9 * New admin setting class admin_setting_filter_types which can be used if you
10   want to make the disablefilters value in your code configurable.
12 * Methods filter_manager::text_filtering_hash and moodle_text_filter::hash have been
13   deprecated. There were use by the old Moodle filtered text caching system
14   that was removed several releases ago.
16 === 2.7 ===
18 * Finally filter may use $PAGE and $OUTPUT, yay!
19 * Old global text caching was removed, each filter is now responsible
20   for own caching.
22 === 2.6 ===
24 * filtersettings.php is now deprecated, migrate to standard settings.php
26 === 2.5 ===
28 * legacy_filter emulation was removed
29 * support for 'mod/*' filters was removed
30 * use short filter name instead of old path, ex.: 'filter/tex' ---> 'tex'
31   in all filter API functions and methods
33 === 2.3 ===
35 * new setup() method added to moodle_text_filter, invoked before
36   filtering happens, used to add all the requirements to the page
37   (js, css...) and/or other init tasks. See filter/glossary for
38   an example using the API (and MDL-32279 for its justification).
40 === 2.2 ===
42 * legacy filters and legacy locations have been deprecated, so any
43   old filter should be updated to use the new moodle_text_filter,
44   and any filter bundled under mod/xxxx directories be moved to
45   /filter/xxxx (MDL-29995). They will stop working completely in
46   Moodle 2.3 (MDL-29996). See the glossary or data filters for
47   examples of legacy module filters and locations already updated.