Extension:GlobalPreferences

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

Release status:Extension status beta

ImplementationTemplate:Extension#type Special page
DescriptionTemplate:Extension#description Allows a user to set global (wikifarm-wide) user preferences
Author(s)Template:Extension#username Kunal Mehta (Legoktmtalk)
Latest versionTemplate:Extension#version 0.1.2 (2015-11-27; 2 years ago (2015-11-27))
MediaWikiTemplate:Extension#mediawiki 1.25+
Database changesTemplate:Extension#needs-updatephp Yes
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
ParametersTemplate:Extension#parameters
  • $wgGlobalPreferencesDB
Hooks usedTemplate:Extension#hook
UserLoadOptionsManual:Hooks/UserLoadOptions
UserSaveOptionsManual:Hooks/UserSaveOptions
LoadExtensionSchemaUpdatesManual:Hooks/LoadExtensionSchemaUpdates
PreferencesFormPreSaveManual:Hooks/PreferencesFormPreSave
GetPreferencesManual:Hooks/GetPreferences

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

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

The GlobalPreferences extension allows a user to decide which user preferences to set as global (wikifarm-wide) and which to keep local. For example, you can set your skin to be the same on all wikis, but have different watchlist settings on different wikis.


By default,$wgSharedTables includes the user_properties database table. One global preferences table is enough for most use cases, but this extension is useful for use cases such as:

  • One wiki has a preference hidden with $wgHiddenPrefs, and another doesn't.
  • A user wants to set a different skin on each wiki
  • Two wikis have two different gadgets named the same.
  • A wiki has an extension installed which sets a preference, but that extension is not enabled on another wiki in the farm
  • etc.

Installation[edit]

  • Download and place the file(s) in a directory called GlobalPreferences in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'GlobalPreferences' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters[edit]

  • $wgGlobalPreferencesDB : Database to store preferences in. If null, uses $wgDBname.

See also[edit]