filter/upgrade.txt

   1 This file describes API changes in core filter API and plugins,
   2 information provided here is intended especially for developers.
   3
   4 === 4.3 ===
   5
   6 * Filters can be applied at different stages - before text format conversion, before text cleaning or after text cleaning.
   7 It is recommended that add-on filter developers use early formatting stages to prevent security issues caused by
   8 modification of already sanitised text.
   9
  10 === 4.0 ===
  11
  12 * The Word censorship (filter_censor) filter has been completely removed from core. It has been moved to the plugins database
  13 repository, so it can still be installed as a third-party plugin.
  14
  15 === 3.9 ===
  16
  17 * 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:
  18     - filter_mathjaxloader_upgrade_cdn_cloudflare()
  19     - filter_mathjaxloader_upgrade_mathjaxconfig_equal()
  20
  21 === 3.6 ===
  22
  23 * Although there is no API change that require you to update your filter,
  24   if you use the filter_phrases() helper method, you may wish to take
  25   advantage of the changes that were made in MDL-47962 to improve performance.
  26
  27   Now, instead of having to compute the replacement HTML for each phrase before
  28   you construct the filterobject for it. You can instead pass a callback to
  29   the filterobject constructor which is only called if the phrase is used.
  30
  31   To understand how to use this, see the comment on filterobject::__construct and
  32   look at the filter_glossary changes as an example:
  33   https://github.com/moodle/moodle/commit/5a8c44d000ecc5669db26aefebe447f688e8f2ce
  34
  35 === 3.0 ===
  36
  37 * New argument $skipfilters to filter_manager::filter_text to allow applying
  38   the filters with a given one omitted.
  39
  40 * New admin setting class admin_setting_filter_types which can be used if you
  41   want to make the disablefilters value in your code configurable.
  42
  43 * Methods filter_manager::text_filtering_hash and moodle_text_filter::hash have been
  44   deprecated. There were use by the old Moodle filtered text caching system
  45   that was removed several releases ago.
  46
  47 === 2.7 ===
  48
  49 * Finally filter may use $PAGE and $OUTPUT, yay!
  50 * Old global text caching was removed, each filter is now responsible
  51   for own caching.
  52
  53 === 2.6 ===
  54
  55 * filtersettings.php is now deprecated, migrate to standard settings.php
  56
  57 === 2.5 ===
  58
  59 * legacy_filter emulation was removed
  60 * support for 'mod/*' filters was removed
  61 * use short filter name instead of old path, ex.: 'filter/tex' ---> 'tex'
  62   in all filter API functions and methods
  63
  64 === 2.3 ===
  65
  66 * new setup() method added to moodle_text_filter, invoked before
  67   filtering happens, used to add all the requirements to the page
  68   (js, css...) and/or other init tasks. See filter/glossary for
  69   an example using the API (and MDL-32279 for its justification).
  70
  71 === 2.2 ===
  72
  73 * legacy filters and legacy locations have been deprecated, so any
  74   old filter should be updated to use the new moodle_text_filter,
  75   and any filter bundled under mod/xxxx directories be moved to
  76   /filter/xxxx (MDL-29995). They will stop working completely in
  77   Moodle 2.3 (MDL-29996). See the glossary or data filters for
  78   examples of legacy module filters and locations already updated.