Extension:RightFunctions/Doc

RightFunctions is an extension that adds permission-based parser functions. Please note that these extensions may be used to superficially hide information from those with certain rights. Also, all of these functions disable the cache on the page they are used in unless you set $wgRightFunctionsAllowCaching to true. For installation instructions, please view the main extension page.

Usage
As of now, RightFunctions defines nine parser functions, ifright, ifallowed, userrights, usergroup, ifgroup, ifpageright, ifpageallowed, ifprotected, and getrestrictions.

Ifright
Tests whether the current user has the given right, then displays the appropriate text. If the right doesn't exist, it simply returns else. If no right is specified, it returns then. This function ignores per-page restrictions on a user's rights, so use if you need that functionality.

Usage:

Ifallowed
Tests whether the given user has the given right, then displays the appropriate text. This function will return nothing unless a user is defined. This function ignores per-page restrictions on a user's rights, so use if you need that functionality.

Usage:

Userrights
Lists all rights in an unordered list either of the current user or of the given user. If a user isn't defined, it triggers on the current user instead.

Usage:  (for current user) or   (for other users)

Usergroup
Returns the highest user group the user belongs to. The groups are defined in lowest-to-highest ranking in the array $wgRightFunctionsUserGroups. If a user isn't defined, it triggers on the current user instead.

Usage:  (for current user) or   (for other users)

Ifgroup
Tests if the given user is in the specified group. If no user is specified, it tests the current user. If no group is specified, it returns else.

Usage:  (for current user) or   (for other users)

Ifpageright
Tests whether the current user has the given right on the given page, then displays the appropriate text. If the right doesn't exist, it simply returns else. If no right is specified, it returns then. This function does not ignore per-page restrictions on a user's rights.

Usage:  for testing other pages or   for testing the current page.

Ifpageallowed
Tests whether the given user has the given right on the given page, then displays the appropriate text. If no user is specified, it returns nothing. If no page is specified, it checks the current page. If the right doesn't exist, it returns else and if no right is specified, it returns then. This function does not ignore per-page restrictions on a user's rights.

Usage:  for testing other pages or   for testing the current page.

Ifprotected
Tests whether the given page is protected, then displays the appropriate text. If no page is given, it tests the current page. It will return then if the page is either fully-protected, semi-protected, protected because it is included in a cascading-protected page, or if it is namespace-protected. You may control which of these are tested by adding the letters "f", "s", "c", and/or "n" (standing for fully-protected, semi-protected, cascading-protected, and namespace-protected, respectively) to the fourth parameter of the page (by default all 4 are tested).

Usage:  for testing other pages, or   for testing the current page or (for example)   for testing only certain types of protection.

Getrestrictions
Grabs what right is required to carry out the action on the given page. If no page is given, it checks the current page instead. If no right is given, it checks the 'edit' right. If there are no restrictions on that page for the particular right, it returns the empty string (""). If the page has cascading restrictions as well, it returns the highest restriction level for the page (from all cascading sources and the local page itself). If you would like all the restrictions to be listed instead, set the third parameter to "true". If you do, the output format changes a bit to "restrictions (from current page), restrictions (from cascading-protected sources)" if there are restrictions on the current page, or just "restrictions (from cascading-protected sources)" if there aren't.

Usage:  for testing other pages, or   for testing the current page or   for listing all restrictions instead of just the highest one.

Variables
These variables control how the various parser functions work. There are currently 4 variables.

$wgRightFunctionsUserGroups
Default value: array('*', 'user', 'autoconfirmed', 'sysop', 'bureaucrat')

An array of groups to test for in. They are arranged in order of least to greatest for group testing.

$wgRightFunctionsAllowCaching
Default value: false

If set to true, the functions do not disable the parser cache and they do not trigger the recache when getting a user's groups. It is recommended that you leave this as false.

$wgRightFunctionsAllowExpensiveQueries
Default value: true

If set to true, using ifpageright and ifpageallowed will check the rights more thoroughly (like through cascading protection), so it will produce more accurate results, but it will me more server-intensive to perform. It is recommended that you leave this as true.

$wgRightFunctionsDisableFunctions
Default value: array

Functions in this array will not get evaluated and will simply return nothing.

Changelog

 * Version 1.7:Fixed title bug (side issue in bug 12420), removed restrictions for viewing other users' rights, removed warnings, added in variable to disable functions, modified ifallowed and ifpageallowed to require a user be defined.
 * Version 1.6:Getrestrictions now only returns the highest-level restriction by default, a list of all restrictions can be had by setting the third parameter true.
 * Version 1.5:Major bugfix in getrestrictions, should now work as expected (yay)
 * Version 1.4:Getrestrictions now checks cascading sources (albeit not very efficiently), now allows user to pick protection types to check for in ifprotected, bugfix in return of getrestrictions.
 * Version 1.3:Cleaned up code for less redundancy, added $wgRightFunctionsAllowCaching to allow caching, added ifgroup, made usergroup actually work off of real user groups instead of rights that mimicked group names, changed $wgRightFunctionsOtherUsers to test groups instead of rights. $wgRightFunctionsAllowExpensiveQueries is now true by default.
 * Version 1.2:Added four parser functions ifpageright, ifpageallowed, ifprotected, and getrestrictions. Added in variable for hiding warning messages and a variable for enabling more server-intensive queries for the ifpageright and ifpageallowed functions.
 * Version 1.1:Added safeguard against those trying to access extension directly, and an additional parser function usergroup.
 * Version 1.0:Initial release defined three parser functions, ifright, ifallowed, and userrights.

Please note that versions less than 1.2 were not placed on mediawiki.org. If you want the source for a version earlier than 1.2, please leave a message on my talk page.