Module:Purge/doc
 | This is a documentation subpage for Module:Purge. It may contain usage information, categories and other content that is not part of the original module page. |
 | This Lua module is used in system messages, and on approximately 457,000 pages, or roughly 3% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
This module produces a link to purge a page's cache. This is usually the current page, but can be another page.
Usage
From wiktext
From wikitext, this module should be accessed via Template:Purge. Please see the template page for documentation.
From Lua
From Lua, first you need to load the module: <syntaxhighlight lang="lua"> local mPurge = require('Module:Purge') </syntaxhighlight>
Then you can create purge links with the _main function:
<syntaxhighlight lang="lua">
mPurge._main(args)
</syntaxhighlight>
args is a table of arguments, identical to the ones accepted by Template:Purge. Please see the template documentation for more details.