MediaWiki  master
SpecialPage Class Reference

Parent class for all special pages. More...

Inheritance diagram for SpecialPage:
Collaboration diagram for SpecialPage:

Public Member Functions

 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ( $subPage)
 Default execute method Checks user permissions. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 getDescription ()
 Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages. More...
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page Stable to override. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}} Stable to override. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages Stable to override. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Static Public Member Functions

static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage. More...
 
static getTitleFor ( $name, $subpage=false, $fragment='')
 Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 

Protected Member Functions

 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have Stable to override. More...
 
 getCacheTTL ()
 Stable to override. More...
 
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! Stable to override. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Static Protected Member Functions

static prefixSearchArray ( $search, $limit, array $subpages, $offset)
 Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). More...
 

Protected Attributes

IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Private Attributes

HookContainer null $hookContainer
 
HookRunner null $hookRunner
 
MediaWiki Linker LinkRenderer null $linkRenderer
 
 $mListed
 
 $mLocalName
 

Detailed Description

Parent class for all special pages.

Includes some static functions for handling the special page list deprecated in favor of SpecialPageFactory.

Stable to extend

Definition at line 41 of file SpecialPage.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialPage::__construct (   $name = '',
  $restriction = '',
  $listed = true,
  $function = false,
  $file = '',
  $includable = false 
)

Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

If you override execute(), you can recover the default behavior with userCanExecute() and displayRestrictionError()

Stable to call

Parameters
string$nameName of the special page, as seen in links and URLs
string$restrictionUser right required, e.g. "block" or "delete"
bool$listedWhether the page is listed in Special:Specialpages
callable | bool$functionUnused
string$fileUnused
bool$includableWhether the page can be included in normal pages

Definition at line 150 of file SpecialPage.php.

Member Function Documentation

◆ addFeedLinks()

SpecialPage::addFeedLinks (   $params)
protected

Adds RSS/atom links.

Parameters
array$params

Definition at line 846 of file SpecialPage.php.

References getConfig(), getOutput(), wfAppendQuery(), and wfScript().

Referenced by SpecialContributions\execute(), SpecialRecentChanges\outputFeedLinks(), and SpecialWatchlist\outputFeedLinks().

◆ addHelpLink()

SpecialPage::addHelpLink (   $to,
  $overrideBaseUrl = false 
)

Adds help link with an icon via page indicators.

Link target can be overridden by a local message containing a wikilink: the message key is: lowercase special page name + '-helppage'.

Parameters
string$toTarget MediaWiki.org page title or encoded URL.
bool$overrideBaseUrlWhether $url is a full URL, to avoid MW.o.
Since
1.25

Definition at line 864 of file SpecialPage.php.

References getName(), getOutput(), including(), Skin\makeUrl(), and msg().

Referenced by SpecialUncategorizedImages\__construct(), SpecialUncategorizedPages\__construct(), SpecialChangeContentModel\alterForm(), SpecialBlock\alterForm(), SpecialListFiles\execute(), SpecialCategories\execute(), SpecialProtectedpages\execute(), SpecialProtectedtitles\execute(), SpecialSpecialpages\execute(), SpecialLog\execute(), SpecialNewFiles\execute(), SpecialTrackingCategories\execute(), SpecialPreferences\execute(), SpecialContributions\execute(), SpecialExport\execute(), SpecialListGroupRights\execute(), SpecialApiSandbox\execute(), SpecialUnblock\execute(), SpecialDeletedContributions\execute(), SpecialAllMessages\execute(), SpecialWhatLinksHere\execute(), SpecialBlockList\execute(), SpecialPasswordPolicies\execute(), SpecialAutoblockList\execute(), SpecialComparePages\execute(), SpecialTags\execute(), SpecialExpandTemplates\execute(), SpecialLinkSearch\execute(), SpecialMute\execute(), SpecialWatchlist\execute(), SpecialBotPasswords\execute(), UserrightsPage\execute(), SpecialUnwatchedPages\execute(), SpecialListDuplicatedFiles\execute(), SpecialNewpages\execute(), SpecialListRedirects\execute(), SpecialRecentChanges\execute(), SpecialUpload\execute(), SpecialMIMESearch\execute(), SpecialBrokenRedirects\execute(), SpecialUndelete\execute(), SpecialDoubleRedirects\execute(), SpecialRecentChangesLinked\getExtraOptions(), SpecialRandomInCategory\getFormFields(), SpecialSearch\setupPage(), MovePageForm\showForm(), SpecialEditTags\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), SpecialMergeHistory\showMergeForm(), SpecialNewSection\showNoRedirectPage(), SpecialPermanentLink\showNoRedirectPage(), and SpecialDiff\showNoRedirectPage().

◆ afterExecute()

SpecialPage::afterExecute (   $subPage)
protected

Gets called after.

See also
SpecialPage::execute.

Stable to override

Since
1.20
Parameters
string | null$subPage

Reimplemented in SpecialCachedPage.

Definition at line 628 of file SpecialPage.php.

Referenced by run().

◆ beforeExecute()

SpecialPage::beforeExecute (   $subPage)
protected

Gets called before.

See also
SpecialPage::execute. Return false to prevent calling execute() (since 1.27+).

Stable to override

Since
1.20
Parameters
string | null$subPage
Returns
bool|void

Reimplemented in LoginSignupSpecialPage, AuthManagerSpecialPage, and SpecialUserLogin.

Definition at line 616 of file SpecialPage.php.

Referenced by run().

◆ buildPrevNextNavigation()

SpecialPage::buildPrevNextNavigation (   $offset,
  $limit,
array  $query = [],
  $atend = false,
  $subpage = false 
)
protected

Generate (prev x| next x) (20|50|100...) type links for paging.

Parameters
int$offset
int$limit
array$queryOptional URL query parameter string
bool$atendOptional param for specified if this is the last page
string | bool$subpageOptional param for specifying subpage
Returns
string

Definition at line 970 of file SpecialPage.php.

References $title, and getPageTitle().

Referenced by QueryPage\execute(), and SpecialSearch\showResults().

◆ checkLoginSecurityLevel()

SpecialPage::checkLoginSecurityLevel (   $level = null)
protected

Verifies that the user meets the security level, possibly reauthenticating them in the process.

This should be used when the page does something security-sensitive and needs extra defense against a stolen account (e.g. a reauthentication). The authentication framework will make an extra effort to make sure the user account is not compromised. What that exactly means will depend on the system and user settings; e.g. the user might be required to log in again unless their last login happened recently, or they might be given a second-factor challenge.

Calling this method will result in one if these actions:

  • return true: all good.
  • return false and set a redirect: caller should abort; the redirect will take the user to the login page for reauthentication, and back.
  • throw an exception if there is no way for the user to meet the requirements without using a different access method (e.g. this functionality is only available from a specific IP).

Note that this does not in any way check that the user is authorized to use this special page (use checkPermissions() for that).

Parameters
string | null$levelA security level. Can be an arbitrary string, defaults to the page name.
Returns
bool False means a redirect to the reauthentication page has been set and processing of the special page should be aborted.
Exceptions
ErrorPageErrorIf the security level cannot be met, even with reauthentication.

Definition at line 436 of file SpecialPage.php.

References $title, MWCryptRand\generateHex(), getFullTitle(), getName(), getOutput(), getRequest(), getTitleFor(), PROTO_HTTPS, setReauthPostData(), wfArrayToCgi(), and wfMessage().

Referenced by FormSpecialPage\execute(), and execute().

◆ checkPermissions()

◆ checkReadOnly()

◆ displayRestrictionError()

SpecialPage::displayRestrictionError ( )
protected

Output an error message telling the user what access level they have to have Stable to override.

Exceptions
PermissionsError

Definition at line 331 of file SpecialPage.php.

Referenced by SpecialUndelete\checkPermissions(), and checkPermissions().

◆ doesWrites()

◆ execute()

SpecialPage::execute (   $subPage)

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Stable to override

Parameters
string | null$subPage

Reimplemented in ChangesListSpecialPage, LoginSignupSpecialPage, SpecialRecentChanges, SpecialPageData, SpecialUploadStash, SpecialWatchlist, DisabledSpecialPage, SpecialExpandTemplates, SpecialChangeCredentials, RedirectSpecialPage, SpecialLinkAccounts, SpecialUnlinkAccounts, SpecialRunJobs, QueryPage, SpecialDoubleRedirects, SpecialUndelete, SpecialBrokenRedirects, FormSpecialPage, SpecialMIMESearch, SpecialUpload, SpecialListRedirects, SpecialNewpages, SpecialRevisionDelete, SpecialSearch, SpecialMergeHistory, SpecialEmailUser, SpecialListDuplicatedFiles, SpecialFileDuplicateSearch, SpecialUnwatchedPages, UserrightsPage, MovePageForm, SpecialPasswordReset, SpecialEditTags, SpecialImport, SpecialVersion, SpecialBotPasswords, SpecialChangeEmail, SpecialPagesWithProp, SpecialResetTokens, SpecialMute, SpecialLinkSearch, RandomPage, SpecialAllPages, SpecialUserLogout, SpecialComparePages, SpecialTags, SpecialPrefixindex, SpecialAutoblockList, SpecialPasswordPolicies, SpecialBlockList, SpecialAllMessages, SpecialWhatLinksHere, SpecialDeletedContributions, SpecialUnblock, SpecialApiSandbox, SpecialListGroupRights, SpecialExport, SpecialGoToInterwiki, SpecialContributions, SpecialListUsers, SpecialPreferences, SpecialStatistics, SpecialListGrants, SpecialTrackingCategories, WantedPagesPage, SpecialWithoutInterwiki, SpecialActiveUsers, SpecialCategories, SpecialLog, SpecialNewFiles, SpecialProtectedpages, SpecialProtectedtitles, SpecialSpecialpages, SpecialApiHelp, SpecialBlankpage, SpecialJavaScriptTest, SpecialListFiles, SpecialEditWatchlist, SpecialBookSources, SpecialConfirmEmail, and SpecialEmailInvalidate.

Definition at line 642 of file SpecialPage.php.

References checkLoginSecurityLevel(), checkPermissions(), getLoginSecurityLevel(), outputHeader(), and setHeaders().

Referenced by run().

◆ getCacheTTL()

SpecialPage::getCacheTTL ( )
protected

Stable to override.

Returns
int Seconds that this page can be cached

Reimplemented in SpecialRecentChanges, and SpecialNewpages.

Definition at line 242 of file SpecialPage.php.

Referenced by maxIncludeCacheTime().

◆ getConfig()

SpecialPage::getConfig ( )

Shortcut to get main config object.

Returns
Config
Since
1.24

Definition at line 794 of file SpecialPage.php.

References getContext().

Referenced by SpecialRecentChanges\__construct(), SpecialWatchlist\__construct(), SpecialEditWatchlist\__construct(), addFeedLinks(), SpecialRecentChanges\addWatchlistJoins(), SpecialPasswordReset\alterForm(), SpecialNewFiles\buildForm(), SpecialUnlockdb\checkExecutePermissions(), SpecialLockdb\checkExecutePermissions(), SpecialBotPasswords\checkExecutePermissions(), SpecialImport\doImport(), MovePageForm\doSubmit(), SpecialTags\doTagRow(), SpecialLog\execute(), SpecialListGrants\execute(), SpecialTrackingCategories\execute(), SpecialRunJobs\execute(), SpecialContributions\execute(), SpecialExport\execute(), SpecialListGroupRights\execute(), SpecialDeletedContributions\execute(), SpecialAllMessages\execute(), SpecialWhatLinksHere\execute(), SpecialPasswordPolicies\execute(), SpecialExpandTemplates\execute(), SpecialAllPages\execute(), SpecialLinkSearch\execute(), SpecialWatchlist\execute(), SpecialImport\execute(), SpecialVersion\execute(), SpecialEmailUser\execute(), SpecialSearch\execute(), ChangesListSpecialPage\execute(), QueryPage\execute(), SpecialNewpages\feed(), SpecialNewpages\feedTitle(), UserrightsPage\fetchUser(), LoginSignupSpecialPage\getAuthForm(), QueryPage\getDBLimit(), SpecialVersion\getEntryPointInfo(), SpecialVersion\getExtensionCategory(), SpecialRecentChanges\getFeedQuery(), SpecialPageLanguage\getFormFields(), SpecialPasswordReset\getFormFields(), SpecialBlock\getFormFields(), SpecialStatistics\getGroupStats(), SpecialActiveUsers\getIntroText(), SpecialProtectedtitles\getLevelMenu(), SpecialProtectedpages\getLevelMenu(), QueryPage\getLimitOffset(), ChangesListSpecialPage\getLinkDays(), SpecialImport\getMappingFormPart(), QueryPage\getMaxResults(), SpecialUnusedImages\getPageHeader(), SpecialExport\getPagesFromCategory(), SpecialExport\getPagesFromNamespace(), SpecialStatistics\getPageStats(), SpecialShortPages\getQueryInfo(), SpecialUnusedImages\getQueryInfo(), WantedPagesPage\getQueryInfo(), SpecialLinkSearch\getQueryInfo(), SpecialRemoveCredentials\getRequestBlacklist(), SpecialLinkAccounts\getRequestBlacklist(), SpecialUnlinkAccounts\getRequestBlacklist(), SpecialChangeCredentials\getRequestBlacklist(), SpecialResetTokens\getTokensList(), SpecialStatistics\getUserStats(), SpecialSearch\goResult(), ChangesListSpecialPage\includeRcFiltersApp(), QueryPage\isCached(), QueryPage\isExpensive(), SpecialBotPasswords\isListed(), SpecialLinkSearch\linkParameters(), LoginSignupSpecialPage\loadRequestParameters(), maxIncludeCacheTime(), SpecialUnlockdb\onSubmit(), SpecialLockdb\onSubmit(), SpecialPasswordReset\onSuccess(), SpecialRecentChanges\optionsPanel(), SpecialRecentChanges\outputChangesList(), SpecialAllPages\outputHTMLForm(), SpecialListGroupRights\outputNamespaceProtectionInfo(), SpecialUploadStash\outputRemoteScaledThumb(), SpecialUploadStash\outputThumbFromStash(), SpecialBlock\preText(), SpecialUpload\processUpload(), SpecialUpload\processVerificationError(), ChangesListSpecialPage\registerFilters(), SpecialJavaScriptTest\renderPage(), SpecialBotPasswords\save(), setHeaders(), MovePageForm\showForm(), SpecialImport\showForm(), SpecialUndelete\showHistory(), SpecialExpandTemplates\showHtmlPreview(), SpecialWhatLinksHere\showIndirectLinks(), SpecialSearch\showResults(), SpecialUndelete\showRevision(), SpecialUndelete\undelete(), SpecialExport\validateLinkDepth(), and ChangesListSpecialPage\validateOptions().

◆ getContext()

SpecialPage::getContext ( )

Gets the context this SpecialPage is executed in.

Returns
IContextSource|RequestContext
Since
1.18

Definition at line 717 of file SpecialPage.php.

References $mContext, RequestContext\getMain(), and wfDebug().

Referenced by MergeHistoryPager\__construct(), SpecialActiveUsers\buildForm(), SpecialBookSources\buildForm(), SpecialUndelete\diffHeader(), SpecialImport\doImport(), SpecialTags\doTagRow(), SpecialListFiles\execute(), SpecialApiHelp\execute(), SpecialCategories\execute(), SpecialNewFiles\execute(), SpecialActiveUsers\execute(), SpecialContributions\execute(), SpecialPreferences\execute(), SpecialStatistics\execute(), SpecialListUsers\execute(), SpecialExport\execute(), SpecialDeletedContributions\execute(), SpecialUnblock\execute(), SpecialAllMessages\execute(), SpecialBlockList\execute(), SpecialAutoblockList\execute(), SpecialComparePages\execute(), SpecialExpandTemplates\execute(), SpecialLinkSearch\execute(), SpecialPagesWithProp\execute(), SpecialFileDuplicateSearch\execute(), SpecialEmailUser\execute(), SpecialNewpages\form(), SpecialListGroupRights\formatPermissions(), PageQueryPage\formatResult(), SpecialMostLinkedCategories\formatResult(), SpecialFewestRevisions\formatResult(), SpecialMostCategories\formatResult(), SpecialMostInterwikis\formatResult(), SpecialMostLinkedTemplates\formatResult(), SpecialMostLinked\formatResult(), SpecialUnwatchedPages\formatResult(), SpecialShortPages\formatResult(), SpecialProtectedtitles\formatRow(), SpecialExpandTemplates\generateHtml(), AuthManagerSpecialPage\getAuthForm(), LoginSignupSpecialPage\getAuthForm(), SpecialEditWatchlist\getClearForm(), getConfig(), SpecialUpload\getDupeWarning(), SpecialRecentChanges\getExtraOptions(), FormSpecialPage\getForm(), SpecialContributions\getForm(), getFullTitle(), getLanguage(), SpecialEditTags\getList(), SpecialRevisionDelete\getList(), SpecialEditWatchlist\getNormalForm(), getOutput(), SpecialWithoutInterwiki\getPageHeader(), SpecialMIMESearch\getPageHeader(), SpecialEditWatchlist\getRawForm(), AuthManagerSpecialPage\getRequest(), getRequest(), getSkin(), SpecialUpload\getUploadForm(), getUser(), SpecialExpandTemplates\makeForm(), ChangesListSpecialPage\makeLegend(), ChangesListStringOptionsFilterGroup\modifyQuery(), ChangesListBooleanFilter\modifyQuery(), msg(), SpecialPrefixindex\namespacePrefixForm(), SpecialPageLanguage\onSubmit(), SpecialChangeContentModel\onSubmit(), SpecialRecentChanges\outputChangesList(), SpecialWatchlist\outputChangesList(), SpecialAllPages\outputHTMLForm(), ImageQueryPage\outputResults(), SpecialTags\processCreateTagForm(), SpecialEmailUser\sendEmailForm(), AuthManagerSpecialPage\setRequest(), LoginSignupSpecialPage\setSessionUserForCurrentRequest(), SpecialLog\show(), SpecialTags\showActivateDeactivateForm(), SpecialAllPages\showChunk(), SpecialTags\showDeleteTagForm(), SpecialUndelete\showDiff(), UserrightsPage\showEditUserGroupsForm(), SpecialNewSection\showForm(), SpecialPermanentLink\showForm(), SpecialRedirectWithAction\showForm(), SpecialDiff\showForm(), SpecialUndelete\showList(), SpecialProtectedpages\showOptions(), SpecialProtectedtitles\showOptions(), SpecialConfirmEmail\showRequestForm(), SpecialPreferences\showResetForm(), LoginSignupSpecialPage\showReturnToPage(), LoginSignupSpecialPage\showSuccessPage(), SpecialTags\showTagList(), SpecialUploadStash\showUploads(), SpecialPreferences\submitReset(), SpecialUserLogin\successfulAction(), and SpecialEmailUser\userForm().

◆ getDescription()

SpecialPage::getDescription ( )

Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

Derived classes can override this, but usually it is easier to keep the default behavior.

Stable to override

Returns
string

Reimplemented in SpecialEditTags, SpecialMute, SpecialDiff, SpecialCreateAccount, SpecialUserLogin, and SpecialEmailUser.

Definition at line 686 of file SpecialPage.php.

References msg().

Referenced by SpecialNewpages\feedTitle(), and setHeaders().

◆ getFinalGroupName()

SpecialPage::getFinalGroupName ( )

Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

Returns
string Group of this special page
Since
1.21

Definition at line 889 of file SpecialPage.php.

References getGroupName(), getName(), and msg().

◆ getFullTitle()

SpecialPage::getFullTitle ( )

Return the full title, including $par.

Returns
Title
Since
1.18

Definition at line 804 of file SpecialPage.php.

References getContext().

Referenced by checkLoginSecurityLevel(), LoginSignupSpecialPage\execute(), AuthManagerSpecialPage\getAuthForm(), and AuthManagerSpecialPage\handleReauthBeforeExecute().

◆ getGroupName()

SpecialPage::getGroupName ( )
protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Stable to override

Returns
string
Since
1.21

Reimplemented in ChangesListSpecialPage, SpecialUndelete, SpecialBlock, SpecialVersion, LoginSignupSpecialPage, UserrightsPage, MovePageForm, SpecialUpload, SpecialSearch, SpecialContributions, SpecialRevisionDelete, SpecialWhatLinksHere, SpecialImport, SpecialNewpages, SpecialExport, SpecialEmailUser, SpecialTags, SpecialEditTags, SpecialMergeHistory, SpecialBotPasswords, SpecialAllPages, SpecialRedirect, SpecialMediaStatistics, SpecialLog, SpecialRandomInCategory, SpecialStatistics, SpecialPageLanguage, SpecialExpandTemplates, SpecialPrefixindex, SpecialListGroupRights, SpecialUnblock, SpecialFileDuplicateSearch, SpecialPagesWithProp, SpecialBlockList, SpecialLinkSearch, SpecialDeletedContributions, SpecialChangeContentModel, SpecialDoubleRedirects, SpecialMIMESearch, SpecialBookSources, SpecialChangeEmail, SpecialNewFiles, SpecialPasswordReset, SpecialProtectedpages, SpecialBrokenRedirects, SpecialPasswordPolicies, SpecialComparePages, RandomPage, SpecialShortPages, SpecialCreateAccount, SpecialProtectedtitles, SpecialActiveUsers, SpecialAutoblockList, SpecialPreferences, SpecialJavaScriptTest, SpecialListRedirects, SpecialUserLogin, WantedFilesPage, SpecialResetTokens, SpecialDiff, SpecialUnwatchedPages, SpecialMostLinked, SpecialAllMessages, SpecialTrackingCategories, SpecialMostLinkedTemplates, SpecialWantedCategories, SpecialFewestRevisions, SpecialLockdb, SpecialMostInterwikis, SpecialRedirectWithAction, SpecialMostCategories, SpecialWithoutInterwiki, SpecialListDuplicatedFiles, SpecialAncientPages, SpecialLonelyPages, SpecialUnusedTemplates, SpecialDeadendPages, SpecialListFiles, SpecialMostLinkedCategories, SpecialUnlockdb, WantedPagesPage, SpecialUncategorizedPages, SpecialListGrants, SpecialGoToInterwiki, SpecialUnusedImages, SpecialUnusedCategories, SpecialNewSection, SpecialPermanentLink, SpecialListUsers, SpecialUncategorizedImages, SpecialApiSandbox, MostimagesPage, SpecialCategories, SpecialWantedTemplates, SpecialFilepath, SpecialUserLogout, SpecialLongPages, SpecialMostRevisions, SpecialUnlinkAccounts, SpecialChangeCredentials, and SpecialLinkAccounts.

Definition at line 926 of file SpecialPage.php.

Referenced by getFinalGroupName().

◆ getHookContainer()

SpecialPage::getHookContainer ( )
protected
Since
1.35
Returns
HookContainer

Definition at line 997 of file SpecialPage.php.

References $hookContainer.

Referenced by getHookRunner(), SpecialSearch\showResults(), and SpecialUndelete\showRevision().

◆ getHookRunner()

SpecialPage::getHookRunner ( )
protected

Definition at line 1010 of file SpecialPage.php.

References $hookRunner, and getHookContainer().

Referenced by RedirectSpecialArticle\__construct(), ChangesListSpecialPage\__construct(), SpecialPageLanguage\alterForm(), SpecialChangeEmail\attemptChange(), SpecialEditWatchlist\buildRemoveLine(), UserrightsPage\doSaveUserGroups(), MovePageForm\doSubmit(), SpecialLog\execute(), SpecialTrackingCategories\execute(), SpecialContributions\execute(), SpecialStatistics\execute(), SpecialImport\execute(), SpecialSearch\execute(), SpecialUpload\execute(), AuthManagerSpecialPage\fieldInfoToFormDescriptor(), SpecialNewpages\formatRow(), SpecialRecentChanges\getExtraOptions(), FormSpecialPage\getForm(), SpecialContributions\getForm(), SpecialBlock\getFormFields(), SpecialMute\getFormFields(), SpecialEditWatchlist\getNormalForm(), SpecialShortPages\getQueryInfo(), SpecialAncientPages\getQueryInfo(), WantedPagesPage\getQueryInfo(), SpecialLonelyPages\getQueryInfo(), RandomPage\getQueryInfo(), RandomPage\getRandomTitle(), SpecialSearch\getSearchProfiles(), SpecialResetTokens\getTokensList(), SpecialSearch\goResult(), SpecialWhatLinksHere\listItem(), SpecialMute\onSubmit(), SpecialUserLogout\onSuccess(), AuthManagerSpecialPage\performAuthenticationStep(), SpecialBlock\preText(), SpecialUpload\processUpload(), SpecialWatchlist\registerFilters(), ChangesListSpecialPage\registerFilters(), run(), ChangesListSpecialPage\runMainQueryHook(), SpecialEditWatchlist\runWatchUnwatchCompleteHook(), SpecialEmailUser\sendEmailForm(), SpecialNewpages\setup(), SpecialSearch\showCreateLink(), SpecialUndelete\showHistory(), SpecialAutoblockList\showList(), SpecialBookSources\showList(), SpecialBlockList\showList(), SpecialSearch\showResults(), SpecialUndelete\showRevision(), SpecialUserLogin\successfulAction(), SpecialCreateAccount\successfulAction(), AuthManagerSpecialPage\trySubmit(), and SpecialUndelete\undelete().

◆ getLanguage()

SpecialPage::getLanguage ( )

Shortcut to get user's language.

Returns
Language
Since
1.19

Definition at line 774 of file SpecialPage.php.

References getContext().

Referenced by SpecialEditTags\buildCheckBoxes(), SpecialEditWatchlist\buildRemoveLine(), FormSpecialPage\checkExecutePermissions(), SpecialVersion\compare(), SpecialUndelete\diffHeader(), SpecialTags\doTagRow(), SpecialTrackingCategories\execute(), SpecialAllMessages\execute(), SpecialAllPages\execute(), SpecialLinkSearch\execute(), UserrightsPage\execute(), SpecialFileDuplicateSearch\execute(), QueryPage\execute(), SpecialNewpages\filterLinks(), SpecialMyLanguage\findTitle(), SpecialUndelete\formatFileRow(), SpecialListGroupRights\formatPermissions(), SpecialPasswordPolicies\formatPolicies(), SpecialMostLinkedCategories\formatResult(), WantedQueryPage\formatResult(), SpecialUnusedTemplates\formatResult(), SpecialFewestRevisions\formatResult(), SpecialMostCategories\formatResult(), SpecialMostInterwikis\formatResult(), SpecialWantedCategories\formatResult(), SpecialAncientPages\formatResult(), SpecialMostLinkedTemplates\formatResult(), SpecialBrokenRedirects\formatResult(), SpecialMostLinked\formatResult(), SpecialUnwatchedPages\formatResult(), SpecialDoubleRedirects\formatResult(), SpecialListRedirects\formatResult(), SpecialShortPages\formatResult(), SpecialMIMESearch\formatResult(), SpecialPagesWithProp\formatResult(), SpecialFileDuplicateSearch\formatResult(), SpecialUndelete\formatRevisionRow(), SpecialProtectedtitles\formatRow(), SpecialNewpages\formatRow(), SpecialCachedPage\getCacheKey(), SpecialVersion\getCreditsForExtension(), SpecialStatistics\getEditStats(), SpecialVersion\getEntryPointInfo(), SpecialMediaStatistics\getExtensionList(), SpecialUndelete\getFileLink(), SpecialWhatLinksHere\getFilterPanel(), SpecialPageLanguage\getFormFields(), SpecialBotPasswords\getFormFields(), SpecialStatistics\getGroupStats(), SpecialEditWatchlist\getNormalForm(), SpecialStatistics\getOtherStats(), SpecialUndelete\getPageLink(), SpecialWhatLinksHere\getPrevNext(), SpecialDeletedContributions\getSubTitle(), SpecialStatistics\getUserStats(), UserrightsPage\groupCheckboxes(), SpecialWhatLinksHere\listItem(), SpecialVersion\listToText(), LoginSignupSpecialPage\makeLanguageSelector(), LoginSignupSpecialPage\makeLanguageSelectorLink(), SpecialRecentChanges\optionsPanel(), SpecialEditWatchlist\outputSubtitle(), SpecialNewpages\parseParams(), SpecialBlock\postText(), SpecialUpload\processVerificationError(), SpecialAllPages\showChunk(), SpecialEditTags\showConvenienceLinks(), SpecialRevisionDelete\showConvenienceLinks(), UserrightsPage\showEditUserGroupsForm(), SpecialUndelete\showFileConfirmationForm(), MovePageForm\showForm(), SpecialEditTags\showForm(), SpecialRevisionDelete\showForm(), SpecialUndelete\showList(), SpecialConfirmEmail\showRequestForm(), SpecialUndelete\showRevision(), MovePageForm\showSubpagesList(), SpecialRevisionDelete\tryShowFile(), and SpecialWhatLinksHere\wlhLink().

◆ getLanguageConverter()

◆ getLinkRenderer()

SpecialPage::getLinkRenderer ( )
Since
1.28
Returns
\MediaWiki\Linker\LinkRenderer

Definition at line 944 of file SpecialPage.php.

References $linkRenderer.

Referenced by SpecialEditWatchlist\buildRemoveLine(), SpecialContributions\contributionsSub(), SpecialUndelete\diffHeader(), MovePageForm\doSubmit(), SpecialTags\doTagRow(), SpecialListFiles\execute(), SpecialCategories\execute(), SpecialNewFiles\execute(), SpecialProtectedpages\execute(), SpecialTrackingCategories\execute(), SpecialContributions\execute(), SpecialListGroupRights\execute(), SpecialAllMessages\execute(), SpecialPasswordPolicies\execute(), SpecialNewpages\filterLinks(), PageQueryPage\formatResult(), SpecialMostLinkedCategories\formatResult(), WantedQueryPage\formatResult(), SpecialUnusedTemplates\formatResult(), SpecialFewestRevisions\formatResult(), SpecialUnusedCategories\formatResult(), SpecialMostCategories\formatResult(), SpecialUncategorizedCategories\formatResult(), SpecialMostInterwikis\formatResult(), SpecialWantedCategories\formatResult(), SpecialAncientPages\formatResult(), SpecialMostLinkedTemplates\formatResult(), SpecialBrokenRedirects\formatResult(), SpecialMostLinked\formatResult(), SpecialUnwatchedPages\formatResult(), SpecialDoubleRedirects\formatResult(), SpecialListRedirects\formatResult(), SpecialShortPages\formatResult(), SpecialMIMESearch\formatResult(), SpecialPagesWithProp\formatResult(), SpecialFileDuplicateSearch\formatResult(), SpecialLinkSearch\formatResult(), SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), SpecialProtectedtitles\formatRow(), SpecialNewpages\formatRow(), SpecialVersion\getCreditsForExtension(), LoginSignupSpecialPage\getFieldDefinitions(), SpecialUnblock\getFields(), SpecialUndelete\getFileLink(), SpecialEmailUser\getFormFields(), SpecialBotPasswords\getFormFields(), SpecialStatistics\getGroupStats(), SpecialUndelete\getPageLink(), SpecialStatistics\getPageStats(), SpecialDeletedContributions\getSubTitle(), SpecialUpload\getUploadForm(), SpecialStatistics\getUserStats(), SpecialVersion\listAuthors(), SpecialWhatLinksHere\listItem(), LoginSignupSpecialPage\load(), LoginSignupSpecialPage\makeLanguageSelectorLink(), SpecialRecentChanges\makeOptionsLink(), SpecialWhatLinksHere\makeSelfLink(), SpecialMostLinked\makeWlhLink(), WantedQueryPage\makeWlhLink(), SpecialMostLinkedTemplates\makeWlhLink(), SpecialMergeHistory\merge(), SpecialListGroupRights\outputNamespaceProtectionInfo(), SpecialSpecialpages\outputPageList(), SpecialEditWatchlist\outputSubtitle(), SpecialMediaStatistics\outputTableRow(), SpecialBlock\postText(), SpecialLog\show(), SpecialAllPages\showChunk(), SpecialEditTags\showConvenienceLinks(), SpecialRevisionDelete\showConvenienceLinks(), SpecialRevisionDelete\showForm(), SpecialWhatLinksHere\showIndirectLinks(), SpecialUndelete\showList(), SpecialPrefixindex\showPrefixChunk(), SpecialSearch\showResults(), SpecialUndelete\showRevision(), SpecialChangeCredentials\showSubpageList(), MovePageForm\showSubpagesList(), SpecialEditWatchlist\showTitles(), SpecialUploadStash\showUploads(), SpecialUpload\showUploadWarning(), SpecialUpload\showViewDeletedLinks(), SpecialUndelete\undelete(), and SpecialWhatLinksHere\wlhLink().

◆ getLocalName()

SpecialPage::getLocalName ( )

Get the localised name of the special page Stable to override.

Returns
string

Definition at line 260 of file SpecialPage.php.

References $mLocalName.

◆ getLoginSecurityLevel()

SpecialPage::getLoginSecurityLevel ( )
protected

Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

a reauthentication). What exactly that will mean is decided by the authentication framework. Stable to override

Returns
bool|string False or the argument for AuthManager::securitySensitiveOperationStatus(). Typically a special page needing elevated security would return its name here.

Reimplemented in SpecialCreateAccount, SpecialChangeEmail, AuthManagerSpecialPage, SpecialBotPasswords, SpecialUserLogin, and SpecialUnlinkAccounts.

Definition at line 389 of file SpecialPage.php.

Referenced by FormSpecialPage\execute(), and execute().

◆ getName()

◆ getOutput()

SpecialPage::getOutput ( )

Get the OutputPage being used for this instance.

Returns
OutputPage
Since
1.18

Definition at line 744 of file SpecialPage.php.

References getContext().

Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\__construct(), SpecialCachedPage\addCachedHTML(), addFeedLinks(), SpecialLog\addHeader(), addHelpLink(), SpecialRecentChanges\addModules(), ChangesListSpecialPage\addModules(), SpecialRevisionDelete\addUsageText(), SpecialChangeContentModel\alterForm(), SpecialPageLanguage\alterForm(), SpecialConfirmEmail\attemptConfirm(), SpecialEmailInvalidate\attemptInvalidate(), SpecialUserLogin\beforeExecute(), AuthManagerSpecialPage\beforeExecute(), checkLoginSecurityLevel(), ChangesListSpecialPage\considerActionsForDefaultSavedQuery(), SpecialContributions\contributionsSub(), SpecialRedirect\dispatch(), SpecialRecentChanges\doHeader(), SpecialImport\doImport(), SpecialRecentChangesLinked\doMainQuery(), MovePageForm\doSubmit(), UserrightsPage\editUserGroupsForm(), SpecialListFiles\execute(), SpecialJavaScriptTest\execute(), SpecialBlankpage\execute(), SpecialApiHelp\execute(), SpecialProtectedpages\execute(), SpecialProtectedtitles\execute(), SpecialSpecialpages\execute(), SpecialCategories\execute(), SpecialLog\execute(), SpecialNewFiles\execute(), SpecialActiveUsers\execute(), SpecialTrackingCategories\execute(), SpecialLinkAccounts\execute(), SpecialListGrants\execute(), SpecialUnlinkAccounts\execute(), SpecialPreferences\execute(), SpecialRunJobs\execute(), SpecialStatistics\execute(), SpecialListUsers\execute(), SpecialContributions\execute(), SpecialExport\execute(), SpecialGoToInterwiki\execute(), RedirectSpecialPage\execute(), SpecialBookSources\execute(), SpecialListGroupRights\execute(), SpecialApiSandbox\execute(), SpecialDeletedContributions\execute(), SpecialUnblock\execute(), SpecialAllMessages\execute(), SpecialWhatLinksHere\execute(), SpecialBlockList\execute(), SpecialPasswordPolicies\execute(), SpecialAutoblockList\execute(), SpecialPrefixindex\execute(), SpecialChangeCredentials\execute(), SpecialComparePages\execute(), SpecialExpandTemplates\execute(), SpecialAllPages\execute(), RandomPage\execute(), SpecialLinkSearch\execute(), SpecialConfirmEmail\execute(), DisabledSpecialPage\execute(), SpecialMute\execute(), SpecialPagesWithProp\execute(), SpecialResetTokens\execute(), SpecialWatchlist\execute(), SpecialChangeEmail\execute(), SpecialBotPasswords\execute(), SpecialEditTags\execute(), SpecialImport\execute(), SpecialVersion\execute(), SpecialPasswordReset\execute(), MovePageForm\execute(), SpecialPageData\execute(), UserrightsPage\execute(), SpecialEditWatchlist\execute(), SpecialUnwatchedPages\execute(), SpecialFileDuplicateSearch\execute(), SpecialEmailUser\execute(), SpecialMergeHistory\execute(), SpecialSearch\execute(), SpecialRevisionDelete\execute(), SpecialNewpages\execute(), SpecialRecentChanges\execute(), SpecialUndelete\execute(), LoginSignupSpecialPage\execute(), ChangesListSpecialPage\execute(), QueryPage\execute(), SpecialEditWatchlist\executeViewEditWatchlist(), SpecialJavaScriptTest\exportJS(), SpecialEditTags\failure(), SpecialRevisionDelete\failure(), SpecialNewpages\feed(), SpecialNewpages\form(), SpecialLog\getActionButtons(), SpecialChangeCredentials\getAuthFormDescriptor(), SpecialVersion\getCreditsForExtension(), SpecialContributions\getForm(), SpecialBlock\getFormFields(), SpecialDeletedContributions\getSubTitle(), AuthManagerSpecialPage\handleReauthBeforeExecute(), AuthManagerSpecialPage\handleReturnBeforeExecute(), ChangesListSpecialPage\includeRcFiltersApp(), SpecialVersion\listAuthors(), LoginSignupSpecialPage\mainLoginForm(), SpecialBlock\maybeAlterFormDefaults(), SpecialMergeHistory\merge(), SpecialCachedPage\onCacheInitialized(), SpecialNewSection\onFormSubmit(), SpecialPermanentLink\onFormSubmit(), SpecialRedirectWithAction\onFormSubmit(), SpecialDiff\onFormSubmit(), SpecialRandomInCategory\onSubmit(), SpecialPageLanguage\onSubmit(), SpecialChangeContentModel\onSubmit(), SpecialBotPasswords\onSubmit(), SpecialResetTokens\onSuccess(), SpecialUnlockdb\onSuccess(), SpecialMute\onSuccess(), SpecialUserLogout\onSuccess(), SpecialLockdb\onSuccess(), SpecialChangeEmail\onSuccess(), SpecialPasswordReset\onSuccess(), SpecialChangeContentModel\onSuccess(), SpecialPageLanguage\onSuccess(), SpecialBotPasswords\onSuccess(), SpecialBlock\onSuccess(), SpecialRecentChanges\outputChangesList(), SpecialWatchlist\outputChangesList(), outputHeader(), SpecialMediaStatistics\outputMediaType(), SpecialListGroupRights\outputNamespaceProtectionInfo(), SpecialRecentChangesLinked\outputNoResults(), ChangesListSpecialPage\outputNoResults(), SpecialSpecialpages\outputPageList(), SpecialMediaStatistics\outputResults(), SpecialEditWatchlist\outputSubtitle(), SpecialMediaStatistics\outputTableEnd(), SpecialMediaStatistics\outputTableRow(), SpecialMediaStatistics\outputTableStart(), ChangesListSpecialPage\outputTimeout(), SpecialBlock\postText(), SpecialPageLanguage\preText(), SpecialBlock\preText(), SpecialUpload\processUpload(), SpecialUndelete\redirectToRevDel(), SpecialEmailUser\sendEmailForm(), SpecialUserLogin\setHeaders(), setHeaders(), SpecialNewFiles\setTopText(), SpecialRecentChangesLinked\setTopText(), SpecialRecentChanges\setTopText(), SpecialSearch\setupPage(), SpecialLog\show(), SpecialTags\showActivateDeactivateForm(), SpecialAllPages\showChunk(), SpecialEditTags\showConvenienceLinks(), SpecialRevisionDelete\showConvenienceLinks(), SpecialSearch\showCreateLink(), SpecialTags\showDeleteTagForm(), SpecialUndelete\showDiff(), UserrightsPage\showEditUserGroupsForm(), QueryPage\showEmptyText(), SpecialUndelete\showFile(), SpecialUndelete\showFileConfirmationForm(), SpecialPageData\showForm(), MovePageForm\showForm(), SpecialEditTags\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), SpecialSearch\showGoogleSearch(), SpecialMergeHistory\showHistory(), SpecialUndelete\showHistory(), SpecialWhatLinksHere\showIndirectLinks(), SpecialFileDuplicateSearch\showList(), SpecialAutoblockList\showList(), SpecialBookSources\showList(), SpecialBlockList\showList(), SpecialUndelete\showList(), MovePageForm\showLogFragment(), SpecialMergeHistory\showMergeForm(), SpecialPrefixindex\showPrefixChunk(), SpecialConfirmEmail\showRequestForm(), SpecialPreferences\showResetForm(), SpecialSearch\showResults(), SpecialUndelete\showRevision(), SpecialUndelete\showSearchForm(), SpecialChangeCredentials\showSubpageList(), MovePageForm\showSubpages(), MovePageForm\showSubpagesList(), SpecialUserLogout\showSuccess(), LoginSignupSpecialPage\showSuccessPage(), SpecialTags\showTagList(), SpecialAutoblockList\showTotal(), SpecialUploadStash\showUpload(), SpecialUpload\showUploadForm(), SpecialUploadStash\showUploads(), SpecialUpload\showUploadWarning(), SpecialUpload\showViewDeletedLinks(), SpecialEditTags\submit(), SpecialRevisionDelete\submit(), SpecialPreferences\submitReset(), SpecialChangeCredentials\success(), SpecialEditTags\success(), SpecialRevisionDelete\success(), SpecialCreateAccount\successfulAction(), UserrightsPage\switchForm(), SpecialRevisionDelete\tryShowFile(), SpecialUndelete\undelete(), SpecialUpload\unsaveUploadedFile(), and ChangesListSpecialPage\validateOptions().

◆ getPageTitle()

SpecialPage::getPageTitle (   $subpage = false)

Get a self-referential title object.

Parameters
string | bool$subpage
Returns
Title
Since
1.23

Definition at line 697 of file SpecialPage.php.

References getTitleFor().

Referenced by SpecialActiveUsers\buildForm(), SpecialBookSources\buildForm(), buildPrevNextNavigation(), ChangesListSpecialPage\considerActionsForDefaultSavedQuery(), SpecialUndelete\diffHeader(), SpecialRecentChanges\doHeader(), SpecialTags\doTagRow(), SpecialApiHelp\execute(), SpecialLinkAccounts\execute(), SpecialUnlinkAccounts\execute(), SpecialWhatLinksHere\execute(), SpecialBlockList\execute(), SpecialAutoblockList\execute(), SpecialChangeCredentials\execute(), SpecialExpandTemplates\execute(), SpecialLinkSearch\execute(), SpecialPagesWithProp\execute(), SpecialWatchlist\execute(), SpecialFileDuplicateSearch\execute(), SpecialEmailUser\execute(), SpecialSearch\execute(), LoginSignupSpecialPage\execute(), SpecialNewpages\feed(), SpecialNewpages\filterLinks(), SpecialUndelete\formatFileRow(), SpecialUndelete\formatRevisionRow(), LoginSignupSpecialPage\getAuthForm(), SpecialEditWatchlist\getClearForm(), SpecialVersion\getCreditsForExtension(), SpecialContributions\getForm(), SpecialBotPasswords\getFormFields(), SpecialEditWatchlist\getNormalForm(), SpecialMIMESearch\getPageHeader(), SpecialEditWatchlist\getRawForm(), UserrightsPage\getSuccessURL(), SpecialUpload\getUploadForm(), AuthManagerSpecialPage\handleReturnBeforeExecute(), SpecialVersion\listAuthors(), LoginSignupSpecialPage\load(), LoginSignupSpecialPage\makeLanguageSelectorLink(), SpecialRecentChanges\makeOptionsLink(), SpecialPrefixindex\namespacePrefixForm(), SpecialPermanentLink\onFormSubmit(), SpecialDiff\onFormSubmit(), SpecialBotPasswords\onSubmit(), SpecialBotPasswords\onSuccess(), SpecialAllPages\outputHTMLForm(), AuthManagerSpecialPage\performAuthenticationStep(), SpecialTags\processCreateTagForm(), SpecialTags\processTagForm(), SpecialJavaScriptTest\renderPage(), SpecialSearch\setupPage(), SpecialTags\showActivateDeactivateForm(), SpecialAllPages\showChunk(), SpecialTags\showDeleteTagForm(), UserrightsPage\showEditUserGroupsForm(), SpecialUndelete\showFileConfirmationForm(), MovePageForm\showForm(), SpecialEditTags\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), SpecialMergeHistory\showHistory(), SpecialUndelete\showHistory(), SpecialUndelete\showList(), SpecialMergeHistory\showMergeForm(), SpecialPrefixindex\showPrefixChunk(), SpecialConfirmEmail\showRequestForm(), SpecialPreferences\showResetForm(), SpecialUndelete\showRevision(), SpecialUndelete\showSearchForm(), SpecialTags\showTagList(), SpecialUploadStash\showUploads(), SpecialPreferences\submitReset(), UserrightsPage\switchForm(), SpecialRevisionDelete\tryShowFile(), ChangesListSpecialPage\validateOptions(), SpecialWhatLinksHere\whatlinkshereForm(), and SpecialWhatLinksHere\wlhLink().

◆ getRequest()

SpecialPage::getRequest ( )

Get the WebRequest being used for this instance.

Returns
WebRequest
Since
1.18

Reimplemented in AuthManagerSpecialPage.

Definition at line 734 of file SpecialPage.php.

References getContext().

Referenced by SpecialUserLogout\alterForm(), SpecialPasswordReset\alterForm(), SpecialChangeEmail\alterForm(), SpecialBlock\alterForm(), SpecialRevisionDelete\buildCheckBoxes(), SpecialActiveUsers\buildForm(), FormSpecialPage\checkExecutePermissions(), checkLoginSecurityLevel(), ChangesListSpecialPage\considerActionsForDefaultSavedQuery(), SpecialRedirect\dispatchFile(), SpecialImport\doImport(), SpecialListFiles\execute(), SpecialApiHelp\execute(), SpecialLog\execute(), SpecialNewFiles\execute(), SpecialCategories\execute(), SpecialProtectedpages\execute(), SpecialProtectedtitles\execute(), SpecialActiveUsers\execute(), SpecialWithoutInterwiki\execute(), SpecialRunJobs\execute(), SpecialContributions\execute(), SpecialPreferences\execute(), SpecialExport\execute(), SpecialBookSources\execute(), SpecialUnblock\execute(), SpecialDeletedContributions\execute(), SpecialWhatLinksHere\execute(), SpecialAllMessages\execute(), SpecialBlockList\execute(), SpecialPrefixindex\execute(), SpecialTags\execute(), SpecialExpandTemplates\execute(), SpecialAllPages\execute(), RandomPage\execute(), SpecialLinkSearch\execute(), SpecialPagesWithProp\execute(), SpecialWatchlist\execute(), SpecialEditTags\execute(), SpecialImport\execute(), MovePageForm\execute(), SpecialPageData\execute(), UserrightsPage\execute(), SpecialEditWatchlist\execute(), SpecialFileDuplicateSearch\execute(), SpecialEmailUser\execute(), SpecialSearch\execute(), SpecialRevisionDelete\execute(), SpecialRecentChanges\execute(), SpecialMIMESearch\execute(), ChangesListSpecialPage\execute(), SpecialRevisionDelete\extractBitParams(), SpecialWatchlist\fetchOptionsFromRequest(), ChangesListSpecialPage\fetchOptionsFromRequest(), ChangesListSpecialPage\getDefaultOptions(), FormSpecialPage\getForm(), SpecialContributions\getForm(), SpecialPasswordReset\getFormFields(), QueryPage\getLimitOffset(), SpecialFilepath\getRedirect(), RedirectSpecialPage\getRedirectQuery(), SpecialEditWatchlist\getWatchlist(), SpecialVersion\IPInfo(), ChangesListSpecialPage\isStructuredFilterUiEnabled(), SpecialSearch\load(), SpecialUndelete\loadRequest(), SpecialUpload\loadRequest(), SpecialMergeHistory\loadRequestParams(), ChangesListSpecialPage\makeLegend(), SpecialBlock\maybeAlterFormDefaults(), SpecialRandomInCategory\onSubmit(), SpecialBotPasswords\onSubmit(), SpecialChangeEmail\onSuccess(), SpecialPasswordReset\onSuccess(), SpecialUpload\processUpload(), SpecialUndelete\redirectToRevDel(), SpecialSearch\saveNamespaces(), UserrightsPage\saveUserGroups(), SpecialChangeContentModel\setParameter(), SpecialBlock\setParameter(), SpecialRecentChanges\setTopText(), SpecialNewpages\setup(), SpecialUndelete\showFile(), SpecialRevisionDelete\showForm(), SpecialExpandTemplates\showHtmlPreview(), SpecialUndelete\showSearchForm(), SpecialUserLogout\showSuccess(), SpecialCachedPage\startCache(), SpecialEditTags\submit(), SpecialRevisionDelete\submit(), SpecialPreferences\submitReset(), SpecialRevisionDelete\tryShowFile(), and useTransactionalTimeLimit().

◆ getRestriction()

SpecialPage::getRestriction ( )

Get the permission that a user must have to execute this page.

Returns
string

Definition at line 172 of file SpecialPage.php.

References $mRestriction.

◆ getRobotPolicy()

SpecialPage::getRobotPolicy ( )
protected

Return the robot policy.

Derived classes that override this can change the robot policy set by setHeaders() from the default 'noindex,nofollow'.

Returns
string
Since
1.23

Definition at line 815 of file SpecialPage.php.

Referenced by setHeaders().

◆ getSafeTitleFor()

static SpecialPage::getSafeTitleFor (   $name,
  $subpage = false 
)
static

Get a localised Title object for a page name with a possibly unvalidated subpage.

Parameters
string$name
string | bool$subpageSubpage string, or false to not use a subpage
Returns
Title|null Title object or null if the page doesn't exist

Definition at line 121 of file SpecialPage.php.

References Title\makeTitleSafe(), and NS_SPECIAL.

Referenced by EmailNotification\composeCommonMailtext(), SpecialFilepath\getRedirect(), Skin\makeSpecialUrl(), and Skin\makeSpecialUrlSubpage().

◆ getSkin()

◆ getSubpagesForPrefixSearch()

SpecialPage::getSubpagesForPrefixSearch ( )
protected

Return an array of subpages that this special page will accept for prefix searches.

If this method requires a query you might instead want to implement prefixSearchSubpages() directly so you can support $limit and $offset. This method is better for static-ish lists of things.

Stable to override

Returns
string[] subpages to search from

Reimplemented in SpecialTags, SpecialRedirect, SpecialEditWatchlist, SpecialLog, SpecialWatchlist, and SpecialListUsers.

Definition at line 523 of file SpecialPage.php.

Referenced by prefixSearchSubpages().

◆ getTitleFor()

static SpecialPage::getTitleFor (   $name,
  $subpage = false,
  $fragment = '' 
)
static

Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.

Since
1.9
1.21 $fragment parameter added
Parameters
string$name
string | bool$subpageSubpage string, or false to not use a subpage
string$fragmentThe link fragment (after the "#")
Returns
Title
Exceptions
MWException

Definition at line 92 of file SpecialPage.php.

References Title\newFromLinkTarget().

Referenced by ApiQuerySiteinfo\appendExtensions(), MediaWiki\Preferences\SignatureValidator\applyPreSaveTransform(), SpecialConfirmEmail\attemptConfirm(), SpecialUserLogin\beforeExecute(), Linker\blockLink(), SkinTemplate\buildContentNavigationUrls(), Skin\buildNavUrls(), SpecialEditWatchlist\buildRemoveLine(), SkinMustache\buildSearchProps(), SpecialEditWatchlist\buildTools(), MediaWiki\Auth\AuthManager\checkAccountCreatePermissions(), checkLoginSecurityLevel(), MediaWiki\Permissions\PermissionManager\checkReadPermissions(), MediaWiki\Preferences\SignatureValidator\checkUserLinks(), ApiFormatBase\closePrinter(), DifferenceEngine\deletedLink(), SpecialTags\doTagRow(), Linker\emailLink(), TidyUpT39714\execute(), ApiHelp\execute(), SpecialListGroupRights\execute(), SpecialBlockList\execute(), SpecialPasswordPolicies\execute(), ApiFeedContributions\execute(), ApiFeedWatchlist\execute(), SpecialResetTokens\execute(), SpecialWatchlist\execute(), SpecialEditWatchlist\execute(), SpecialEditWatchlist\executeViewEditWatchlist(), OldChangesList\formatChangeLine(), LogFormatter\formatParameterValueForApi(), SpecialUnusedTemplates\formatResult(), SpecialListDuplicatedFiles\formatResult(), DeletedContribsPager\formatRevisionRow(), BlockListPager\formatValue(), ContentModelLogFormatter\getActionLinks(), MergeLogFormatter\getActionLinks(), MoveLogFormatter\getActionLinks(), BlockLogFormatter\getActionLinks(), DeleteLogFormatter\getActionLinks(), RevDelArchivedFileItem\getApiData(), RevDelFileItem\getApiData(), InfoAction\getContributors(), HistoryAction\getDescription(), RevDelArchiveItem\getDiffLink(), ApiFeedRecentChanges\getFeedObject(), LoginSignupSpecialPage\getFieldDefinitions(), SpecialUnblock\getFields(), Title\getFullUrlForRedirect(), MWGrants\getGrantsLink(), SpecialStatistics\getGroupStats(), OutputPage\getHeadLinksArray(), ApiHelp\getHelpInternal(), ChangeTagsLogItem\getHTML(), RevDelLogItem\getHTML(), RevDelArchivedFileItem\getLink(), RevDelFileItem\getLink(), RCCacheEntryFactory\getLogLink(), BlockLogFormatter\getMessageParameters(), ApiParamInfo\getModuleInfo(), SearchNearMatcher\getNearMatchInternal(), SpecialStatistics\getPageStats(), getPageTitle(), ChangesListSpecialPage\getRcFiltersConfigSummary(), ChangesListSpecialPage\getRcFiltersConfigVars(), ManualLogEntry\getRecentChange(), SpecialAllMyUploads\getRedirect(), SpecialMyuploads\getRedirect(), SpecialMycontributions\getRedirect(), SpecialRedirectToSpecial\getRedirect(), RevDelArchiveItem\getRevisionLink(), Skin\getSearchLink(), LogEventsList\getShowHideLinks(), UploadStashFile\getSpecialUrl(), SpecialDeletedContributions\getSubTitle(), MediaWiki\getTitle(), AllMessagesTablePager\getTitle(), ImageListPager\getTitle(), MediaWiki\SpecialPage\SpecialPageFactory\getTitleForAlias(), Skin\getUndeleteLink(), Linker\getUploadUrl(), ImagePage\getUploadUrl(), SpecialContributions\getUserLinks(), ExternalUserNames\getUserLinkTitle(), SpecialStatistics\getUserStats(), AuthManagerSpecialPage\handleReauthBeforeExecute(), ImageHistoryList\imageHistoryLine(), CreditsAction\link(), Parser\magicLinkCallback(), EnhancedChangesList\makeCacheGroupingKey(), SpecialMostLinked\makeWlhLink(), WantedQueryPage\makeWlhLink(), SpecialMostLinkedTemplates\makeWlhLink(), RecentChangesUpdateJob\newCacheUpdateJob(), RecentChangesUpdateJob\newPurgeJob(), MarkpatrolledAction\onSubmit(), ImagePage\openShowImage(), SpecialListGroupRights\outputNamespaceProtectionInfo(), SpecialMediaStatistics\outputTableRow(), InfoAction\pageInfo(), MediaWiki\parseTitle(), MediaWiki\performRequest(), SpecialBlock\postText(), SkinTemplate\prepareQuickTemplate(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), EnhancedChangesList\recentChangesBlockLine(), SpecialUndelete\redirectToRevDel(), UserNotLoggedIn\report(), Linker\revDeleteLink(), LogPage\saveContent(), UserMailer\sendInternal(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendPasswordResetEmail(), McrUndoAction\show(), SpecialEditTags\showConvenienceLinks(), SpecialRevisionDelete\showConvenienceLinks(), EditPage\showHeader(), LogEventsList\showOptions(), OutputPage\showPermissionsErrorPage(), SpecialUserLogout\showSuccess(), SpecialUpload\showUploadWarning(), SpecialUpload\showViewDeletedLinks(), CoreParserFunctions\special(), Linker\specialLink(), SpecialEmailUser\submit(), RevDelLogList\suggestTarget(), MediaWiki\tryNormaliseRedirect(), ChangeTags\updateTagsWithChecks(), Linker\userToolLinks(), MediaWiki\Preferences\DefaultPreferencesFactory\watchlistPreferences(), and wfOpenSearchDescMain().

◆ getTitleValueFor()

static SpecialPage::getTitleValueFor (   $name,
  $subpage = false,
  $fragment = '' 
)
static

Get a localised TitleValue object for a specified special page name.

Since
1.28
Parameters
string$name
string | bool$subpageSubpage string, or false to not use a subpage
string$fragmentThe link fragment (after the "#")
Returns
TitleValue

Definition at line 107 of file SpecialPage.php.

References NS_SPECIAL.

Referenced by TagLogFormatter\getMessageParameters(), BlockListPager\getRestrictionListHTML(), and InfoAction\pageInfo().

◆ getUser()

SpecialPage::getUser ( )

Shortcut to get the User executing this instance.

Returns
User
Since
1.18

Definition at line 754 of file SpecialPage.php.

References getContext().

Referenced by UserrightsPage\addLogEntry(), SpecialRecentChanges\addWatchlistJoins(), SpecialConfirmEmail\attemptConfirm(), SpecialEmailInvalidate\attemptInvalidate(), SpecialNewFiles\buildForm(), UserrightsPage\changeableGroups(), SpecialBotPasswords\checkExecutePermissions(), SpecialCreateAccount\checkPermissions(), SpecialUndelete\checkPermissions(), checkPermissions(), SpecialEditWatchlist\cleanupWatchlist(), SpecialEditWatchlist\clearUserWatchedItemsNow(), SpecialEditWatchlist\clearUserWatchedItemsUsingJobQueue(), ChangesListSpecialPage\considerActionsForDefaultSavedQuery(), SpecialUndelete\diffHeader(), SpecialImport\doImport(), SpecialWatchlist\doMainQuery(), UserrightsPage\doSaveUserGroups(), MovePageForm\doSubmit(), SpecialLog\execute(), SpecialUnlinkAccounts\execute(), SpecialContributions\execute(), SpecialPreferences\execute(), SpecialUserLogout\execute(), SpecialConfirmEmail\execute(), SpecialWatchlist\execute(), SpecialUploadStash\execute(), SpecialImport\execute(), SpecialEditTags\execute(), MovePageForm\execute(), UserrightsPage\execute(), SpecialEmailUser\execute(), SpecialRevisionDelete\execute(), SpecialUpload\execute(), FormSpecialPage\execute(), SpecialUndelete\execute(), LoginSignupSpecialPage\execute(), ChangesListSpecialPage\execute(), QueryPage\execute(), UserrightsPage\fetchUser(), SpecialNewpages\filterLinks(), SpecialUndelete\formatFileRow(), SpecialDoubleRedirects\formatResult(), SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), SpecialProtectedtitles\formatRow(), SpecialLog\getActionButtons(), SpecialBlockList\getBlockListPager(), ChangesListSpecialPage\getDefaultDays(), SpecialRecentChanges\getDefaultLimit(), ChangesListSpecialPage\getDefaultLimit(), SpecialEmailUser\getDescription(), LoginSignupSpecialPage\getFieldDefinitions(), SpecialUndelete\getFileLink(), SpecialContributions\getForm(), SpecialEmailUser\getFormFields(), SpecialPasswordReset\getFormFields(), SpecialResetTokens\getFormFields(), SpecialChangeEmail\getFormFields(), SpecialBotPasswords\getFormFields(), SpecialBlock\getFormFields(), SpecialMute\getFormFields(), QueryPage\getLimitOffset(), SpecialMute\getMuteList(), SpecialSpecialpages\getPageGroups(), SpecialUndelete\getPageLink(), SpecialMypage\getRedirect(), SpecialMytalk\getRedirect(), SpecialAllMyUploads\getRedirect(), SpecialMyuploads\getRedirect(), SpecialMycontributions\getRedirect(), SpecialUpload\getWatchCheck(), SpecialEditWatchlist\getWatchlist(), SpecialEditWatchlist\getWatchlistInfo(), UserrightsPage\groupCheckboxes(), ChangesListSpecialPage\includeRcFiltersApp(), SpecialUndelete\isAllowed(), ChangesListSpecialPage\isStructuredFilterUiEnabled(), SpecialSearch\load(), AuthManagerSpecialPage\loadAuth(), SpecialUndelete\loadRequest(), SpecialUpload\loadRequest(), SpecialMergeHistory\loadRequestParams(), LoginSignupSpecialPage\mainLoginForm(), SpecialExpandTemplates\makeOutput(), SpecialBlock\maybeAlterFormDefaults(), SpecialMergeHistory\merge(), SpecialMute\muteTarget(), SpecialRecentChanges\needsWatchlistFeatures(), SpecialLockdb\onSubmit(), SpecialUserLogout\onSubmit(), SpecialChangeEmail\onSubmit(), SpecialResetTokens\onSubmit(), SpecialPageLanguage\onSubmit(), SpecialChangeContentModel\onSubmit(), SpecialBotPasswords\onSubmit(), SpecialUserLogout\onSuccess(), SpecialChangeEmail\onSuccess(), SpecialBotPasswords\onSuccess(), SpecialRecentChanges\optionsPanel(), SpecialRecentChanges\outputChangesList(), SpecialWatchlist\outputChangesList(), SpecialWatchlist\outputFeedLinks(), SpecialEditWatchlist\outputSubtitle(), SpecialNewpages\patrollable(), AuthManagerSpecialPage\performAuthenticationStep(), LoginSignupSpecialPage\postProcessFormDescriptor(), SpecialBlock\postText(), SpecialUpload\processUpload(), SpecialSearch\redirectOnExactMatch(), SpecialWatchlist\registerFilters(), SpecialRecentChanges\registerFilters(), ChangesListSpecialPage\registerFilters(), requireLogin(), SpecialEditWatchlist\runWatchUnwatchCompleteHook(), SpecialBotPasswords\save(), SpecialSearch\saveNamespaces(), SpecialUserLogin\setHeaders(), SpecialNewpages\setup(), SpecialTags\showActivateDeactivateForm(), LoginSignupSpecialPage\showCreateAccountLink(), SpecialTags\showDeleteTagForm(), UserrightsPage\showEditUserGroupsForm(), SpecialUndelete\showFileConfirmationForm(), MovePageForm\showForm(), SpecialEditTags\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), SpecialMergeHistory\showHistory(), SpecialUndelete\showHistory(), SpecialExpandTemplates\showHtmlPreview(), SpecialUpload\showRecoverableUploadError(), SpecialConfirmEmail\showRequestForm(), SpecialPreferences\showResetForm(), SpecialUndelete\showRevision(), LoginSignupSpecialPage\showSuccessPage(), SpecialTags\showTagList(), SpecialUpload\showUploadWarning(), SpecialUpload\showViewDeletedLinks(), SpecialEditTags\submit(), SpecialRevisionDelete\submit(), SpecialEditWatchlist\submitRaw(), SpecialPreferences\submitReset(), SpecialConfirmEmail\submitSend(), SpecialChangeCredentials\success(), SpecialUserLogin\successfulAction(), SpecialCreateAccount\successfulAction(), SpecialRevisionDelete\tryShowFile(), SpecialUndelete\undelete(), SpecialMute\unmuteTarget(), SpecialEditWatchlist\unwatchTitles(), UserrightsPage\userCanChangeRights(), SpecialExport\userCanOverrideExportDepth(), SpecialEditWatchlist\watchTitles(), and SpecialWhatLinksHere\wlhLink().

◆ including()

◆ isCached()

SpecialPage::isCached ( )

Is this page cached? Expensive pages are cached or disabled in miser mode.

Used by QueryPage and subclasses, moved here so that Special:SpecialPages can safely call it for all special pages.

Stable to override

Returns
bool
Since
1.21

Reimplemented in QueryPage, and SpecialFileDuplicateSearch.

Definition at line 292 of file SpecialPage.php.

◆ isExpensive()

SpecialPage::isExpensive ( )

Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

Originally used (and still overridden) by QueryPage and subclasses, moved here so that Special:SpecialPages can safely call it for all special pages.

Stable to override

Returns
bool

Reimplemented in QueryPage, SpecialWithoutInterwiki, SpecialMediaStatistics, SpecialDeadendPages, SpecialLonelyPages, SpecialUncategorizedPages, SpecialMostLinkedTemplates, SpecialMostCategories, SpecialMostLinked, SpecialUncategorizedImages, SpecialUnwatchedPages, SpecialListDuplicatedFiles, SpecialBrokenRedirects, SpecialDoubleRedirects, SpecialFewestRevisions, SpecialListRedirects, SpecialMostInterwikis, SpecialAncientPages, SpecialMIMESearch, MostimagesPage, SpecialUnusedTemplates, WantedQueryPage, SpecialUnusedImages, and SpecialUnusedCategories.

Definition at line 278 of file SpecialPage.php.

◆ isIncludable()

SpecialPage::isIncludable ( )

Whether it's allowed to transclude the special page via {{Special:Foo/params}} Stable to override.

Returns
bool

Reimplemented in SpecialRecentChanges, SpecialApiHelp, IncludableSpecialPage, and WantedPagesPage.

Definition at line 219 of file SpecialPage.php.

References $mIncludable.

◆ isListed()

SpecialPage::isListed ( )

Whether this special page is listed in Special:SpecialPages Stable to override.

Since
1.3 (r3583)
Returns
bool

Reimplemented in SpecialPasswordReset, SpecialResetTokens, SpecialDiff, SpecialRedirectWithAction, SpecialPageData, SpecialNewSection, SpecialPermanentLink, SpecialChangeEmail, SpecialBotPasswords, UnlistedSpecialPage, SpecialUserLogout, SpecialUnlinkAccounts, SpecialChangeCredentials, and SpecialLinkAccounts.

Definition at line 184 of file SpecialPage.php.

References $mListed.

◆ isRestricted()

SpecialPage::isRestricted ( )

Can be overridden by subclasses with more complicated permissions schemes.

Stable to override

Returns
bool Should the page be displayed with the restricted-access pages?

Reimplemented in SpecialCreateAccount.

Definition at line 304 of file SpecialPage.php.

◆ listed()

SpecialPage::listed (   $x = null)

Get or set whether this special page is listed in Special:SpecialPages.

Since
1.6
Deprecated:
since 1.35 Set via subclassing UnlistedSpecialPage, get via isListed()
Parameters
bool | null$x
Returns
bool

Definition at line 209 of file SpecialPage.php.

References wfDeprecated(), and wfSetVar().

◆ maxIncludeCacheTime()

SpecialPage::maxIncludeCacheTime ( )

How long to cache page when it is being included.

Note
If cache time is not 0, then the current user becomes an anon if you want to do any per-user customizations, than this method must be overriden to return 0.
Since
1.26 Stable to override
Returns
int Time in seconds, 0 to disable caching altogether, false to use the parent page's cache settings

Definition at line 234 of file SpecialPage.php.

References getCacheTTL(), and getConfig().

◆ msg()

SpecialPage::msg (   $key,
  $params 
)

Wrapper around wfMessage that sets the current context.

Since
1.16
Parameters
string | string[] | MessageSpecifier$key
mixed...$params
Returns
Message
See also
wfMessage

Implements MessageLocalizer.

Definition at line 828 of file SpecialPage.php.

References getContext(), and including().

Referenced by addHelpLink(), SpecialUnlockdb\alterForm(), SpecialUserLogout\alterForm(), SpecialLockdb\alterForm(), SpecialPasswordReset\alterForm(), SpecialChangeEmail\alterForm(), SpecialBotPasswords\alterForm(), SpecialEditTags\buildCheckBoxes(), SpecialRevisionDelete\buildCheckBoxes(), SpecialNewFiles\buildForm(), SpecialEditWatchlist\buildRemoveLine(), SpecialComparePages\checkExistingRevision(), SpecialComparePages\checkExistingTitle(), SpecialEditWatchlist\clearUserWatchedItemsNow(), SpecialEditWatchlist\clearUserWatchedItemsUsingJobQueue(), SpecialUndelete\diffHeader(), SpecialRecentChanges\doHeader(), SpecialImport\doImport(), SpecialRecentChangesLinked\doMainQuery(), MovePageForm\doSubmit(), SpecialTags\doTagRow(), SpecialListFiles\execute(), SpecialApiHelp\execute(), SpecialCategories\execute(), SpecialLinkAccounts\execute(), SpecialTrackingCategories\execute(), SpecialListGrants\execute(), SpecialUnlinkAccounts\execute(), SpecialPreferences\execute(), SpecialStatistics\execute(), SpecialListUsers\execute(), SpecialContributions\execute(), SpecialExport\execute(), SpecialListGroupRights\execute(), SpecialUnblock\execute(), SpecialDeletedContributions\execute(), SpecialAllMessages\execute(), SpecialWhatLinksHere\execute(), SpecialBlockList\execute(), SpecialPasswordPolicies\execute(), SpecialAutoblockList\execute(), SpecialPrefixindex\execute(), SpecialChangeCredentials\execute(), SpecialAllPages\execute(), DisabledSpecialPage\execute(), SpecialPagesWithProp\execute(), SpecialVersion\execute(), UserrightsPage\execute(), SpecialEditWatchlist\execute(), SpecialFileDuplicateSearch\execute(), SpecialMergeHistory\execute(), SpecialUndelete\execute(), QueryPage\execute(), SpecialEditWatchlist\executeViewEditWatchlist(), SpecialEditTags\failure(), SpecialRevisionDelete\failure(), SpecialNewpages\feed(), SpecialNewpages\feedItemDesc(), SpecialNewpages\filterLinks(), SpecialNewpages\form(), SpecialUndelete\formatFileRow(), SpecialListGroupRights\formatPermissions(), SpecialPasswordPolicies\formatPolicies(), SpecialMostLinkedCategories\formatResult(), WantedQueryPage\formatResult(), SpecialFewestRevisions\formatResult(), SpecialMostCategories\formatResult(), SpecialMostInterwikis\formatResult(), SpecialListDuplicatedFiles\formatResult(), SpecialWantedCategories\formatResult(), SpecialBrokenRedirects\formatResult(), SpecialMostLinked\formatResult(), SpecialUnwatchedPages\formatResult(), SpecialDoubleRedirects\formatResult(), SpecialShortPages\formatResult(), SpecialMIMESearch\formatResult(), SpecialPagesWithProp\formatResult(), SpecialLinkSearch\formatResult(), SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), SpecialProtectedtitles\formatRow(), SpecialStatistics\formatRow(), SpecialNewpages\formatRow(), SpecialStatistics\formatRowHeader(), SpecialLog\getActionButtons(), SpecialChangeCredentials\getAuthForm(), MostimagesPage\getCellHtml(), SpecialEditWatchlist\getClearForm(), SpecialVersion\getCreditsForExtension(), SpecialEmailUser\getDescription(), SpecialUserLogin\getDescription(), SpecialCreateAccount\getDescription(), SpecialDiff\getDescription(), SpecialMute\getDescription(), SpecialEditTags\getDescription(), getDescription(), SpecialUpload\getDupeWarning(), SpecialStatistics\getEditStats(), SpecialVersion\getEntryPointInfo(), SpecialUncategorizedCategories\getExceptionList(), SpecialVersion\getExtensionCredits(), SpecialVersion\getExternalLibraries(), SpecialRecentChangesLinked\getExtraOptions(), LoginSignupSpecialPage\getFieldDefinitions(), SpecialUndelete\getFileComment(), SpecialUndelete\getFileUser(), SpecialWhatLinksHere\getFilterPanel(), getFinalGroupName(), FormSpecialPage\getForm(), SpecialMute\getForm(), SpecialContributions\getForm(), SpecialPageLanguage\getFormFields(), SpecialEmailUser\getFormFields(), SpecialResetTokens\getFormFields(), SpecialChangeEmail\getFormFields(), SpecialBotPasswords\getFormFields(), SpecialChangeContentModel\getFormFields(), SpecialBlock\getFormFields(), SpecialRedirect\getFormFields(), SpecialStatistics\getGroupStats(), SpecialActiveUsers\getIntroText(), SpecialProtectedtitles\getLevelMenu(), SpecialProtectedpages\getLevelMenu(), SpecialImport\getMappingFormPart(), SpecialEditWatchlist\getNormalForm(), RandomPage\getNsList(), SpecialStatistics\getOtherStats(), SpecialUnusedCategories\getPageHeader(), SpecialLonelyPages\getPageHeader(), SpecialDeadendPages\getPageHeader(), WantedFilesPage\getPageHeader(), SpecialBrokenRedirects\getPageHeader(), SpecialDoubleRedirects\getPageHeader(), SpecialUnusedImages\getPageHeader(), SpecialUnusedTemplates\getPageHeader(), LoginSignupSpecialPage\getPageHtml(), SpecialStatistics\getPageStats(), SpecialVersion\getParserFunctionHooks(), SpecialVersion\getParserTags(), SpecialWhatLinksHere\getPrevNext(), SpecialEditWatchlist\getRawForm(), SpecialVersion\getSkinCredits(), SpecialMediaStatistics\getTableHeaderRow(), SpecialProtectedpages\getTypeMenu(), SpecialUpload\getUploadForm(), SpecialStatistics\getUserStats(), SpecialVersion\getWgHooks(), UserrightsPage\groupCheckboxes(), ChangesListSpecialPage\includeRcFiltersApp(), SpecialVersion\listAuthors(), SpecialWhatLinksHere\listItem(), LoginSignupSpecialPage\load(), SpecialUpload\loadRequest(), LoginSignupSpecialPage\mainLoginForm(), SpecialExpandTemplates\makeForm(), UserrightsPage\makeGroupNameList(), LoginSignupSpecialPage\makeLanguageSelector(), SpecialExpandTemplates\makeOutput(), WantedQueryPage\makeWlhLink(), SpecialMostLinkedTemplates\makeWlhLink(), SpecialMergeHistory\merge(), SpecialRecentChanges\namespaceFilterForm(), SpecialLockdb\onSubmit(), SpecialRandomInCategory\onSubmit(), SpecialUnlockdb\onSuccess(), SpecialLockdb\onSuccess(), SpecialPasswordReset\onSuccess(), SpecialChangeContentModel\onSuccess(), SpecialBotPasswords\onSuccess(), SpecialBlock\onSuccess(), SpecialVersion\openExtType(), SpecialRecentChanges\optionsPanel(), SpecialUploadStash\outputContents(), outputHeader(), SpecialUploadStash\outputLocalFile(), SpecialUploadStash\outputLocallyScaledThumb(), SpecialMediaStatistics\outputMediaType(), SpecialListGroupRights\outputNamespaceProtectionInfo(), SpecialRecentChangesLinked\outputNoResults(), ChangesListSpecialPage\outputNoResults(), SpecialSpecialpages\outputPageList(), SpecialUploadStash\outputRemoteScaledThumb(), SpecialMediaStatistics\outputResults(), SpecialEditWatchlist\outputSubtitle(), SpecialMediaStatistics\outputTableEnd(), SpecialMediaStatistics\outputTableRow(), ChangesListSpecialPage\outputTimeout(), SpecialUploadStash\parseKey(), SpecialBlock\postText(), SpecialBlock\preText(), SpecialTags\processCreateTagForm(), SpecialTags\processTagForm(), SpecialUpload\processUpload(), SpecialUpload\processVerificationError(), SpecialJavaScriptTest\renderPage(), SpecialEmailUser\sendEmailForm(), SpecialUserLogin\setHeaders(), SpecialNewFiles\setTopText(), SpecialRecentChanges\setTopText(), SpecialSearch\setupPage(), SpecialTags\showActivateDeactivateForm(), SpecialAllPages\showChunk(), SpecialEditTags\showConvenienceLinks(), SpecialRevisionDelete\showConvenienceLinks(), SpecialTags\showDeleteTagForm(), UserrightsPage\showEditUserGroupsForm(), SpecialDiff\showForm(), MovePageForm\showForm(), SpecialEditTags\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), SpecialSearch\showGoogleSearch(), SpecialMergeHistory\showHistory(), SpecialUndelete\showHistory(), SpecialExpandTemplates\showHtmlPreview(), SpecialWhatLinksHere\showIndirectLinks(), SpecialAutoblockList\showList(), SpecialBookSources\showList(), SpecialBlockList\showList(), SpecialUndelete\showList(), SpecialMergeHistory\showMergeForm(), SpecialProtectedpages\showOptions(), SpecialProtectedtitles\showOptions(), SpecialPrefixindex\showPrefixChunk(), SpecialUpload\showRecoverableUploadError(), SpecialConfirmEmail\showRequestForm(), SpecialUndelete\showRevision(), SpecialUndelete\showSearchForm(), SpecialTags\showTagList(), SpecialEditWatchlist\showTitles(), SpecialAutoblockList\showTotal(), SpecialUpload\showUploadError(), SpecialUploadStash\showUploads(), SpecialUpload\showUploadWarning(), SpecialUpload\showViewDeletedLinks(), SpecialRevisionDelete\submit(), SpecialEditWatchlist\submitNormal(), SpecialEditWatchlist\submitRaw(), SpecialConfirmEmail\submitSend(), SpecialLinkAccounts\success(), SpecialEditTags\success(), SpecialRevisionDelete\success(), SpecialUserLogin\successfulAction(), SpecialCreateAccount\successfulAction(), UserrightsPage\switchForm(), SpecialUndelete\undelete(), SpecialUpload\unsaveUploadedFile(), SpecialEmailUser\userForm(), SpecialChangeContentModel\validateTitle(), and SpecialWhatLinksHere\whatlinkshereForm().

◆ outputHeader()

SpecialPage::outputHeader (   $summaryMessageKey = '')
protected

Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e.

by extensions to stick with the naming conventions for message keys: 'extensionname-xxx'

Stable to override

Parameters
string$summaryMessageKeyMessage key of the summary

Definition at line 662 of file SpecialPage.php.

References getName(), getOutput(), including(), and msg().

Referenced by SpecialRedirect\alterForm(), SpecialListFiles\execute(), SpecialNewFiles\execute(), SpecialProtectedpages\execute(), SpecialProtectedtitles\execute(), SpecialSpecialpages\execute(), SpecialCategories\execute(), SpecialLog\execute(), SpecialActiveUsers\execute(), SpecialLinkAccounts\execute(), SpecialListGrants\execute(), SpecialTrackingCategories\execute(), SpecialUnlinkAccounts\execute(), SpecialPreferences\execute(), SpecialStatistics\execute(), SpecialContributions\execute(), SpecialListUsers\execute(), SpecialExport\execute(), SpecialBookSources\execute(), SpecialListGroupRights\execute(), SpecialUnblock\execute(), SpecialDeletedContributions\execute(), SpecialWhatLinksHere\execute(), SpecialBlockList\execute(), SpecialAutoblockList\execute(), SpecialPasswordPolicies\execute(), SpecialPrefixindex\execute(), SpecialTags\execute(), SpecialComparePages\execute(), SpecialChangeCredentials\execute(), SpecialAllPages\execute(), SpecialLinkSearch\execute(), DisabledSpecialPage\execute(), SpecialPagesWithProp\execute(), SpecialEditTags\execute(), SpecialImport\execute(), SpecialVersion\execute(), MovePageForm\execute(), UserrightsPage\execute(), SpecialEditWatchlist\execute(), SpecialFileDuplicateSearch\execute(), SpecialEmailUser\execute(), SpecialMergeHistory\execute(), SpecialRevisionDelete\execute(), SpecialNewpages\execute(), SpecialUpload\execute(), SpecialMIMESearch\execute(), SpecialUndelete\execute(), ChangesListSpecialPage\execute(), QueryPage\execute(), execute(), SpecialSearch\setupPage(), SpecialNewSection\showNoRedirectPage(), SpecialPermanentLink\showNoRedirectPage(), SpecialRedirectWithAction\showNoRedirectPage(), SpecialDiff\showNoRedirectPage(), and SpecialUploadStash\showUploads().

◆ prefixSearchArray()

static SpecialPage::prefixSearchArray (   $search,
  $limit,
array  $subpages,
  $offset 
)
staticprotected

Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Since
1.24
Parameters
string$search
int$limit
array$subpages
int$offset
Returns
string[]

Definition at line 561 of file SpecialPage.php.

Referenced by SpecialPagesWithProp\prefixSearchSubpages(), and prefixSearchSubpages().

◆ prefixSearchString()

SpecialPage::prefixSearchString (   $search,
  $limit,
  $offset 
)
protected

Perform a regular substring search for prefixSearchSubpages.

Parameters
string$searchPrefix to search for
int$limitMaximum number of results to return (usually 10)
int$offsetNumber of results to skip (usually 0)
Returns
string[] Matching subpages

Definition at line 534 of file SpecialPage.php.

References $t, $title, and Title\newFromText().

Referenced by SpecialChangeContentModel\prefixSearchSubpages(), SpecialRecentChangesLinked\prefixSearchSubpages(), SpecialPrefixindex\prefixSearchSubpages(), SpecialPageLanguage\prefixSearchSubpages(), SpecialAllPages\prefixSearchSubpages(), SpecialWhatLinksHere\prefixSearchSubpages(), MovePageForm\prefixSearchSubpages(), and SpecialUndelete\prefixSearchSubpages().

◆ prefixSearchSubpages()

SpecialPage::prefixSearchSubpages (   $search,
  $limit,
  $offset 
)

Return an array of subpages beginning with $search that this special page will accept.

For example, if a page supports subpages "foo", "bar" and "baz" (as in Special:PageName/foo, etc.):

  • prefixSearchSubpages( "ba" ) should return [ "bar", "baz" ]
  • prefixSearchSubpages( "f" ) should return [ "foo" ]
  • prefixSearchSubpages( "z" ) should return []
  • prefixSearchSubpages( "" ) should return [ foo", "bar", "baz" ]

Stable to override

Parameters
string$searchPrefix to search for
int$limitMaximum number of results to return (usually 10)
int$offsetNumber of results to skip (usually 0)
Returns
string[] Matching subpages

Reimplemented in SpecialUndelete, SpecialBlock, UserrightsPage, MovePageForm, SpecialContributions, SpecialWhatLinksHere, SpecialEmailUser, SpecialAllPages, SpecialPageLanguage, SpecialPrefixindex, SpecialRecentChangesLinked, SpecialUnblock, SpecialFileDuplicateSearch, SpecialChangeContentModel, SpecialDeletedContributions, SpecialPagesWithProp, and SpecialListFiles.

Definition at line 505 of file SpecialPage.php.

References getSubpagesForPrefixSearch(), and prefixSearchArray().

◆ requireLogin()

SpecialPage::requireLogin (   $reasonMsg = 'exception-nologin-text',
  $titleMsg = 'exception-nologin' 
)

If the user is not logged in, throws UserNotLoggedIn error.

The user will be redirected to Special:Userlogin with the given message as an error on the form.

Since
1.23
Parameters
string$reasonMsg[optional] Message key to be displayed on login page
string$titleMsg[optional] Passed on to UserNotLoggedIn constructor
Exceptions
UserNotLoggedIn

Definition at line 373 of file SpecialPage.php.

References getUser().

Referenced by SpecialChangeEmail\checkExecutePermissions(), SpecialPreferences\execute(), SpecialConfirmEmail\execute(), SpecialMute\execute(), SpecialResetTokens\execute(), SpecialWatchlist\execute(), SpecialBotPasswords\execute(), and SpecialEditWatchlist\execute().

◆ run()

SpecialPage::run (   $subPage)
final

Entry point.

Since
1.20
Parameters
string | null$subPage

Definition at line 592 of file SpecialPage.php.

References afterExecute(), beforeExecute(), execute(), and getHookRunner().

◆ setContext()

SpecialPage::setContext (   $context)

Sets the context this SpecialPage is executed in.

Parameters
IContextSource$context
Since
1.18

Definition at line 707 of file SpecialPage.php.

Referenced by Skin\buildNavUrls(), ApiQueryUsers\execute(), SpecialEmailUser\execute(), and LoginSignupSpecialPage\setSessionUserForCurrentRequest().

◆ setHeaders()

SpecialPage::setHeaders ( )
protected

Sets headers - this should be called from the execute() method of all derived classes! Stable to override.

Reimplemented in SpecialUserLogin.

Definition at line 571 of file SpecialPage.php.

References getConfig(), getDescription(), getOutput(), and getRobotPolicy().

Referenced by SpecialListFiles\execute(), SpecialBlankpage\execute(), SpecialCategories\execute(), SpecialLog\execute(), SpecialNewFiles\execute(), SpecialProtectedpages\execute(), SpecialProtectedtitles\execute(), SpecialSpecialpages\execute(), SpecialActiveUsers\execute(), SpecialLinkAccounts\execute(), SpecialListGrants\execute(), SpecialEmailInvalidate\execute(), SpecialTrackingCategories\execute(), SpecialUnlinkAccounts\execute(), SpecialListUsers\execute(), SpecialContributions\execute(), SpecialPreferences\execute(), SpecialStatistics\execute(), SpecialExport\execute(), SpecialGoToInterwiki\execute(), SpecialListGroupRights\execute(), SpecialBookSources\execute(), SpecialApiSandbox\execute(), SpecialUnblock\execute(), SpecialDeletedContributions\execute(), SpecialWhatLinksHere\execute(), SpecialAllMessages\execute(), SpecialBlockList\execute(), SpecialPasswordPolicies\execute(), SpecialAutoblockList\execute(), SpecialPrefixindex\execute(), SpecialChangeCredentials\execute(), SpecialComparePages\execute(), SpecialTags\execute(), SpecialUserLogout\execute(), SpecialExpandTemplates\execute(), SpecialAllPages\execute(), RandomPage\execute(), SpecialLinkSearch\execute(), SpecialConfirmEmail\execute(), DisabledSpecialPage\execute(), SpecialPagesWithProp\execute(), SpecialEditTags\execute(), SpecialVersion\execute(), SpecialImport\execute(), MovePageForm\execute(), UserrightsPage\execute(), SpecialEditWatchlist\execute(), SpecialFileDuplicateSearch\execute(), SpecialEmailUser\execute(), SpecialMergeHistory\execute(), SpecialRevisionDelete\execute(), SpecialNewpages\execute(), SpecialUpload\execute(), SpecialMIMESearch\execute(), FormSpecialPage\execute(), SpecialUndelete\execute(), LoginSignupSpecialPage\execute(), ChangesListSpecialPage\execute(), QueryPage\execute(), execute(), SpecialSearch\setupPage(), SpecialNewSection\showNoRedirectPage(), SpecialPermanentLink\showNoRedirectPage(), SpecialRedirectWithAction\showNoRedirectPage(), SpecialDiff\showNoRedirectPage(), and SpecialUploadStash\showUploads().

◆ setHookContainer()

SpecialPage::setHookContainer ( HookContainer  $hookContainer)
Since
1.35

Definition at line 988 of file SpecialPage.php.

References $hookContainer.

◆ setLinkRenderer()

SpecialPage::setLinkRenderer ( LinkRenderer  $linkRenderer)
Since
1.28
Parameters
\\MediaWiki\\Linker\\LinkRenderer$linkRenderer

Definition at line 956 of file SpecialPage.php.

References $linkRenderer.

◆ setListed()

SpecialPage::setListed (   $listed)

Set whether this page is listed in Special:Specialpages, at run-time.

Since
1.3
Deprecated:
since 1.35
Parameters
bool$listedSet via subclassing UnlistedSpecialPage, get via isListed()
Returns
bool

Definition at line 196 of file SpecialPage.php.

References wfDeprecated(), and wfSetVar().

◆ setReauthPostData()

SpecialPage::setReauthPostData ( array  $data)
protected

Record preserved POST data after a reauthentication.

This is called from checkLoginSecurityLevel() when returning from the redirect for reauthentication, if the redirect had been served in response to a POST request.

The base SpecialPage implementation does nothing. If your subclass uses getLoginSecurityLevel() or checkLoginSecurityLevel(), it should probably implement this to do something with the data.

Stable to override

Since
1.32
Parameters
array$data

Reimplemented in FormSpecialPage.

Definition at line 408 of file SpecialPage.php.

Referenced by checkLoginSecurityLevel().

◆ userCanExecute()

SpecialPage::userCanExecute ( User  $user)

Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Can be overridden by sub- classes with more complicated permissions schemes.

Stable to override

Parameters
User$userThe user to check
Returns
bool Does the user have permission to view the page?

Reimplemented in SpecialUndelete, SpecialUpload, SpecialCreateAccount, and SpecialPasswordReset.

Definition at line 320 of file SpecialPage.php.

Referenced by checkPermissions().

◆ useTransactionalTimeLimit()

SpecialPage::useTransactionalTimeLimit ( )
protected

Member Data Documentation

◆ $hookContainer

HookContainer null SpecialPage::$hookContainer
private

Definition at line 74 of file SpecialPage.php.

Referenced by getHookContainer(), and setHookContainer().

◆ $hookRunner

HookRunner null SpecialPage::$hookRunner
private

Definition at line 76 of file SpecialPage.php.

Referenced by getHookRunner().

◆ $linkRenderer

MediaWiki Linker LinkRenderer null SpecialPage::$linkRenderer
private

Definition at line 71 of file SpecialPage.php.

Referenced by SpecialEditWatchlist\buildRemoveLine(), SpecialEditWatchlist\buildTools(), MovePageForm\doSubmit(), SpecialTags\doTagRow(), SpecialTrackingCategories\execute(), SpecialListGroupRights\execute(), SpecialPasswordPolicies\execute(), SpecialNewpages\filterLinks(), WantedQueryPage\formatResult(), SpecialFewestRevisions\formatResult(), SpecialUnusedTemplates\formatResult(), SpecialMostCategories\formatResult(), SpecialMostInterwikis\formatResult(), SpecialAncientPages\formatResult(), SpecialBrokenRedirects\formatResult(), SpecialMostLinked\formatResult(), SpecialUnwatchedPages\formatResult(), SpecialDoubleRedirects\formatResult(), SpecialListRedirects\formatResult(), SpecialShortPages\formatResult(), SpecialMIMESearch\formatResult(), SpecialFileDuplicateSearch\formatResult(), SpecialMergeHistory\formatRevisionRow(), SpecialNewpages\formatRow(), SpecialEmailUser\getFormFields(), SpecialBotPasswords\getFormFields(), SpecialStatistics\getGroupStats(), getLinkRenderer(), SpecialStatistics\getPageStats(), SpecialDeletedContributions\getSubTitle(), SpecialContributions\getUserLinks(), SpecialVersion\listAuthors(), SpecialMostLinked\makeWlhLink(), SpecialMergeHistory\merge(), SpecialListGroupRights\outputNamespaceProtectionInfo(), SpecialMediaStatistics\outputTableRow(), SpecialBlock\postText(), setLinkRenderer(), SpecialAllPages\showChunk(), SpecialEditTags\showConvenienceLinks(), SpecialRevisionDelete\showConvenienceLinks(), SpecialRevisionDelete\showForm(), SpecialUndelete\showList(), SpecialSearch\showResults(), SpecialChangeCredentials\showSubpageList(), MovePageForm\showSubpagesList(), SpecialEditWatchlist\showTitles(), SpecialUploadStash\showUploads(), SpecialUpload\showUploadWarning(), and SpecialWhatLinksHere\wlhLink().

◆ $mContext

IContextSource SpecialPage::$mContext
protected

Current request context.

Definition at line 66 of file SpecialPage.php.

Referenced by getContext().

◆ $mIncludable

SpecialPage::$mIncludable
protected

Definition at line 60 of file SpecialPage.php.

Referenced by isIncludable().

◆ $mIncluding

SpecialPage::$mIncluding
protected

Definition at line 57 of file SpecialPage.php.

◆ $mListed

SpecialPage::$mListed
private

Definition at line 54 of file SpecialPage.php.

Referenced by isListed().

◆ $mLocalName

SpecialPage::$mLocalName
private

Definition at line 47 of file SpecialPage.php.

Referenced by getLocalName().

◆ $mName

SpecialPage::$mName
protected

Definition at line 44 of file SpecialPage.php.

Referenced by SpecialCachedPage\getCacheKey(), and getName().

◆ $mRestriction

SpecialPage::$mRestriction
protected

Definition at line 51 of file SpecialPage.php.

Referenced by getRestriction().


The documentation for this class was generated from the following file: