Extension:Admin Links

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
Admin Links

Release status: stable

Implementation Special page, Hook, API
Description Defines a special page, "AdminLinks", meant to serve as a "control panel" for administrators; and adds a link to this page to their "user links"
Author(s) Yaron Koren <yaron57@gmail.com>
Latest version 0.1.8 (May 2013)
MediaWiki 1.18.* or greater
PHP 5.3.* or greater
Database changes No
License GPL
Download
README
Example The "Admin links" page for Discourse DB
Added rights

adminlinks

Hooks used
PersonalUrls

Translate the Admin Links extension if possible

Check usage and version matrix; code metrics
Bugs: list open list all report

Admin Links is an extension to MediaWiki that defines a special page, "Special:AdminLinks", that holds links meant to be helpful for wiki administrators; it is meant to serve as a "control panel" for the functions an administrator would typically perform in a wiki. All users can view this page; however, for those with the 'adminlinks' permission (sysops/administrators, by default), a link to the page also shows up in their user/navigation links, between "my talk" and "my preferences".

Admin Links provides a hook, and an API, for other extensions to be able to add their own links, and sections, to the page.

You can see an example of this page, with additional links and sections added by other extensions, here.

MediaWiki already provides a "Special:SpecialPages" page, which list the special pages for all the extensions installed on the wiki; which may lead you to wonder what the need is for the additional "AdminLinks" page. However, there are a number of important differences that make "AdminLinks" useful:

  • "SpecialPages" holds links to every special page in the wiki, including many (such as Unused categories), that are not specifically helpful to administrators; "AdminLinks" attempts to link only to the administrator-specific ones
  • "AdminLinks" can hold links to pages that are not special pages, such as the "Edit sidebar" page, and documentation for various extensions
  • Finally, the Admin Links extension puts a link to "AdminLinks" in administrators' personal tools, which makes things more convenient

Code and download[edit | edit source]

You can download the Admin Links code, in .tgz format, here.

You can also download the code directly via Git from the MediaWiki source code repository. From a command line, you can call the following:

git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/AdminLinks.git

To view the code online, including version history for each file, go here.

Installation[edit | edit source]

After you've obtained an 'AdminLinks' directory (either by extracting a compressed file or downloading via SVN), place this directory within the main MediaWiki 'extensions' directory. Then, in the file 'LocalSettings.php' in the main MediaWiki directory, add the following line:

include_once("$IP/extensions/AdminLinks/AdminLinks.php");

If you want to have the members of groups other than 'sysop' see a link to the AdminLinks page among their navigation links, you can also add lines like the following after it:

$wgGroupPermissions['my-group']['adminlinks'] = true;

Authors[edit | edit source]

Admin Links was written by Yaron Koren, reachable at yaron57 -at- gmail.com.

Version history[edit | edit source]

Admin Links is currently at version 0.1.8.

The version history is:

  • 0.1 - May 13, 2009 - Initial version
  • 0.1.1 - June 2, 2009 - Support for many languages added
  • 0.1.2 - September 9, 2009 - Support for many more languages added
  • 0.1.3 - July 12, 2010 - More links added; some section headers renamed
  • 0.1.4 - February 22, 2011 - Handling improved for MW 1.16+; link to Special:ListFiles added
  • 0.1.5 - October 10, 2011 - Handling improved for MW 1.17+; link to Special:Log added
  • 0.1.6 - January 6, 2012 - Support removed for MW < 1.16
  • 0.1.7 - November 12, 2012 - Handling improved for MW 1.18+; support removed for MW < 1.18
  • 0.1.8 - May 1, 2013 - Fix for ALItem::newFromPage()

The Admin Links API[edit | edit source]

In order for an extension to add links and sections to the AdminLinks page, it must define a new function, and register it with the "AdminLinks" hook. See the AdminLinks hook manual for more info.

Extensions that use Admin Links[edit | edit source]

The following extensions add links to the Admin Links page, if installed:

Contributing to the project[edit | edit source]

Bugs and feature requests[edit | edit source]

Send any bug reports and requests to Yaron Koren, at yaron57 -at- gmail.com.

Contributing patches to the project[edit | edit source]

If you found some bug and fixed it, or if you wrote code for a new feature, please create a patch by going to the "AdminLinks" directory, and typing:

git diff > descriptivename.patch

Then send this patch, with a description, to Yaron Koren.