Extension:GlobalUserPage

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
GlobalUserPage

Release status:Extension status beta

ImplementationTemplate:Extension#type User interface
DescriptionTemplate:Extension#description Enables global (shared between wikis) user pages on a wiki farm.
Author(s)Template:Extension#username Jack Phoenix, Kunal Mehta
Latest versionTemplate:Extension#version 0.11.0 (2015-02-06; 2 years ago (2015-02-06))
MediaWikiTemplate:Extension#mediawiki 1.29+
PHPTemplate:Extension#php 5.5.9+
LicenseTemplate:Extension#license Creative Commons Zero v1.0 Universal or later
Download
ExampleTemplate:Extension#example ShoutWiki
ParametersTemplate:Extension#parameters
  • $wgGlobalUserPageCacheExpiry
  • $wgGlobalUserPageAPIUrl
  • $GlobalUserPageTimeout
  • $GlobalUserPageFooterKey
  • $wgGlobalUserPageDBname
Hooks usedTemplate:Extension#hook
GetPreferencesManual:Hooks/GetPreferences
TitleIsAlwaysKnownManual:Hooks/TitleIsAlwaysKnown
ArticleFromTitleManual:Hooks/ArticleFromTitle
LinksUpdateCompleteManual:Hooks/LinksUpdateComplete
PageContentInsertCompleteManual:Hooks/PageContentInsertComplete
ArticleDeleteCompleteManual:Hooks/ArticleDeleteComplete
TitleGetEditNoticesManual:Hooks/TitleGetEditNotices
GetDoubleUnderscoreIDsManual:Hooks/GetDoubleUnderscoreIDs
WikiPageFactoryManual:Hooks/WikiPageFactory

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

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

GlobalUserPage enables global (shared between wikis) user pages on a wiki farm.

This extension was developed by Jack Phoenix for ShoutWiki, originally based on the HelpPages extension by Kunal Mehta (the extensions no longer share any code).

User documentation[edit]

See Help:Extension:GlobalUserPage.

Installation[edit]

  • Download and place the file(s) in a directory called GlobalUserPage in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'GlobalUserPage' );
    
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Caveats[edit]

Using this extension comes with a few security risks. You must absolutely trust the central wiki and its admins, as they can easily insert raw HTML into your wiki, opening up XSS holes and other bad things.

Parameters[edit]

$wgGlobalUserPageAPIUrl is the URL to the central wiki's api.php. This URL is internally used to fetch the global user page's text.

$wgGlobalUserPageCacheExpiry controls how long to cache the rendered HTML for; the default is 60 * 60 * 24 * 7 (one week). The HTML is usually invalidated upon editing, but this is a worst case fallback.

$wgGlobalUserPageDBname is the name of the database where global user page data is stored, i.e. usually this should be set to the same value as $wgSharedDB.

$wgGlobalUserPageFooterKey message key to add as a footer to the bottom of global user pages, or false if no footer should be added.

$wgGlobalUserPageTimeout Timeout for internal API requests, to use $wgHTTPTimeout set this to the string "default".