MediaWiki extensions manual

UserFunctions Release status: stableCategory:Stable extensions
Implementation	Parser function Category:Parser function extensions
Description	Provides a set of parser functions that trigger on the current user
Author(s)	Algorithm, Toniher, Universal Omega, and others
Latest version	2.8.1 (2022-07-20)
MediaWiki	1.35+Category:Extensions with manual MediaWiki version
PHP	7.2+
Database changes	No
Composer	mediawiki/user-functionsCategory:Extensions supporting Composer
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Browse repository (Phabricator · GitHub) Gerrit code review Git commit log Download source tarball Category:Extensions in Wikimedia version control
Example	sandbox.semantic-mediawiki.org
Parameters $wgUFEnabledPersonalDataFunctions $wgUFAllowedNamespaces $wgUFEnableSpecialContexts
Hooks used ParserFirstCallInit Category:ParserFirstCallInit extensions ParserClearState Category:ParserClearState extensions
Quarterly downloads	29 (Ranked 87th)
Translate the UserFunctions extension if it is available at translatewiki.net

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

Usage

Installation

• Download and move the extracted UserFunctions 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/UserFunctions
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'UserFunctions' );
  

• If you want to use any of the following functions: #realname, #username, #useremail, #nickname or #ip, add the following just after that line:

  $wgUFEnabledPersonalDataFunctions = [
  	'ip',
  	'nickname',
  	'realname',
  	'useremail',
  	'username',
  ];
  

If you are using an older version of the extension, the functions were included in bulk via: $wgUFEnablePersonalDataFunctions = true;

• 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 namespaces

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 = [
        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 history

Authors: Algorithm and others

• Version 2.8.1 (20 July 2022) Allow disabling/enabling specific personal data functions - Universal Omega

Prior to this, the $wgUFEnabledPersonalDataFunctions configuration variable was named $wgUFEnablePersonalDataFunctions, and setting it to true would enable all personal data functions, and was only able to enable/disable all of them or none of them.

• Version 2.8.0 (18 April 2021) Convert to ExtensionRegistry and other code cleanups - Universal Omega
• Version 2.7.0 (26 July 2017) Removed PHP i18n shim - Kghbln
• Version 2.6.1 (15 November 2014) Provided syntax changes - Kghbln, Umherirrender
• Version 2.6.0 (18 September 2014) Composer-compatible extension - Toniher
• Version 2.5.0 (1 April 2014) Migrated to JSON i18n - Siebrand
• Version 2.4.3 (16 March 2014) Accumulated fixes and code cleaning - Chad Uckelman
• Version 2.4.2 (8 April 2013) Some code cleaning - Reedy
• Version 2.4.1 (17 July 2012) Fixed problems with Sidebar (report Kghbln). Cleared PHP warnings in functions - Toniher
• Version 2.4 (2 June 2012) Cleaned using current ParserFunctions models. Fix when editing Semantic Forms - Toniher
• Version 2.3 (27 May 2012) fixed problems when using scripts and allowed multiple groups to be checked against in ifingroup. - Toniher
• Version 2.2 (3 January 2012) added $wgUFAllowedNamespaces parameter. Users need to define in which allowed NS functions will work. - Toniher
• Version 2.1 (21 December 2011) added $wgUFEnablePersonalDataFunctions parameter. Migrated $wgUser to ParserOptions equivalent - Toniher
• Version 2.0 (13 December 2011) added i18n and compatibility with other parser function extensions - Toniher
• Version 1.5 (30 October 2011) added ip - Kghbln
• Version 1.4 (27 September 2011) added realname - Kghbln
• Version 1.3 (13 February 2010) added useremail - Wikinaut
• Version 1.2 (25 July 2008) added ifingroup - Louperivois
• Version 1.1 (27 June 2008) added nickname - Lexw
• Version 1.0 (21 May 2006) Algorithm

Issues and feature requests

• Please report them on the talk page.

Troubleshooting

Invalid magic word

If you are getting an error that looks like this Error: invalid magic word 'ifanon', then you should try rebuilding the localization cache. The functions within this extension will not load correctly without this extension's localization information within the cache.

See also

• Extension:RightFunctions
• Extension:MyVariables

This extension is included in the following wiki farms/hosts and/or packages: BlueSpice Category:Extensions included in BlueSpice Canasta Category:Extensions included in Canasta Miraheze Category:Extensions included in Miraheze ProWikiCategory:Extensions included in ProWiki semantic::coreCategory:Extensions included in semantic::core WikiForgeCategory:Extensions included in WikiForge This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm.