Extension:PurgePage

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
PurgePage
Release status: stable
Implementation Parser function
Description Provides the #purge parser function
Author(s) Stephan Gambke
Latest version 1.0.0 (2016-07-07)
MediaWiki 1.26+
PHP 5.4+
Database changes No
Composer mediawiki/purge-page
License GNU General Public License 2.0 or later
Download
README
RELEASE-NOTES
Translate the PurgePage extension if it is available at translatewiki.net
Check usage and version matrix.

The PurgePage extension provides the #purge parser function to MediaWiki. This parser function allows to trigger an update of the target page whenever the origin page on which this function is used is updated.

Usage[edit]

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 Semantic Mediawiki query on Bar that contains data from Foo in the results.

Installation[edit]

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, extract it into the extensions directory of your MediaWiki installation and rename the extension's directory to PurgePage.)

Then add the following line to your "LocalSettings.php" file:

wfLoadExtension( 'PurgePage' );

See also[edit]