mediawiki/purge-page

Provides the #purge parser function

1.0.0 2016-07-07 19:39 UTC

README

Latest Stable Version Packagist download count Scrutinizer Code Quality

The PurgePage extension provides the #purge parser function to MediaWiki. This parser function allows to trigger an update to a parser functions whenever the page where this function is used is updated.

Example usage

On page Foo add the following parser function call to the wikitext:

{{#purge:Bar}}

Now every time Foo is purged (e.g. every time it is edited and saved) Bar will also be updated.

This can be useful, when the content of Bar depends on Foo, e.g. when using a SemanticMediawiki query on Bar that contains data from Foo in the results.

Requirements

  • PHP 5.4 or later
  • MediaWiki 1.26 or later

Installation

The recommended way to install this extension is by using Composer. Just add the following to the MediaWiki composer.local.json file and run php composer.phar update mediawiki/purge-page from the MediaWiki installation directory.

{
	"require": {
		"mediawiki/purge-page": "~1.0"
	}
}

(Alternatively you can download a tar ball or zip file from GitHub and extract it into the extensions directory of your MediaWiki installation.)

Then add the following line to your LocalSettings.php:

wfLoadExtension('PurgePage');

License

GNU General Public License 2.0 or later.