Page Filters essentially allow you to pre- and postprocess the information that flies back and forth between the Wiki engine and the browser.

There are four possible places where the filters can be applied:

  1. pre-translate - that is, after the page has been fetched from the page repository, but before it has been translated from WikiMarkup to HTML.
  2. post-translate - after the page has been translated into HTML, but before it is shown to the user.
  3. pre-save - before the page is committed to the repository.
  4. post-save - after the page has been committed to the repository successfully. Note that at this point it is useless to change the page data anymore, so filters that hook to this event are typically general notification filters - such as sending email.

To see which filters are running on this instance of JSPWiki, use the [{$pagefilters}] WikiVariable to list them. See System Info for more information.

For the Javadoc API see BasicPageFilter.html

JSPWiki comes with three Page Filters:

To use more Filters, see Contributed Filters.

To setup Filters, see PageFilter Configuration.


Category.Documentation