Jump to content

Extension:LinkFilter

From mediawiki.org
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
MediaWiki extensions manual
LinkFilter
Release status: stable
Implementation Special page
Description Adds some new special pages and a parser hook for link submitting/approval/reject
Author(s)
Latest version 3.5.0 (2017-07-11)
MediaWiki 1.43+
Database changes Yes
  • $wgLinkPageDisplay
  • $wgLinkFilterTypes
  • linkadmin
Licence GNU General Public License 2.0 or later
Download
Translate the LinkFilter extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

LinkFilter is an extension to allow users to submit news (etc.) links and wiki admins/other privileged users to approve them.

In addition to the new special pages, LinkFilter also provides ‎<linkfilter> parser hook tag.

New special pages

  • Special:LinkSubmit
  • Special:LinkApprove (available to users with linkadmin right)
  • Special:LinkEdit (redirects to LinkSubmit form, allowing to edit the link details, target etc.)
  • Special:LinksHome
  • Special:LinkRedirect

Install

  • Download and move the extracted LinkFilter folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/LinkFilter
    
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'LinkFilter' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.


Configuration

  • $wgLinkFilterTypes – an array of link types that will be available in the dropdown menu on Special:LinkSubmit. If this is not defined, LinkFilter will use the defaults in Link::$link_types. The defaults are the same as Link::$link_types currently:
$wgLinkFilterTypes = array(
	1 => 'Arrest Report',
	2 => 'Awesome',
	3 => 'Cool',
	4 => 'Funny',
	6 => 'Interesting',
	7 => 'Obvious',
	8 => 'OMG WTF?!?',
	9 => 'Rumor',
	10 => 'Scary',
	11 => 'Stupid',
);
  • $wgLinkPageDisplay – not really a configuration variable per se. Used to display different stuff on LinkFilter pages. For example, setting $wgLinkPageDisplay['in_the_news'] = true; will display "In the News" section on Special:LinksHome.

Customization

You can edit the general instructions displayed to everyone on Special:LinkSubmit by editing MediaWiki:Linkfilter-instructions.

Admins instructions can be edited through MediaWiki:Linkfilter-admin-instructions.

User rights

The extension adds one new user right, linkadmin. Users with this right are able to use LinkFilter's administrative functions, such as approve/reject links. By default, linkadmin, staff and sysop groups have this right.