Extension:OnlineStatus

MediaWiki extensions manual

OnlineStatus Release status: stable
Implementation	Variable, Parser function
Description	add a preference to show if the user is currently present or not on the wiki
Author(s)	IAlextalk
Latest version	2012-05-25 (continuous updates)
MediaWiki	1.20.3 for the current version 1.19.0 for the current version 1.16 alpha for the current version 1.11.0 for older versions
Database changes	No
License	GNU General Public License 2.0 or later
Download	Download snapshot (Git master) Git [?]: repo summary browse file tree commit history
Parameters $wgAllowAnyUserOnlineStatusFunction
Hooks used ParserFirstCallInit MagicWordwgVariableIDs LanguageGetMagic ParserGetVariableValueSwitch GetPreferences PersonalUrls BeforePageDisplay UserToggles UserLoginComplete UserLogoutComplete
Translate the OnlineStatus extension if it is available at translatewiki.net
Check usage and version matrix; code metrics
Phabricator:	Open tasks · Report a bug

This extension adds a preference to allow each user to select his status and show it on his user (talk) page. The user can use {{ONLINESTATUS}} or {{RAWONLINESTATUS}} to show it. It will also add a subtitle on the page if he checked the check box in his preferences.

Installation

• Download and extract the tarball in your extensions/ folder. It should generate a new folder called OnlineStatus directly inside your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php:

require_once "$IP/extensions/OnlineStatus/OnlineStatus.php";

• Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Running it

After installing the extension, there will be a new preference that will allow users to select his status and a check box to select if the status should also be displayed with a subtitle. You can display it using:

• {{ONLINESTATUS}}: a formatted (and translated) string describing the status (exactly the same you can see near the radio boxes in Special:Preferences).
• {{RAWONLINESTATUS}}: the internal name of the level.
• {{#anyuseronlinestatus:}}: get online status of any user on any page, if you want the raw version, pass a non empty second parameter.

Note that {{ONLINESTATUS}} and {{RAWONLINESTATUS}} can only be used on user (talk) pages and subpages.
The status can be set in MediaWiki:Onlinestatus-levels, one status per line and each line containing a status has to begin with *. If you add new status, you'll have to create two new messages per status:

• MediaWiki:Onlinestatus-toggle-name: will appear on Special:Preferences and {{ONLINESTATUS}} magic word
• MediaWiki:Onlinestatus-subtitle-name: will be the subtitle of user page if he select this status.

Configuration

The extension also add {{#anyuseronlinestatus:}} parser function that allows to fetch status of any user in the wiki. If you don't want this feature, set $wgAllowAnyUserOnlineStatusFunction to false in LocalSettings.php file.

See also

• bug 13520, for the idea of this extension
• Extension:OnlineStatusBar