Open main menu

Extension:UserFunctions

MediaWiki extensions manual
OOjs UI icon advanced.svg
UserFunctions
Release status: stable
Implementation Parser function
Description Provides a set of parser functions that trigger on the current user
Author(s) Algorithm, Toniher and others
Latest version 2.7.0 (2017-07-26)
MediaWiki 1.23+
PHP 5.3+
Database changes No
Composer mediawiki/user-functions
License GNU General Public License 2.0 or later
Download
Example sandbox.semantic-mediawiki.org
  • $wgUFEnablePersonalDataFunctions
  • $wgUFAllowedNamespaces
  • $wgUFEnableSpecialContexts
Translate the UserFunctions extension if it is available at translatewiki.net
Check usage and version matrix.

The UserFunctions extension provides a set of dynamic parser functions that trigger on the current user.

Contents

UsageEdit

The following four functions are always available for use:

  • {{#ifanon:then|else}}
Tests whether the current user is anonymous.
  • {{#ifblocked:then|else}}
Tests whether the current user is blocked.
  • {{#ifsysop:then|else}}
Tests whether the current user is a sysop.
  • {{#ifingroup:group|then|else}}
Tests whether the current user is a member of the group "group". You can check for multiple groups as well:
{{#ifingroup:group1, group2, group3|then|else}}

The following five personal data functions are disabled by default (see here for how to enable them):

  • {{#realname:alt}}
Returns the current user's real name. If the user is not logged in, this function returns the given alternate text, or the user IP if no alternate is provided.
  • {{#username:alt}}
Returns the current username. If the user is not logged in, this function returns the given alternate text, or the user IP if no alternate is provided.
  • {{#useremail:alt}}
Returns the current user's e-mail address. If the user is not logged in, this function returns the given alternate text, or the user IP if no alternate is provided.
  • {{#nickname:alt}}
Returns the current user's nickname. If the user has no nickname, returns the username. If the user is not logged in, this function returns the given alternate text, or the user IP if no alternate is provided.
  • {{#ip:}}
Returns the current user's IP address.
By default functions are only enabled in NS_MEDIAWIKI namespace, for enabling them in other namespaces, see the examples below.
If you are using these functions within you wiki's sidebar, you cannot set $wgEnableSidebarCache = true;.

InstallationEdit

  • Download and place the file(s) in a directory called UserFunctions in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/UserFunctions/UserFunctions.php";
    
  • If you want to use the following functions: #realname, #username, #useremail, #nickname and #ip, add:
    $wgUFEnablePersonalDataFunctions = true;
    
    just after that line.
  • If you want to enable functions in other namespaces apart from NS_MEDIAWIKI (default), follow the model of some of the examples below.
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Allowing namespacesEdit

By default, user functions only work in NS_MEDIAWIKI namespace.

Below there are some examples of allowing or disallowing the functions to work in other namespaces. The syntax is based on the one used with subpages.

// Enable user functions additionally in namespace "Main"
// Adds values to the existing array
$wgUFAllowedNamespaces[NS_MAIN] = true;
// Enable user functions in namespaces "Main" and "User", but not in namespace "MediaWiki"
// Replaces values in the existing array
$wgUFAllowedNamespaces = array(
        NS_MAIN => true
        NS_USER => true
);
// Enable user functions in namespaces with the indexes from 0 to 200
// Replaces values in the existing array
$wgUFAllowedNamespaces = array_fill(0, 200, true);

More info on namespace numbering.

In other contexts (recognized as NS -1, but not always a Special Page), such as in Page Forms pages, check you have the following parameter enabled:

$wgUFEnableSpecialContexts = true;

The parameter above is enabled by default.

If you experience any problem with bots or maintenance scripts, turn it to false and report it to this talk page.

Version historyEdit

Authors: Algorithm and others

  • Version 2.7.0 (2017-07-26) Removed PHP i18n shim - Kghbln
  • Version 2.6.1 (2014-11-15) Provided syntax changes - Kghbln, Umherirrender
  • Version 2.6.0 (2014-09-18) Composer-compatible extension - Toniher
  • Version 2.5.0 (2014-04-01) Migrated to JSON i18n - Siebrand
  • Version 2.4.3 (2014-03-16) Accumulated fixes and code cleaning - Chad and Uckelman
  • Version 2.4.2 (2013-04-08) Some code cleaning - Reedy
  • Version 2.4.1 (2012-07-17) Fixed problems with Sidebar (report Kghbln). Cleared PHP warnings in functions - Toniher
  • Version 2.4 (2012-06-02) Cleaned using current ParserFunctions models. Fix when editing Semantic Forms - Toniher
  • Version 2.3 (2012-05-27) fixed problems when using scripts and allowed multiple groups to be checked against in ifingroup. - Toniher
  • Version 2.2 (2012-01-03) added $wgUFAllowedNamespaces parameter. Users need to define in which allowed NS functions will work. - Toniher
  • Version 2.1 (2011-12-21) added $wgUFEnablePersonalDataFunctions parameter. Migrated $wgUser to ParserOptions equivalent - Toniher
  • Version 2.0 (2011-12-13) added i18n and compatibility with other parser function extensions - Toniher
  • Version 1.5 (2011-10-30) added ip - Kghbln
  • Version 1.4 (2011-09-27) added realname - Kghbln
  • Version 1.3 (2010-02-13) added useremail - Wikinaut
  • Version 1.2 (2008-07-25) added ifingroup - Louperivois
  • Version 1.1 (2008-06-27) added nickname - Lexw
  • Version 1.0 (2006-05-21) - Algorithm
English  • 日本語