Extension:UserTools

From MediaWiki.org
Jump to: navigation, search

(($disable$))

MediaWiki extensions manual
Crystal Clear action run.png
UserTools

Release status: beta

Implementation Extended syntax
Author(s) Jean-Lou Dupont
Latest version 1.1.0
MediaWiki 1.10, 1.11
License No license specified
Download SVN
See SVN ($Id: UserTools.doc.wikitext 762 2007-12-14 15:20:18Z jeanlou.dupont $)

Translate the UserTools extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

Purpose[edit | edit source]

Provides secure parser functions to retrieve user related information.

Usage[edit | edit source]

This extension is really meant to be used with Extension:ParserPhase2.

User options[edit | edit source]

  • E.g. (($#cusergetoption|email|default$))
    • Get the current user's email option
  • E.g. (($#usergetoption|user id or name|email|default$))
    • Get the specified user's email option IFF the current has the 'userdetails' right

User Group Membership[edit | edit source]

  • {{#cuserfromgroup:group-to-look-for|trueValue|falseValue}}
    • trueValue is returned if current user is part of group
    • falseValue is returned if current user is not part of group

Similar to #cuserfromgroup:

  • {{#userfromgroup:username-OR-user-id|group-to-look-for|trueValue|falseValue}}
    • Either a username or user id must be supplied

Features[edit | edit source]

  • Options are categorized as either 'RESTRICTED' or 'UNRESTRICTED' for privacy reasons
    • User must have the userdetails right to access 'RESTRICTED' options
    • Also, the current user must have the userdetails to view some other user's group membership

Dependencies[edit | edit source]



Installation[edit | edit source]

See the Mediawiki Extension table entry "download" above.[1]

LocalSettings.php[edit | edit source]

Extension:ExtensionManager: See footnote[2]

require_once "$IP/extensions/ParserExt/ParserExt.php";
  • Since this Extensions is depending on StubManager, add the line after the StubManager include, or else your Wiki won't work.

PEAR[edit | edit source]

PEAR is a repository of PHP software code.

pear channel-discover mediawiki.googlecode.com/svn
  • Install extension through PEAR:
pear install mediawiki/ParserExt
  • Add the following to LocalSettings.php[2][3]:
require 'MediaWiki/ParserExt/ParserExt.php';
  • Note that the required version of PEAR must be respected. Currently, the minimum version of PEAR usable with this channel is v1.6.2. Perform the following command to upgrade to the latest version of PEAR:
pear upgrade pear

Upgrades through PEAR[edit | edit source]

Sometimes, it is necessary to clear PEAR's cache in order to perform upgrades.

pear clear-cache

or use the force method:

pear upgrade --force mediawiki/ParserExt

PEAR Web Frontend[edit | edit source]

For easier remote package management, PEAR Frontend WEB can be installed. Installation notes can be found here. An example of the WEB frontend is available here.

RSS feed[edit | edit source]

To keep up-to-date with this channel, use the following RSS feed__Rss2.jpg.

Notes[edit | edit source]

Other Extensions From the same author[edit | edit source]

Consult User Jldupont's page.


  1. The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
  2. 2.0 2.1 2.2 Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
    Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed.
  3. Modifications to LocalSettings.php is only necessary if not using Extension:ExtensionManager

History[edit | edit source]

Release Notes
1.1.0 Addition of #cuserfromgroup and #userfromgroup