filter/upgrade.txt

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