Manual:$wgExtensionCredits

From MediaWiki.org
Jump to: navigation, search
Extensions: $wgExtensionCredits
Global list of extension credits
Introduced in version: 1.5.0 (r10074)
Removed in version: still in use
Allowed values: See details
Default value: array()

Other settings: Alphabetical | By Function


Contents

[edit] Details

An array of extension types and inside that their names, versions, authors, URLs, descriptions and pointers to localized description messages. Note that the version, url, description and descriptionmsg keys can be omitted.

This credit information gets added to the wiki's Special:Version page, allowing users to see which extensions are installed, and to find more information about them.

This is not a configuration setting mentioned in LocalSettings.php. Typically, extension developers will write code that appends to the array contained in this global variable.

See Manual:Developing extensions#Registering features with MediaWiki

[edit] Usage

Extension developers can append to the array with the following code:

$wgExtensionCredits[$type][] = array(
        'path' => __FILE__,     // File name for the extension itself, required for getting the revision number from SVN - string, adding in 1.15
        'name' => "",           // Name of extension - string
        'description' => "",    // Description of what the extension does - string
        'descriptionmsg' => "", // Same as above but name of a message, for i18n - string, added in 1.12.0
        'version' => 0,         // Version number of extension - number or string
        'author' => "",         // The extension author's name - string or array for multiple
        'url' => "",            // URL of extension (usually instructions) - string
);

In version 1.12 and newer, descriptionmsg will override description. The value of descriptionmsg will be treated as the name of the message used for the description.

$type must be one of the following:

  • media (added in 1.11) - media handlers
  • parserhook - extensions that modify, add or replace functionality in the MediaWiki parser
  • specialpage - extensions that add special pages
  • variable (added in 1.6.0) - make a new variable
  • other - does something else

The description and author fields get parsed as wiki syntax. This is often used to provide links to the author's homepage in the author field.

Since r81549 (mw 1.18?), the author list can contain the special hackish '...' to denote other authors. The triple dot will makes MediaWiki insert the version-poweredby-others message.

Example:

$wgExtensionCredits['other'][] = array(
 'author' => array( 'Mr Smith', '...' ),
);

[edit] Example

$wgExtensionCredits['specialpage'][] = array(
        'path' => __FILE__,
        'name' => 'Example extension',
        'version' => 1.9,
        'author' => 'Foo Barstein',
        'url' => 'https://www.mediawiki.org/wiki/Extension:MyExtension',
        'descriptionmsg' => 'exampleextension-desc',
);

[edit] See also

Gnome-preferences-other.svg Extensions: Tag Extensions Parser Functions Hooks Special Pages Skins Magic Words
Language: English  • 日本語
Personal tools
Namespaces

Variants
Actions
Navigation
Support
Download
Development
Communication
Print/export
Toolbox