Manual:SpecialPage.php

From MediaWiki.org
Jump to: navigation, search

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎日本語 • ‎polski • ‎português • ‎português do Brasil • ‎中文

Description[edit]

SpecialPage.php contains the special page class, and also static functions for handling special pages and lists thereof.

To add a special page in an extension, add to $wgSpecialPages either

  • an object instance, or
  • an array containing the name and constructor parameters (preferred for performance reasons)

The object instantiated must be either an instance of SpecialPage or a sub-class thereof. It must have an execute() method, which sends the HTML for the special page to $wgOutManual:$wgOut. The parent class has an execute() method which distributes the call to the historical global functions. Additionally, execute() also checks if the user has the necessary access privileges and bails out if not.

  • To add a core special page, use the similar static list in SpecialPageFactory::$coreList.
  • To remove a core static special page at runtime, use a initList hook.

See also[edit]