MediaWiki master
MediaWiki\SpecialPage\SpecialPage Class Reference

Parent class for all special pages. More...

Inherits MessageLocalizer.

Inherited by MediaWiki\SpecialPage\AuthManagerSpecialPage, MediaWiki\SpecialPage\ChangesListSpecialPage, MediaWiki\SpecialPage\FormSpecialPage, MediaWiki\SpecialPage\IncludableSpecialPage, MediaWiki\SpecialPage\QueryPage, MediaWiki\SpecialPage\UnlistedSpecialPage, MediaWiki\Specials\SpecialActiveUsers, MediaWiki\Specials\SpecialAllMessages, MediaWiki\Specials\SpecialApiSandbox, MediaWiki\Specials\SpecialAutoblockList, MediaWiki\Specials\SpecialBlockList, MediaWiki\Specials\SpecialBookSources, MediaWiki\Specials\SpecialCategories, MediaWiki\Specials\SpecialComparePages, MediaWiki\Specials\SpecialDeletedContributions, MediaWiki\Specials\SpecialEditRecovery, MediaWiki\Specials\SpecialEmailUser, MediaWiki\Specials\SpecialExpandTemplates, MediaWiki\Specials\SpecialExport, MediaWiki\Specials\SpecialFileDuplicateSearch, MediaWiki\Specials\SpecialImport, MediaWiki\Specials\SpecialJavaScriptTest, MediaWiki\Specials\SpecialListGrants, MediaWiki\Specials\SpecialListGroupRights, MediaWiki\Specials\SpecialLog, MediaWiki\Specials\SpecialMergeHistory, MediaWiki\Specials\SpecialPasswordPolicies, MediaWiki\Specials\SpecialPreferences, MediaWiki\Specials\SpecialProtectedPages, MediaWiki\Specials\SpecialProtectedTitles, MediaWiki\Specials\SpecialRandomPage, MediaWiki\Specials\SpecialRenameUser, MediaWiki\Specials\SpecialSearch, MediaWiki\Specials\SpecialStatistics, MediaWiki\Specials\SpecialTags, MediaWiki\Specials\SpecialTrackingCategories, MediaWiki\Specials\SpecialUnblock, MediaWiki\Specials\SpecialUndelete, MediaWiki\Specials\SpecialUpload, MediaWiki\Specials\SpecialUserRights, and MediaWiki\Specials\SpecialVersion.

Collaboration diagram for MediaWiki\SpecialPage\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.
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators.
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError.
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError.
 
 doesWrites ()
 Indicates whether this special page may perform database writes.
 
 execute ( $subPage)
 Default execute method Checks user permissions.
 
 getAssociatedNavigationLinks ()
 Return an array of strings representing page titles that are discoverable to end users via UI.
 
 getAuthority ()
 Shortcut to get the Authority executing this instance.
 
 getConfig ()
 Shortcut to get main config object.
 
 getContentLanguage ()
 Shortcut to get content language.
 
 getContext ()
 Gets the context this SpecialPage is executed in.
 
 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.
 
 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.
 
 getFullTitle ()
 Return the full title, including $par.
 
 getLanguage ()
 Shortcut to get user's language.
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page.
 
 getName ()
 Get the canonical, unlocalized name of this special page without namespace.
 
 getOutput ()
 Get the OutputPage being used for this instance.
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object.
 
 getRequest ()
 Get the WebRequest being used for this instance.
 
 getRestriction ()
 Get the permission that a user must have to execute this page.
 
 getShortDescription (string $path='')
 Similar to getDescription but takes into account sub pages and designed for display in tabs.
 
 getSkin ()
 Shortcut to get the skin being used for this instance.
 
 getUser ()
 Shortcut to get the User executing this instance.
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion.
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode.
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}.
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages.
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes.
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included.
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context.
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept.
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error.
 
 requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in or is a temporary user, throws UserNotLoggedIn.
 
 run ( $subPage)
 Entry point.
 
 setContentLanguage (Language $contentLanguage)
 Set content language.
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in.
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).
 

Static Public Member Functions

static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage.
 
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.
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name.
 
static newSearchPage (User $user)
 Get the users preferred search page.
 

Protected Member Functions

 addFeedLinks ( $params)
 Adds RSS/atom links.
 
 afterExecute ( $subPage)
 Gets called after.
 
 authorizeAction (?string $action=null)
 Utility function for authorizing an action to be performed by the special page.
 
 beforeExecute ( $subPage)
 Gets called before.
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging.
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process.
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have.
 
 getAuthManager ()
 
 getCacheTTL ()
 
 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'.
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.
 
 getRobotPolicy ()
 Return the robot policy.
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches.
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages By default the message key is the canonical name of the special page May be overridden, i.e.
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages.
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor.
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes!
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication.
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed.
 

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).
 

Protected Attributes

IContextSource $mContext
 Current request context.
 
bool $mIncludable
 Whether the special page can be included in an article.
 
bool $mIncluding
 Whether or not this special page is being included from an article.
 
string $mName
 The canonical name of this special page Also used as the message key for the default.
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone.
 

Detailed Description

Parent class for all special pages.

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

Stability: stable
to extend

Definition at line 66 of file SpecialPage.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\SpecialPage\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()

Stability: 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 212 of file SpecialPage.php.

Member Function Documentation

◆ addFeedLinks()

MediaWiki\SpecialPage\SpecialPage::addFeedLinks ( $params)
protected

Adds RSS/atom links.

Parameters
array$params

Definition at line 1009 of file SpecialPage.php.

References $params, $url, wfAppendQuery(), and wfScript().

Referenced by MediaWiki\SpecialPage\ContributionsSpecialPage\execute(), and MediaWiki\Specials\SpecialWatchlist\outputFeedLinks().

◆ addHelpLink()

MediaWiki\SpecialPage\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 1027 of file SpecialPage.php.

Referenced by MediaWiki\Specials\SpecialBlock\alterForm(), MediaWiki\Specials\SpecialChangeContentModel\alterForm(), MediaWiki\SpecialPage\ContributionsSpecialPage\execute(), MediaWiki\Specials\SpecialAllMessages\execute(), MediaWiki\Specials\SpecialApiSandbox\execute(), MediaWiki\Specials\SpecialAutoblockList\execute(), MediaWiki\Specials\SpecialBlockList\execute(), MediaWiki\Specials\SpecialBotPasswords\execute(), MediaWiki\Specials\SpecialBrokenRedirects\execute(), MediaWiki\Specials\SpecialCategories\execute(), MediaWiki\Specials\SpecialComparePages\execute(), MediaWiki\Specials\SpecialDeletedContributions\execute(), MediaWiki\Specials\SpecialDoubleRedirects\execute(), MediaWiki\Specials\SpecialExport\execute(), MediaWiki\Specials\SpecialLinkSearch\execute(), MediaWiki\Specials\SpecialListDuplicatedFiles\execute(), MediaWiki\Specials\SpecialListFiles\execute(), MediaWiki\Specials\SpecialListGroupRights\execute(), MediaWiki\Specials\SpecialListRedirects\execute(), MediaWiki\Specials\SpecialLog\execute(), MediaWiki\Specials\SpecialMIMESearch\execute(), MediaWiki\Specials\SpecialMute\execute(), MediaWiki\Specials\SpecialNewFiles\execute(), MediaWiki\Specials\SpecialNewPages\execute(), MediaWiki\Specials\SpecialPasswordPolicies\execute(), MediaWiki\Specials\SpecialPreferences\execute(), MediaWiki\Specials\SpecialProtectedPages\execute(), MediaWiki\Specials\SpecialProtectedTitles\execute(), MediaWiki\Specials\SpecialRenameUser\execute(), MediaWiki\Specials\SpecialSpecialPages\execute(), MediaWiki\Specials\SpecialTags\execute(), MediaWiki\Specials\SpecialTrackingCategories\execute(), MediaWiki\Specials\SpecialUnblock\execute(), MediaWiki\Specials\SpecialUncategorizedImages\execute(), MediaWiki\Specials\SpecialUncategorizedPages\execute(), MediaWiki\Specials\SpecialUndelete\execute(), MediaWiki\Specials\SpecialUnwatchedPages\execute(), MediaWiki\Specials\SpecialUpload\execute(), MediaWiki\Specials\SpecialUserRights\execute(), MediaWiki\Specials\SpecialEditRecovery\execute(), MediaWiki\Specials\SpecialExpandTemplates\execute(), MediaWiki\Specials\SpecialRecentChanges\execute(), MediaWiki\Specials\SpecialWatchlist\execute(), MediaWiki\Specials\SpecialRecentChangesLinked\getExtraOptions(), MediaWiki\Specials\SpecialRandomInCategory\getFormFields(), MediaWiki\Specials\SpecialSearch\setupPage(), MediaWiki\Specials\SpecialMovePage\showForm(), MediaWiki\Specials\SpecialEditTags\showForm(), MediaWiki\Specials\SpecialRevisionDelete\showForm(), MediaWiki\Specials\SpecialDiff\showNoRedirectPage(), MediaWiki\Specials\SpecialNewSection\showNoRedirectPage(), and MediaWiki\Specials\SpecialPermanentLink\showNoRedirectPage().

◆ afterExecute()

MediaWiki\SpecialPage\SpecialPage::afterExecute ( $subPage)
protected

Gets called after.

See also
SpecialPage::execute.
Stability: stable
to override
Since
1.20
Parameters
string | null$subPage

Definition at line 747 of file SpecialPage.php.

◆ authorizeAction()

MediaWiki\SpecialPage\SpecialPage::authorizeAction ( ?string $action = null)
protected

Utility function for authorizing an action to be performed by the special page.

User blocks and rate limits are enforced implicitly.

See also
Authority::authorizeAction.
Parameters
?string$actionIf not given, the action returned by getRestriction() will be used.
Returns
PermissionStatus

Definition at line 372 of file SpecialPage.php.

◆ beforeExecute()

MediaWiki\SpecialPage\SpecialPage::beforeExecute ( $subPage)
protected

Gets called before.

See also
SpecialPage::execute. Return false to prevent calling execute() (since 1.27+).
Stability: stable
to override
Since
1.20
Parameters
string | null$subPage
Returns
bool|void

Reimplemented in MediaWiki\SpecialPage\AuthManagerSpecialPage, MediaWiki\SpecialPage\LoginSignupSpecialPage, and MediaWiki\Specials\SpecialUserLogin.

Definition at line 735 of file SpecialPage.php.

◆ buildPrevNextNavigation()

MediaWiki\SpecialPage\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 | false$subpageOptional param for specifying subpage
Returns
string

Definition at line 1134 of file SpecialPage.php.

◆ checkLoginSecurityLevel()

MediaWiki\SpecialPage\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 515 of file SpecialPage.php.

References $url, getRequest(), PROTO_HTTPS, wfArrayToCgi(), and wfMessage().

Referenced by MediaWiki\SpecialPage\FormSpecialPage\execute().

◆ checkPermissions()

◆ checkReadOnly()

◆ displayRestrictionError()

MediaWiki\SpecialPage\SpecialPage::displayRestrictionError ( )
protected

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

Stability: stable
to override
Exceptions
PermissionsError
Returns
never

Definition at line 390 of file SpecialPage.php.

Referenced by MediaWiki\Specials\SpecialUndelete\checkPermissions().

◆ doesWrites()

◆ execute()

MediaWiki\SpecialPage\SpecialPage::execute ( $subPage)

Default execute method Checks user permissions.

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

Stability: stable
to override
Parameters
string | null$subPage

Reimplemented in MediaWiki\Specials\SpecialConfirmEmail, MediaWiki\Specials\SpecialEmailInvalidate, MediaWiki\Specials\SpecialBookSources, MediaWiki\Specials\SpecialEditWatchlist, MediaWiki\SpecialPage\ContributionsSpecialPage, MediaWiki\SpecialPage\FormSpecialPage, MediaWiki\SpecialPage\QueryPage, MediaWiki\Specials\SpecialActiveUsers, MediaWiki\Specials\SpecialAllMessages, MediaWiki\Specials\SpecialAllPages, MediaWiki\Specials\SpecialApiHelp, MediaWiki\Specials\SpecialApiSandbox, MediaWiki\Specials\SpecialAutoblockList, MediaWiki\Specials\SpecialBlankpage, MediaWiki\Specials\SpecialBlock, MediaWiki\Specials\SpecialBlockList, MediaWiki\Specials\SpecialBotPasswords, MediaWiki\Specials\SpecialBrokenRedirects, MediaWiki\Specials\SpecialCategories, MediaWiki\Specials\SpecialChangeEmail, MediaWiki\Specials\SpecialComparePages, MediaWiki\Specials\SpecialContribute, MediaWiki\Specials\SpecialDeletedContributions, MediaWiki\Specials\SpecialDoubleRedirects, MediaWiki\Specials\SpecialEditTags, MediaWiki\Specials\SpecialEmailUser, MediaWiki\Specials\SpecialExport, MediaWiki\Specials\SpecialFileDuplicateSearch, MediaWiki\Specials\SpecialGoToInterwiki, MediaWiki\Specials\SpecialImport, MediaWiki\Specials\SpecialJavaScriptTest, MediaWiki\Specials\SpecialLinkSearch, MediaWiki\Specials\SpecialListDuplicatedFiles, MediaWiki\Specials\SpecialListFiles, MediaWiki\Specials\SpecialListGrants, MediaWiki\Specials\SpecialListGroupRights, MediaWiki\Specials\SpecialListRedirects, MediaWiki\Specials\SpecialListUsers, MediaWiki\Specials\SpecialLog, MediaWiki\Specials\SpecialMergeHistory, MediaWiki\Specials\SpecialMIMESearch, MediaWiki\Specials\SpecialMovePage, MediaWiki\Specials\SpecialMute, MediaWiki\Specials\SpecialNewFiles, MediaWiki\Specials\SpecialNewPages, MediaWiki\Specials\SpecialPagesWithProp, MediaWiki\Specials\SpecialPasswordPolicies, MediaWiki\Specials\SpecialPasswordReset, MediaWiki\Specials\SpecialPreferences, MediaWiki\Specials\SpecialPrefixIndex, MediaWiki\Specials\SpecialProtectedPages, MediaWiki\Specials\SpecialProtectedTitles, MediaWiki\Specials\SpecialRandomPage, MediaWiki\Specials\SpecialRenameUser, MediaWiki\Specials\SpecialResetTokens, MediaWiki\Specials\SpecialRevisionDelete, MediaWiki\Specials\SpecialRunJobs, MediaWiki\Specials\SpecialSearch, MediaWiki\Specials\SpecialSpecialPages, MediaWiki\Specials\SpecialStatistics, MediaWiki\Specials\SpecialTags, MediaWiki\Specials\SpecialTrackingCategories, MediaWiki\Specials\SpecialUnblock, MediaWiki\Specials\SpecialUncategorizedImages, MediaWiki\Specials\SpecialUncategorizedPages, MediaWiki\Specials\SpecialUndelete, MediaWiki\Specials\SpecialUnwatchedPages, MediaWiki\Specials\SpecialUpload, MediaWiki\Specials\SpecialUserLogout, MediaWiki\Specials\SpecialUserRights, MediaWiki\Specials\SpecialVersion, MediaWiki\Specials\SpecialWantedPages, MediaWiki\Specials\SpecialWithoutInterwiki, MediaWiki\SpecialPage\ChangesListSpecialPage, MediaWiki\SpecialPage\DisabledSpecialPage, MediaWiki\SpecialPage\LoginSignupSpecialPage, MediaWiki\SpecialPage\RedirectSpecialPage, MediaWiki\Specials\SpecialChangeCredentials, MediaWiki\Specials\SpecialEditRecovery, MediaWiki\Specials\SpecialExpandTemplates, MediaWiki\Specials\SpecialLinkAccounts, MediaWiki\Specials\SpecialPageData, MediaWiki\Specials\SpecialRecentChanges, MediaWiki\Specials\SpecialUnlinkAccounts, MediaWiki\Specials\SpecialUploadStash, and MediaWiki\Specials\SpecialWatchlist.

Definition at line 761 of file SpecialPage.php.

◆ getAssociatedNavigationLinks()

MediaWiki\SpecialPage\SpecialPage::getAssociatedNavigationLinks ( )

Return an array of strings representing page titles that are discoverable to end users via UI.

Since
1.39
Stability: stable
to call or override
Returns
string[] strings representing page titles that can be rendered by skins if required.

Reimplemented in MediaWiki\Specials\SpecialContribute, MediaWiki\Specials\SpecialContributions, MediaWiki\Specials\SpecialEditWatchlist, and MediaWiki\Specials\SpecialWatchlist.

Definition at line 637 of file SpecialPage.php.

◆ getAuthManager()

◆ getAuthority()

MediaWiki\SpecialPage\SpecialPage::getAuthority ( )

Shortcut to get the Authority executing this instance.

Returns
Authority
Since
1.36

Definition at line 902 of file SpecialPage.php.

Referenced by MediaWiki\Specials\SpecialUserRights\changeableGroups(), MediaWiki\Specials\SpecialChangeEmail\checkExecutePermissions(), MediaWiki\Specials\SpecialCreateAccount\checkPermissions(), MediaWiki\Specials\SpecialExport\doExport(), MediaWiki\Specials\SpecialWatchlist\doMainQuery(), MediaWiki\Specials\SpecialUserRights\doSaveUserGroups(), MediaWiki\Specials\SpecialConfirmEmail\execute(), MediaWiki\Specials\SpecialApiSandbox\execute(), MediaWiki\Specials\SpecialLog\execute(), MediaWiki\Specials\SpecialRevisionDelete\execute(), MediaWiki\Specials\SpecialUnblock\execute(), MediaWiki\Specials\SpecialUserRights\execute(), MediaWiki\Specials\SpecialUserRights\fetchUser(), MediaWiki\Specials\SpecialBrokenRedirects\formatResult(), MediaWiki\Specials\SpecialDoubleRedirects\formatResult(), MediaWiki\Specials\SpecialAutoblockList\getBlockListPager(), MediaWiki\Specials\SpecialBlock\getFormFields(), MediaWiki\Specials\SpecialBlock\maybeAlterFormDefaults(), MediaWiki\Specials\SpecialEmailUser\onFormSubmit(), MediaWiki\Specials\SpecialChangeContentModel\onSubmit(), MediaWiki\Specials\SpecialPageLanguage\onSubmit(), MediaWiki\SpecialPage\AuthManagerSpecialPage\performAuthenticationStep(), MediaWiki\Specials\SpecialBlock\postHtml(), MediaWiki\Specials\SpecialTags\showActivateDeactivateForm(), MediaWiki\Specials\SpecialTags\showDeleteTagForm(), MediaWiki\Specials\SpecialMovePage\showForm(), MediaWiki\Specials\SpecialUndelete\showHistory(), MediaWiki\Specials\SpecialPreferences\showResetForm(), MediaWiki\Specials\SpecialEditTags\submit(), MediaWiki\Specials\SpecialPreferences\submitReset(), MediaWiki\Specials\SpecialUserRights\userCanChangeRights(), and MediaWiki\Specials\SpecialExport\userCanOverrideExportDepth().

◆ getCacheTTL()

MediaWiki\SpecialPage\SpecialPage::getCacheTTL ( )
protected
Stability: stable
to override
Returns
int Seconds that this page can be cached

Reimplemented in MediaWiki\Specials\SpecialNewPages, and MediaWiki\Specials\SpecialRecentChanges.

Definition at line 278 of file SpecialPage.php.

Referenced by MediaWiki\SpecialPage\SpecialPage\maxIncludeCacheTime().

◆ getConfig()

MediaWiki\SpecialPage\SpecialPage::getConfig ( )

Shortcut to get main config object.

Returns
Config
Since
1.24

Definition at line 957 of file SpecialPage.php.

References getContext().

Referenced by MediaWiki\Specials\SpecialUpload\__construct(), MediaWiki\Specials\SpecialRecentChanges\__construct(), MediaWiki\Specials\SpecialPasswordReset\alterForm(), MediaWiki\Specials\SpecialBotPasswords\checkExecutePermissions(), MediaWiki\Specials\SpecialLockdb\checkExecutePermissions(), MediaWiki\Specials\SpecialUnlockdb\checkExecutePermissions(), MediaWiki\Specials\SpecialWatchlist\doMainQuery(), MediaWiki\Specials\SpecialRecentChangesLinked\doMainQuery(), MediaWiki\SpecialPage\ContributionsSpecialPage\execute(), MediaWiki\Specials\SpecialAllMessages\execute(), MediaWiki\Specials\SpecialAllPages\execute(), MediaWiki\Specials\SpecialBlock\execute(), MediaWiki\Specials\SpecialDeletedContributions\execute(), MediaWiki\Specials\SpecialEmailUser\execute(), MediaWiki\Specials\SpecialExport\execute(), MediaWiki\Specials\SpecialImport\execute(), MediaWiki\Specials\SpecialLinkSearch\execute(), MediaWiki\Specials\SpecialListGrants\execute(), MediaWiki\Specials\SpecialListGroupRights\execute(), MediaWiki\Specials\SpecialLog\execute(), MediaWiki\Specials\SpecialPasswordPolicies\execute(), MediaWiki\Specials\SpecialRenameUser\execute(), MediaWiki\Specials\SpecialRunJobs\execute(), MediaWiki\Specials\SpecialSearch\execute(), MediaWiki\SpecialPage\ChangesListSpecialPage\execute(), MediaWiki\SpecialPage\LoginSignupSpecialPage\execute(), MediaWiki\Specials\SpecialWatchlist\execute(), MediaWiki\Specials\SpecialNewPages\feed(), MediaWiki\Specials\SpecialNewPages\feedTitle(), MediaWiki\Specials\SpecialUserRights\fetchUser(), MediaWiki\Specials\SpecialBlock\getDisplayFormat(), MediaWiki\Specials\SpecialBlock\getFormFields(), MediaWiki\Specials\SpecialPageLanguage\getFormFields(), MediaWiki\Specials\SpecialPasswordReset\getFormFields(), MediaWiki\Specials\SpecialActiveUsers\getIntroText(), MediaWiki\Specials\SpecialProtectedPages\getLevelMenu(), MediaWiki\SpecialPage\ChangesListSpecialPage\getLinkDays(), MediaWiki\Specials\SpecialUnusedImages\getPageHeader(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getPageHtml(), MediaWiki\Specials\SpecialExport\getPagesFromCategory(), MediaWiki\Specials\SpecialExport\getPagesFromNamespace(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getPreservedParams(), MediaWiki\Specials\SpecialLinkSearch\getQueryInfo(), MediaWiki\Specials\SpecialShortPages\getQueryInfo(), MediaWiki\Specials\SpecialUnusedImages\getQueryInfo(), MediaWiki\Specials\SpecialWantedPages\getQueryInfo(), MediaWiki\Specials\SpecialChangeCredentials\getRequestBlacklist(), MediaWiki\Specials\SpecialLinkAccounts\getRequestBlacklist(), MediaWiki\Specials\SpecialRemoveCredentials\getRequestBlacklist(), MediaWiki\Specials\SpecialUnlinkAccounts\getRequestBlacklist(), MediaWiki\Specials\SpecialResetTokens\getTokensList(), MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp(), MediaWiki\Specials\SpecialBotPasswords\isListed(), MediaWiki\Specials\SpecialEmailUser\isListed(), MediaWiki\Specials\SpecialLinkSearch\linkParameters(), MediaWiki\SpecialPage\LoginSignupSpecialPage\load(), MediaWiki\SpecialPage\SpecialPage\maxIncludeCacheTime(), MediaWiki\Specials\SpecialBlock\maybeAlterFormDefaults(), MediaWiki\Specials\SpecialLockdb\onSubmit(), MediaWiki\Specials\SpecialUnlockdb\onSubmit(), MediaWiki\Specials\SpecialPasswordReset\onSuccess(), MediaWiki\Specials\SpecialWhatLinksHere\onSuccess(), MediaWiki\Specials\SpecialWatchlist\outputChangesList(), MediaWiki\Specials\SpecialAllPages\outputHTMLForm(), MediaWiki\Specials\SpecialBlock\preHtml(), MediaWiki\SpecialPage\ChangesListSpecialPage\registerFilters(), MediaWiki\Specials\SpecialMovePage\showForm(), MediaWiki\Specials\SpecialSearch\showResults(), MediaWiki\Specials\SpecialUserLogin\successfulAction(), MediaWiki\Specials\SpecialExport\validateLinkDepth(), and MediaWiki\SpecialPage\ChangesListSpecialPage\validateOptions().

◆ getContentLanguage()

◆ getContext()

MediaWiki\SpecialPage\SpecialPage::getContext ( )

Gets the context this SpecialPage is executed in.

Returns
IContextSource|RequestContext
Since
1.18

Definition at line 856 of file SpecialPage.php.

References wfDebug().

Referenced by MediaWiki\Specials\SpecialActiveUsers\buildForm(), MediaWiki\Specials\SpecialUserRights\changeableGroups(), MediaWiki\Specials\SpecialCreateAccount\checkPermissions(), MediaWiki\Specials\SpecialActiveUsers\execute(), MediaWiki\Specials\SpecialAllMessages\execute(), MediaWiki\Specials\SpecialApiHelp\execute(), MediaWiki\Specials\SpecialAutoblockList\execute(), MediaWiki\Specials\SpecialBlockList\execute(), MediaWiki\Specials\SpecialCategories\execute(), MediaWiki\Specials\SpecialComparePages\execute(), MediaWiki\Specials\SpecialDeletedContributions\execute(), MediaWiki\Specials\SpecialExport\execute(), MediaWiki\Specials\SpecialFileDuplicateSearch\execute(), MediaWiki\Specials\SpecialLinkSearch\execute(), MediaWiki\Specials\SpecialListFiles\execute(), MediaWiki\Specials\SpecialListUsers\execute(), MediaWiki\Specials\SpecialNewFiles\execute(), MediaWiki\Specials\SpecialPagesWithProp\execute(), MediaWiki\Specials\SpecialPreferences\execute(), MediaWiki\Specials\SpecialProtectedPages\execute(), MediaWiki\Specials\SpecialProtectedTitles\execute(), MediaWiki\Specials\SpecialStatistics\execute(), MediaWiki\Specials\SpecialUnblock\execute(), MediaWiki\SpecialPage\LoginSignupSpecialPage\execute(), MediaWiki\Specials\SpecialExpandTemplates\execute(), MediaWiki\Specials\SpecialNewPages\form(), MediaWiki\Specials\SpecialFewestRevisions\formatResult(), MediaWiki\Specials\SpecialMostCategories\formatResult(), MediaWiki\Specials\SpecialMostInterwikis\formatResult(), MediaWiki\Specials\SpecialMostLinked\formatResult(), MediaWiki\Specials\SpecialMostLinkedCategories\formatResult(), MediaWiki\Specials\SpecialMostLinkedTemplates\formatResult(), MediaWiki\Specials\SpecialShortPages\formatResult(), MediaWiki\Specials\SpecialUnwatchedPages\formatResult(), MediaWiki\SpecialPage\AuthManagerSpecialPage\getAuthForm(), MediaWiki\Specials\SpecialAutoblockList\getBlockListPager(), MediaWiki\Specials\SpecialBlockList\getBlockListPager(), MediaWiki\SpecialPage\FormSpecialPage\getForm(), MediaWiki\Specials\SpecialEditTags\getList(), MediaWiki\Specials\SpecialRevisionDelete\getList(), MediaWiki\Specials\SpecialMIMESearch\getPageHeader(), MediaWiki\Specials\SpecialWithoutInterwiki\getPageHeader(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getPageHtml(), MediaWiki\Specials\SpecialContributions\getPager(), MediaWiki\SpecialPage\AuthManagerSpecialPage\getRequest(), MediaWiki\Specials\SpecialUpload\getUploadForm(), ChangesListBooleanFilter\modifyQuery(), ChangesListStringOptionsFilterGroup\modifyQuery(), MediaWiki\Specials\SpecialChangeContentModel\onSubmit(), MediaWiki\Specials\SpecialPageLanguage\onSubmit(), MediaWiki\Specials\SpecialWatchlist\outputChangesList(), MediaWiki\Specials\SpecialAllPages\outputHTMLForm(), MediaWiki\SpecialPage\ImageQueryPage\outputResults(), MediaWiki\Specials\SpecialEmailUser\sendEmailForm(), MediaWiki\SpecialPage\AuthManagerSpecialPage\setRequest(), MediaWiki\Specials\SpecialTags\showActivateDeactivateForm(), MediaWiki\Specials\SpecialTags\showDeleteTagForm(), MediaWiki\Specials\SpecialUserRights\showEditUserGroupsForm(), MediaWiki\Specials\SpecialRevisionDelete\showForm(), MediaWiki\Specials\SpecialProtectedPages\showOptions(), MediaWiki\Specials\SpecialPreferences\showResetForm(), MediaWiki\SpecialPage\LoginSignupSpecialPage\showReturnToPage(), MediaWiki\SpecialPage\LoginSignupSpecialPage\showSuccessPage(), MediaWiki\Specials\SpecialPreferences\submitReset(), MediaWiki\Specials\SpecialUserLogin\successfulAction(), and MediaWiki\Specials\SpecialEmailUser\userForm().

◆ getDescription()

MediaWiki\SpecialPage\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.

Returning a string from this method has been deprecated since 1.41.

Stability: stable
to override
Returns
string|Message

Reimplemented in MediaWiki\Specials\Redirects\SpecialTalkPage, MediaWiki\Specials\SpecialCreateAccount, MediaWiki\Specials\SpecialDiff, MediaWiki\Specials\SpecialEditTags, MediaWiki\Specials\SpecialEmailUser, MediaWiki\Specials\SpecialMute, and MediaWiki\Specials\SpecialUserLogin.

Definition at line 806 of file SpecialPage.php.

Referenced by MediaWiki\Specials\SpecialNewPages\feedTitle().

◆ getFinalGroupName()

MediaWiki\SpecialPage\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 1052 of file SpecialPage.php.

◆ getFullTitle()

MediaWiki\SpecialPage\SpecialPage::getFullTitle ( )

◆ getGroupName()

MediaWiki\SpecialPage\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'.

Stability: stable
to override
Returns
string
Since
1.21

Reimplemented in MediaWiki\SpecialPage\ChangesListSpecialPage, MediaWiki\SpecialPage\ContributionsSpecialPage, MediaWiki\SpecialPage\LoginSignupSpecialPage, MediaWiki\SpecialPage\SpecialRedirectWithAction, MediaWiki\Specials\SpecialActiveUsers, MediaWiki\Specials\SpecialAllMessages, MediaWiki\Specials\SpecialAllPages, MediaWiki\Specials\SpecialAncientPages, MediaWiki\Specials\SpecialApiSandbox, MediaWiki\Specials\SpecialAutoblockList, MediaWiki\Specials\SpecialBlock, MediaWiki\Specials\SpecialBlockList, MediaWiki\Specials\SpecialBookSources, MediaWiki\Specials\SpecialBotPasswords, MediaWiki\Specials\SpecialBrokenRedirects, MediaWiki\Specials\SpecialCategories, MediaWiki\Specials\SpecialChangeContentModel, MediaWiki\Specials\SpecialChangeCredentials, MediaWiki\Specials\SpecialChangeEmail, MediaWiki\Specials\SpecialComparePages, MediaWiki\Specials\SpecialCreateAccount, MediaWiki\Specials\SpecialDeadendPages, MediaWiki\Specials\SpecialDeletedContributions, MediaWiki\Specials\SpecialDiff, MediaWiki\Specials\SpecialDoubleRedirects, MediaWiki\Specials\SpecialEditRecovery, MediaWiki\Specials\SpecialEditTags, MediaWiki\Specials\SpecialEmailUser, MediaWiki\Specials\SpecialExpandTemplates, MediaWiki\Specials\SpecialExport, MediaWiki\Specials\SpecialFewestRevisions, MediaWiki\Specials\SpecialFileDuplicateSearch, MediaWiki\Specials\SpecialFilepath, MediaWiki\Specials\SpecialGoToInterwiki, MediaWiki\Specials\SpecialImport, MediaWiki\Specials\SpecialJavaScriptTest, MediaWiki\Specials\SpecialLinkAccounts, MediaWiki\Specials\SpecialLinkSearch, MediaWiki\Specials\SpecialListDuplicatedFiles, MediaWiki\Specials\SpecialListFiles, MediaWiki\Specials\SpecialListGrants, MediaWiki\Specials\SpecialListGroupRights, MediaWiki\Specials\SpecialListRedirects, MediaWiki\Specials\SpecialListUsers, MediaWiki\Specials\SpecialLockdb, MediaWiki\Specials\SpecialLog, MediaWiki\Specials\SpecialLonelyPages, MediaWiki\Specials\SpecialLongPages, MediaWiki\Specials\SpecialMediaStatistics, MediaWiki\Specials\SpecialMergeHistory, MediaWiki\Specials\SpecialMIMESearch, MediaWiki\Specials\SpecialMostCategories, MediaWiki\Specials\SpecialMostImages, MediaWiki\Specials\SpecialMostInterwikis, MediaWiki\Specials\SpecialMostLinked, MediaWiki\Specials\SpecialMostLinkedCategories, MediaWiki\Specials\SpecialMostLinkedTemplates, MediaWiki\Specials\SpecialMostRevisions, MediaWiki\Specials\SpecialMovePage, MediaWiki\Specials\SpecialNewFiles, MediaWiki\Specials\SpecialNewPages, MediaWiki\Specials\SpecialNewSection, MediaWiki\Specials\SpecialPageLanguage, MediaWiki\Specials\SpecialPagesWithProp, MediaWiki\Specials\SpecialPasswordPolicies, MediaWiki\Specials\SpecialPasswordReset, MediaWiki\Specials\SpecialPermanentLink, MediaWiki\Specials\SpecialPreferences, MediaWiki\Specials\SpecialPrefixIndex, MediaWiki\Specials\SpecialProtectedPages, MediaWiki\Specials\SpecialProtectedTitles, MediaWiki\Specials\SpecialRandomInCategory, MediaWiki\Specials\SpecialRandomPage, MediaWiki\Specials\SpecialRedirect, MediaWiki\Specials\SpecialRenameUser, MediaWiki\Specials\SpecialResetTokens, MediaWiki\Specials\SpecialRevisionDelete, MediaWiki\Specials\SpecialSearch, MediaWiki\Specials\SpecialShortPages, MediaWiki\Specials\SpecialStatistics, MediaWiki\Specials\SpecialTags, MediaWiki\Specials\SpecialTrackingCategories, MediaWiki\Specials\SpecialUnblock, MediaWiki\Specials\SpecialUncategorizedImages, MediaWiki\Specials\SpecialUncategorizedPages, MediaWiki\Specials\SpecialUndelete, MediaWiki\Specials\SpecialUnlinkAccounts, MediaWiki\Specials\SpecialUnlockdb, MediaWiki\Specials\SpecialUnusedCategories, MediaWiki\Specials\SpecialUnusedImages, MediaWiki\Specials\SpecialUnusedTemplates, MediaWiki\Specials\SpecialUnwatchedPages, MediaWiki\Specials\SpecialUpload, MediaWiki\Specials\SpecialUserLogin, MediaWiki\Specials\SpecialUserLogout, MediaWiki\Specials\SpecialUserRights, MediaWiki\Specials\SpecialVersion, MediaWiki\Specials\SpecialWantedCategories, MediaWiki\Specials\SpecialWantedFiles, MediaWiki\Specials\SpecialWantedPages, MediaWiki\Specials\SpecialWantedTemplates, MediaWiki\Specials\SpecialWhatLinksHere, and MediaWiki\Specials\SpecialWithoutInterwiki.

Definition at line 1089 of file SpecialPage.php.

◆ getHookContainer()

◆ getHookRunner()

MediaWiki\SpecialPage\SpecialPage::getHookRunner ( )
protected
Access: internal
This is for use by core only. Hook interfaces may be removed without notice.
Since
1.35
Returns
HookRunner

Definition at line 1188 of file SpecialPage.php.

Referenced by MediaWiki\SpecialPage\RedirectSpecialArticle\__construct(), MediaWiki\SpecialPage\ChangesListSpecialPage\__construct(), MediaWiki\Specials\SpecialPageLanguage\alterForm(), MediaWiki\Specials\SpecialUserRights\doSaveUserGroups(), MediaWiki\SpecialPage\ContributionsSpecialPage\execute(), MediaWiki\Specials\SpecialImport\execute(), MediaWiki\Specials\SpecialLog\execute(), MediaWiki\Specials\SpecialRenameUser\execute(), MediaWiki\Specials\SpecialSearch\execute(), MediaWiki\Specials\SpecialStatistics\execute(), MediaWiki\Specials\SpecialTrackingCategories\execute(), MediaWiki\Specials\SpecialUpload\execute(), MediaWiki\SpecialPage\AuthManagerSpecialPage\fieldInfoToFormDescriptor(), MediaWiki\SpecialPage\FormSpecialPage\getForm(), MediaWiki\Specials\SpecialBlock\getFormFields(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getPageHtml(), MediaWiki\Specials\SpecialRandomPage\getQueryInfo(), MediaWiki\Specials\SpecialAncientPages\getQueryInfo(), MediaWiki\Specials\SpecialLonelyPages\getQueryInfo(), MediaWiki\Specials\SpecialShortPages\getQueryInfo(), MediaWiki\Specials\SpecialWantedPages\getQueryInfo(), MediaWiki\Specials\SpecialRandomPage\getRandomTitle(), MediaWiki\Specials\SpecialSearch\getSearchProfiles(), MediaWiki\Specials\SpecialResetTokens\getTokensList(), MediaWiki\Specials\SpecialSearch\goResult(), MediaWiki\Specials\SpecialUserLogout\onSuccess(), MediaWiki\SpecialPage\AuthManagerSpecialPage\performAuthenticationStep(), MediaWiki\Specials\SpecialBlock\preHtml(), MediaWiki\SpecialPage\ChangesListSpecialPage\registerFilters(), MediaWiki\Specials\SpecialWatchlist\registerFilters(), MediaWiki\SpecialPage\ChangesListSpecialPage\runMainQueryHook(), MediaWiki\Specials\SpecialEmailUser\sendEmailForm(), MediaWiki\Specials\SpecialNewPages\setup(), MediaWiki\Specials\SpecialSearch\showCreateLink(), MediaWiki\Specials\SpecialUndelete\showHistory(), MediaWiki\Specials\SpecialAutoblockList\showList(), MediaWiki\Specials\SpecialBlockList\showList(), MediaWiki\Specials\SpecialSearch\showResults(), MediaWiki\Specials\SpecialUpload\showUploadStatus(), MediaWiki\Specials\SpecialCreateAccount\successfulAction(), MediaWiki\Specials\SpecialUserLogin\successfulAction(), and MediaWiki\SpecialPage\AuthManagerSpecialPage\trySubmit().

◆ getLanguage()

MediaWiki\SpecialPage\SpecialPage::getLanguage ( )

Shortcut to get user's language.

Returns
Language
Since
1.19

Definition at line 922 of file SpecialPage.php.

References getContext().

Referenced by MediaWiki\Specials\SpecialEditTags\buildCheckBoxes(), MediaWiki\Specials\SpecialActiveUsers\buildForm(), MediaWiki\SpecialPage\FormSpecialPage\checkExecutePermissions(), MediaWiki\Specials\SpecialAllMessages\execute(), MediaWiki\Specials\SpecialAllPages\execute(), MediaWiki\Specials\SpecialFileDuplicateSearch\execute(), MediaWiki\Specials\SpecialLinkSearch\execute(), MediaWiki\Specials\SpecialListGrants\execute(), MediaWiki\Specials\SpecialListGroupRights\execute(), MediaWiki\Specials\SpecialPasswordPolicies\execute(), MediaWiki\Specials\SpecialTrackingCategories\execute(), MediaWiki\Specials\SpecialUserRights\execute(), MediaWiki\Specials\SpecialNewPages\filterLinks(), MediaWiki\SpecialPage\WantedQueryPage\formatResult(), MediaWiki\Specials\SpecialAncientPages\formatResult(), MediaWiki\Specials\SpecialBrokenRedirects\formatResult(), MediaWiki\Specials\SpecialDoubleRedirects\formatResult(), MediaWiki\Specials\SpecialFewestRevisions\formatResult(), MediaWiki\Specials\SpecialListRedirects\formatResult(), MediaWiki\Specials\SpecialMIMESearch\formatResult(), MediaWiki\Specials\SpecialMostCategories\formatResult(), MediaWiki\Specials\SpecialMostInterwikis\formatResult(), MediaWiki\Specials\SpecialMostLinked\formatResult(), MediaWiki\Specials\SpecialMostLinkedCategories\formatResult(), MediaWiki\Specials\SpecialMostLinkedTemplates\formatResult(), MediaWiki\Specials\SpecialShortPages\formatResult(), MediaWiki\Specials\SpecialUnusedTemplates\formatResult(), MediaWiki\Specials\SpecialUnwatchedPages\formatResult(), MediaWiki\Specials\SpecialWantedCategories\formatResult(), MediaWiki\Specials\SpecialUndelete\formatRevisionRow(), MediaWiki\Specials\SpecialBlock\getFormFields(), MediaWiki\Specials\SpecialBotPasswords\getFormFields(), MediaWiki\Specials\SpecialPageLanguage\getFormFields(), MediaWiki\Specials\SpecialEmailUser\onFormSubmit(), MediaWiki\Specials\SpecialNewPages\parseParams(), MediaWiki\Specials\SpecialBlock\postHtml(), MediaWiki\Specials\SpecialEditTags\showConvenienceLinks(), MediaWiki\Specials\SpecialRevisionDelete\showConvenienceLinks(), MediaWiki\Specials\SpecialUserRights\showEditUserGroupsForm(), MediaWiki\Specials\SpecialMovePage\showForm(), MediaWiki\Specials\SpecialEditTags\showForm(), MediaWiki\Specials\SpecialRevisionDelete\showForm(), and MediaWiki\Specials\SpecialRevisionDelete\tryShowFile().

◆ getLinkRenderer()

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

Definition at line 1107 of file SpecialPage.php.

Referenced by MediaWiki\Specials\SpecialAllMessages\execute(), MediaWiki\Specials\SpecialCategories\execute(), MediaWiki\Specials\SpecialDeletedContributions\execute(), MediaWiki\Specials\SpecialListFiles\execute(), MediaWiki\Specials\SpecialListGroupRights\execute(), MediaWiki\Specials\SpecialNewFiles\execute(), MediaWiki\Specials\SpecialPasswordPolicies\execute(), MediaWiki\Specials\SpecialProtectedPages\execute(), MediaWiki\Specials\SpecialProtectedTitles\execute(), MediaWiki\Specials\SpecialTrackingCategories\execute(), MediaWiki\Specials\SpecialNewPages\filterLinks(), MediaWiki\SpecialPage\WantedQueryPage\formatResult(), MediaWiki\Specials\SpecialAncientPages\formatResult(), MediaWiki\Specials\SpecialBrokenRedirects\formatResult(), MediaWiki\Specials\SpecialDoubleRedirects\formatResult(), MediaWiki\Specials\SpecialFewestRevisions\formatResult(), MediaWiki\Specials\SpecialLinkSearch\formatResult(), MediaWiki\Specials\SpecialListRedirects\formatResult(), MediaWiki\Specials\SpecialMIMESearch\formatResult(), MediaWiki\Specials\SpecialMostCategories\formatResult(), MediaWiki\Specials\SpecialMostInterwikis\formatResult(), MediaWiki\Specials\SpecialMostLinked\formatResult(), MediaWiki\Specials\SpecialMostLinkedCategories\formatResult(), MediaWiki\Specials\SpecialMostLinkedTemplates\formatResult(), MediaWiki\Specials\SpecialPagesWithProp\formatResult(), MediaWiki\Specials\SpecialShortPages\formatResult(), MediaWiki\Specials\SpecialUncategorizedCategories\formatResult(), MediaWiki\Specials\SpecialUnusedCategories\formatResult(), MediaWiki\Specials\SpecialUnusedTemplates\formatResult(), MediaWiki\Specials\SpecialUnwatchedPages\formatResult(), MediaWiki\Specials\SpecialWantedCategories\formatResult(), MediaWiki\Specials\SpecialUndelete\formatRevisionRow(), MediaWiki\Specials\SpecialAutoblockList\getBlockListPager(), MediaWiki\Specials\SpecialBlockList\getBlockListPager(), MediaWiki\Specials\SpecialBotPasswords\getFormFields(), MediaWiki\Specials\SpecialEmailUser\getFormFields(), MediaWiki\Specials\SpecialContributions\getPager(), MediaWiki\Specials\SpecialUpload\getUploadForm(), MediaWiki\SpecialPage\LoginSignupSpecialPage\load(), MediaWiki\SpecialPage\WantedQueryPage\makeWlhLink(), MediaWiki\Specials\SpecialWatchlist\outputChangesList(), MediaWiki\Specials\SpecialEditWatchlist\outputSubtitle(), MediaWiki\Specials\SpecialMediaStatistics\outputTableRow(), MediaWiki\Specials\SpecialBlock\postHtml(), MediaWiki\Specials\SpecialEditTags\showConvenienceLinks(), MediaWiki\Specials\SpecialRevisionDelete\showConvenienceLinks(), MediaWiki\Specials\SpecialMovePage\showForm(), MediaWiki\Specials\SpecialRevisionDelete\showForm(), MediaWiki\Specials\SpecialUndelete\showHistory(), MediaWiki\Specials\SpecialSearch\showResults(), MediaWiki\Specials\SpecialChangeCredentials\showSubpageList(), and MediaWiki\Specials\SpecialUpload\showUploadWarning().

◆ getLocalName()

MediaWiki\SpecialPage\SpecialPage::getLocalName ( )

Get the localised name of the special page.

Stability: stable
to override
Returns
string

Definition at line 296 of file SpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\getSpecialPageFactory().

◆ getLoginSecurityLevel()

MediaWiki\SpecialPage\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.

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

Reimplemented in MediaWiki\SpecialPage\AuthManagerSpecialPage, MediaWiki\Specials\SpecialBotPasswords, MediaWiki\Specials\SpecialChangeEmail, MediaWiki\Specials\SpecialCreateAccount, MediaWiki\Specials\SpecialUnlinkAccounts, and MediaWiki\Specials\SpecialUserLogin.

Definition at line 466 of file SpecialPage.php.

Referenced by MediaWiki\SpecialPage\FormSpecialPage\execute().

◆ getName()

MediaWiki\SpecialPage\SpecialPage::getName ( )

Get the canonical, unlocalized name of this special page without namespace.

Returns
string

Reimplemented in MediaWiki\Specials\SpecialDiff.

Definition at line 226 of file SpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\$mName.

Referenced by MediaWiki\Specials\SpecialContribute\execute(), MediaWiki\Specials\SpecialRandomPage\execute(), MediaWiki\SpecialPage\FormSpecialPage\getForm(), MediaWiki\SpecialPage\AuthManagerSpecialPage\getLoginSecurityLevel(), MediaWiki\Specials\SpecialBotPasswords\getLoginSecurityLevel(), MediaWiki\Specials\SpecialChangeEmail\getLoginSecurityLevel(), MediaWiki\SpecialPage\FormSpecialPage\getMessagePrefix(), MediaWiki\Specials\Redirects\SpecialAllMyUploads\getRedirect(), MediaWiki\Specials\Redirects\SpecialMycontributions\getRedirect(), MediaWiki\Specials\Redirects\SpecialMylog\getRedirect(), MediaWiki\Specials\Redirects\SpecialMypage\getRedirect(), MediaWiki\Specials\Redirects\SpecialMytalk\getRedirect(), MediaWiki\Specials\Redirects\SpecialMyuploads\getRedirect(), MediaWiki\SpecialPage\AuthManagerSpecialPage\getToken(), MediaWiki\SpecialPage\AuthManagerSpecialPage\handleReauthBeforeExecute(), MediaWiki\SpecialPage\AuthManagerSpecialPage\handleReturnBeforeExecute(), MediaWiki\SpecialPage\LoginSignupSpecialPage\mainLoginForm(), MediaWiki\Specials\SpecialBlock\maybeAlterFormDefaults(), MediaWiki\Specials\SpecialBotPasswords\onSubmit(), MediaWiki\Specials\SpecialLockdb\onSubmit(), MediaWiki\Specials\SpecialEditWatchlist\outputSubtitle(), MediaWiki\SpecialPage\ChangesListSpecialPage\runMainQueryHook(), MediaWiki\SpecialPage\LoginSignupSpecialPage\showSuccessPage(), and MediaWiki\Specials\SpecialCreateAccount\successfulAction().

◆ getOutput()

MediaWiki\SpecialPage\SpecialPage::getOutput ( )

Get the OutputPage being used for this instance.

Returns
OutputPage
Since
1.18

Definition at line 882 of file SpecialPage.php.

References getContext().

Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\__construct(), MediaWiki\Specials\SpecialRevisionDelete\addUsageText(), MediaWiki\Specials\SpecialChangeContentModel\alterForm(), MediaWiki\Specials\SpecialPageLanguage\alterForm(), MediaWiki\SpecialPage\AuthManagerSpecialPage\beforeExecute(), MediaWiki\Specials\SpecialUserLogin\beforeExecute(), MediaWiki\SpecialPage\ChangesListSpecialPage\considerActionsForDefaultSavedQuery(), MediaWiki\Specials\SpecialRecentChangesLinked\doMainQuery(), MediaWiki\Specials\SpecialConfirmEmail\execute(), MediaWiki\Specials\SpecialBookSources\execute(), MediaWiki\Specials\SpecialEditWatchlist\execute(), MediaWiki\SpecialPage\ContributionsSpecialPage\execute(), MediaWiki\Specials\SpecialActiveUsers\execute(), MediaWiki\Specials\SpecialAllMessages\execute(), MediaWiki\Specials\SpecialAllPages\execute(), MediaWiki\Specials\SpecialApiHelp\execute(), MediaWiki\Specials\SpecialApiSandbox\execute(), MediaWiki\Specials\SpecialAutoblockList\execute(), MediaWiki\Specials\SpecialBlankpage\execute(), MediaWiki\Specials\SpecialBlock\execute(), MediaWiki\Specials\SpecialBlockList\execute(), MediaWiki\Specials\SpecialBotPasswords\execute(), MediaWiki\Specials\SpecialCategories\execute(), MediaWiki\Specials\SpecialChangeEmail\execute(), MediaWiki\Specials\SpecialComparePages\execute(), MediaWiki\Specials\SpecialContribute\execute(), MediaWiki\Specials\SpecialDeletedContributions\execute(), MediaWiki\Specials\SpecialEditTags\execute(), MediaWiki\Specials\SpecialEmailUser\execute(), MediaWiki\Specials\SpecialExport\execute(), MediaWiki\Specials\SpecialFileDuplicateSearch\execute(), MediaWiki\Specials\SpecialGoToInterwiki\execute(), MediaWiki\Specials\SpecialImport\execute(), MediaWiki\Specials\SpecialJavaScriptTest\execute(), MediaWiki\Specials\SpecialLinkSearch\execute(), MediaWiki\Specials\SpecialListFiles\execute(), MediaWiki\Specials\SpecialListGrants\execute(), MediaWiki\Specials\SpecialListGroupRights\execute(), MediaWiki\Specials\SpecialListUsers\execute(), MediaWiki\Specials\SpecialLog\execute(), MediaWiki\Specials\SpecialMovePage\execute(), MediaWiki\Specials\SpecialMute\execute(), MediaWiki\Specials\SpecialNewFiles\execute(), MediaWiki\Specials\SpecialNewPages\execute(), MediaWiki\Specials\SpecialPagesWithProp\execute(), MediaWiki\Specials\SpecialPasswordPolicies\execute(), MediaWiki\Specials\SpecialPasswordReset\execute(), MediaWiki\Specials\SpecialPreferences\execute(), MediaWiki\Specials\SpecialPrefixIndex\execute(), MediaWiki\Specials\SpecialProtectedPages\execute(), MediaWiki\Specials\SpecialProtectedTitles\execute(), MediaWiki\Specials\SpecialRandomPage\execute(), MediaWiki\Specials\SpecialRenameUser\execute(), MediaWiki\Specials\SpecialResetTokens\execute(), MediaWiki\Specials\SpecialRevisionDelete\execute(), MediaWiki\Specials\SpecialRunJobs\execute(), MediaWiki\Specials\SpecialSearch\execute(), MediaWiki\Specials\SpecialSpecialPages\execute(), MediaWiki\Specials\SpecialStatistics\execute(), MediaWiki\Specials\SpecialTrackingCategories\execute(), MediaWiki\Specials\SpecialUnblock\execute(), MediaWiki\Specials\SpecialUndelete\execute(), MediaWiki\Specials\SpecialUnwatchedPages\execute(), MediaWiki\Specials\SpecialUserRights\execute(), MediaWiki\SpecialPage\ChangesListSpecialPage\execute(), MediaWiki\SpecialPage\DisabledSpecialPage\execute(), MediaWiki\SpecialPage\LoginSignupSpecialPage\execute(), MediaWiki\SpecialPage\RedirectSpecialPage\execute(), MediaWiki\Specials\SpecialChangeCredentials\execute(), MediaWiki\Specials\SpecialEditRecovery\execute(), MediaWiki\Specials\SpecialExpandTemplates\execute(), MediaWiki\Specials\SpecialLinkAccounts\execute(), MediaWiki\Specials\SpecialPageData\execute(), MediaWiki\Specials\SpecialRecentChanges\execute(), MediaWiki\Specials\SpecialUnlinkAccounts\execute(), MediaWiki\Specials\SpecialWatchlist\execute(), MediaWiki\Specials\SpecialEditTags\failure(), MediaWiki\Specials\SpecialRevisionDelete\failure(), MediaWiki\Specials\SpecialNewPages\feed(), MediaWiki\Specials\SpecialNewPages\form(), MediaWiki\Specials\SpecialChangeCredentials\getAuthFormDescriptor(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getBenefitsContainerHtml(), MediaWiki\Specials\SpecialBlock\getFormFields(), MediaWiki\SpecialPage\AuthManagerSpecialPage\handleReauthBeforeExecute(), MediaWiki\SpecialPage\AuthManagerSpecialPage\handleReturnBeforeExecute(), MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp(), MediaWiki\SpecialPage\LoginSignupSpecialPage\mainLoginForm(), MediaWiki\Specials\SpecialBlock\maybeAlterFormDefaults(), MediaWiki\SpecialPage\SpecialRedirectWithAction\onFormSubmit(), MediaWiki\Specials\SpecialDiff\onFormSubmit(), MediaWiki\Specials\SpecialNewSection\onFormSubmit(), MediaWiki\Specials\SpecialPermanentLink\onFormSubmit(), MediaWiki\Specials\SpecialBotPasswords\onSubmit(), MediaWiki\Specials\SpecialChangeContentModel\onSubmit(), MediaWiki\Specials\SpecialPageLanguage\onSubmit(), MediaWiki\Specials\SpecialRandomInCategory\onSubmit(), MediaWiki\Specials\Redirects\SpecialTalkPage\onSubmit(), MediaWiki\Specials\SpecialBotPasswords\onSuccess(), MediaWiki\Specials\SpecialChangeContentModel\onSuccess(), MediaWiki\Specials\SpecialChangeEmail\onSuccess(), MediaWiki\Specials\SpecialLockdb\onSuccess(), MediaWiki\Specials\SpecialMute\onSuccess(), MediaWiki\Specials\SpecialPageLanguage\onSuccess(), MediaWiki\Specials\SpecialPasswordReset\onSuccess(), MediaWiki\Specials\SpecialResetTokens\onSuccess(), MediaWiki\Specials\SpecialUnlockdb\onSuccess(), MediaWiki\Specials\SpecialUserLogout\onSuccess(), MediaWiki\Specials\SpecialWhatLinksHere\onSuccess(), MediaWiki\Specials\SpecialWatchlist\outputChangesList(), MediaWiki\Specials\SpecialMediaStatistics\outputMediaType(), MediaWiki\SpecialPage\ChangesListSpecialPage\outputNoResults(), MediaWiki\Specials\SpecialRecentChangesLinked\outputNoResults(), MediaWiki\Specials\SpecialMediaStatistics\outputResults(), MediaWiki\Specials\SpecialEditWatchlist\outputSubtitle(), MediaWiki\Specials\SpecialMediaStatistics\outputTableEnd(), MediaWiki\Specials\SpecialMediaStatistics\outputTableRow(), MediaWiki\Specials\SpecialMediaStatistics\outputTableStart(), MediaWiki\SpecialPage\ChangesListSpecialPage\outputTimeout(), MediaWiki\Specials\SpecialUpload\performUploadChecks(), MediaWiki\Specials\SpecialBlock\postHtml(), MediaWiki\Specials\SpecialBlock\preHtml(), MediaWiki\Specials\SpecialPageLanguage\preHtml(), MediaWiki\Specials\SpecialEmailUser\sendEmailForm(), MediaWiki\Specials\SpecialUserLogin\setHeaders(), MediaWiki\Specials\SpecialNewFiles\setTopText(), MediaWiki\Specials\SpecialRecentChangesLinked\setTopText(), MediaWiki\Specials\SpecialSearch\setupPage(), MediaWiki\Specials\SpecialTags\showActivateDeactivateForm(), MediaWiki\Specials\SpecialEditTags\showConvenienceLinks(), MediaWiki\Specials\SpecialRevisionDelete\showConvenienceLinks(), MediaWiki\Specials\SpecialSearch\showCreateLink(), MediaWiki\Specials\SpecialTags\showDeleteTagForm(), MediaWiki\Specials\SpecialUserRights\showEditUserGroupsForm(), MediaWiki\Specials\SpecialMovePage\showForm(), MediaWiki\Specials\SpecialEditTags\showForm(), MediaWiki\Specials\SpecialPageData\showForm(), MediaWiki\Specials\SpecialRevisionDelete\showForm(), MediaWiki\Specials\SpecialUndelete\showHistory(), MediaWiki\Specials\SpecialAutoblockList\showList(), MediaWiki\Specials\SpecialBlockList\showList(), MediaWiki\Specials\SpecialUndelete\showMoreHistory(), MediaWiki\Specials\SpecialPreferences\showResetForm(), MediaWiki\Specials\SpecialSearch\showResults(), MediaWiki\Specials\SpecialChangeCredentials\showSubpageList(), MediaWiki\SpecialPage\LoginSignupSpecialPage\showSuccessPage(), MediaWiki\Specials\SpecialUploadStash\showUpload(), MediaWiki\Specials\SpecialUpload\showUploadForm(), MediaWiki\Specials\SpecialUpload\showUploadStatus(), MediaWiki\Specials\SpecialUpload\showUploadWarning(), MediaWiki\Specials\SpecialEditTags\submit(), MediaWiki\Specials\SpecialRevisionDelete\submit(), MediaWiki\Specials\SpecialPreferences\submitReset(), MediaWiki\Specials\SpecialChangeCredentials\success(), MediaWiki\Specials\SpecialEditTags\success(), MediaWiki\Specials\SpecialRevisionDelete\success(), MediaWiki\Specials\SpecialCreateAccount\successfulAction(), MediaWiki\Specials\SpecialUserRights\switchForm(), MediaWiki\Specials\SpecialRevisionDelete\tryShowFile(), and MediaWiki\SpecialPage\ChangesListSpecialPage\validateOptions().

◆ getPageTitle()

MediaWiki\SpecialPage\SpecialPage::getPageTitle ( $subpage = false)

Get a self-referential title object.

Parameters
string | false | null$subpage
Returns
Title
Since
1.23

Definition at line 836 of file SpecialPage.php.

Referenced by MediaWiki\Specials\SpecialActiveUsers\buildForm(), MediaWiki\SpecialPage\ChangesListSpecialPage\considerActionsForDefaultSavedQuery(), MediaWiki\Specials\SpecialApiHelp\execute(), MediaWiki\Specials\SpecialAutoblockList\execute(), MediaWiki\Specials\SpecialBlockList\execute(), MediaWiki\Specials\SpecialFileDuplicateSearch\execute(), MediaWiki\Specials\SpecialLinkSearch\execute(), MediaWiki\Specials\SpecialPagesWithProp\execute(), MediaWiki\Specials\SpecialSearch\execute(), MediaWiki\SpecialPage\LoginSignupSpecialPage\execute(), MediaWiki\Specials\SpecialChangeCredentials\execute(), MediaWiki\Specials\SpecialExpandTemplates\execute(), MediaWiki\Specials\SpecialLinkAccounts\execute(), MediaWiki\Specials\SpecialUnlinkAccounts\execute(), MediaWiki\Specials\SpecialWatchlist\execute(), MediaWiki\Specials\SpecialNewPages\feed(), MediaWiki\Specials\SpecialNewPages\filterLinks(), MediaWiki\Specials\SpecialUndelete\formatRevisionRow(), MediaWiki\SpecialPage\FormSpecialPage\getForm(), MediaWiki\Specials\SpecialBotPasswords\getFormFields(), MediaWiki\Specials\SpecialMIMESearch\getPageHeader(), MediaWiki\Specials\SpecialUpload\getUploadForm(), MediaWiki\SpecialPage\AuthManagerSpecialPage\handleReturnBeforeExecute(), MediaWiki\SpecialPage\LoginSignupSpecialPage\load(), MediaWiki\Specials\SpecialDiff\onFormSubmit(), MediaWiki\Specials\SpecialPermanentLink\onFormSubmit(), MediaWiki\Specials\SpecialBotPasswords\onSubmit(), MediaWiki\Specials\SpecialBotPasswords\onSuccess(), MediaWiki\Specials\SpecialAllPages\outputHTMLForm(), MediaWiki\SpecialPage\AuthManagerSpecialPage\performAuthenticationStep(), MediaWiki\Specials\SpecialTags\processCreateTagForm(), MediaWiki\Specials\SpecialTags\processTagForm(), MediaWiki\Specials\SpecialEmailUser\sendEmailForm(), MediaWiki\Specials\SpecialSearch\setupPage(), MediaWiki\Specials\SpecialTags\showActivateDeactivateForm(), MediaWiki\Specials\SpecialTags\showDeleteTagForm(), MediaWiki\Specials\SpecialUserRights\showEditUserGroupsForm(), MediaWiki\Specials\SpecialMovePage\showForm(), MediaWiki\Specials\SpecialEditTags\showForm(), MediaWiki\Specials\SpecialRevisionDelete\showForm(), MediaWiki\Specials\SpecialUndelete\showHistory(), MediaWiki\Specials\SpecialPreferences\showResetForm(), MediaWiki\Specials\SpecialPreferences\submitReset(), MediaWiki\Specials\SpecialCreateAccount\successfulAction(), MediaWiki\Specials\SpecialUserRights\switchForm(), MediaWiki\Specials\SpecialRevisionDelete\tryShowFile(), MediaWiki\Specials\SpecialEmailUser\userForm(), and MediaWiki\SpecialPage\ChangesListSpecialPage\validateOptions().

◆ getRequest()

MediaWiki\SpecialPage\SpecialPage::getRequest ( )

Get the WebRequest being used for this instance.

Returns
WebRequest
Since
1.18

Reimplemented in MediaWiki\SpecialPage\AuthManagerSpecialPage.

Definition at line 872 of file SpecialPage.php.

References getContext().

Referenced by MediaWiki\Specials\SpecialBlock\alterForm(), MediaWiki\Specials\SpecialChangeEmail\alterForm(), MediaWiki\Specials\SpecialPasswordReset\alterForm(), MediaWiki\Specials\SpecialUserLogout\alterForm(), MediaWiki\Specials\SpecialActiveUsers\buildForm(), MediaWiki\SpecialPage\FormSpecialPage\checkExecutePermissions(), MediaWiki\SpecialPage\ChangesListSpecialPage\considerActionsForDefaultSavedQuery(), MediaWiki\Specials\SpecialRedirect\dispatchFile(), MediaWiki\Specials\SpecialBookSources\execute(), MediaWiki\Specials\SpecialEditWatchlist\execute(), MediaWiki\SpecialPage\ContributionsSpecialPage\execute(), MediaWiki\Specials\SpecialActiveUsers\execute(), MediaWiki\Specials\SpecialAllMessages\execute(), MediaWiki\Specials\SpecialAllPages\execute(), MediaWiki\Specials\SpecialApiHelp\execute(), MediaWiki\Specials\SpecialBlockList\execute(), MediaWiki\Specials\SpecialCategories\execute(), MediaWiki\Specials\SpecialDeletedContributions\execute(), MediaWiki\Specials\SpecialEditTags\execute(), MediaWiki\Specials\SpecialEmailUser\execute(), MediaWiki\Specials\SpecialExport\execute(), MediaWiki\Specials\SpecialFileDuplicateSearch\execute(), MediaWiki\Specials\SpecialImport\execute(), MediaWiki\Specials\SpecialLinkSearch\execute(), MediaWiki\Specials\SpecialListFiles\execute(), MediaWiki\Specials\SpecialLog\execute(), MediaWiki\Specials\SpecialMIMESearch\execute(), MediaWiki\Specials\SpecialMovePage\execute(), MediaWiki\Specials\SpecialNewFiles\execute(), MediaWiki\Specials\SpecialPagesWithProp\execute(), MediaWiki\Specials\SpecialPreferences\execute(), MediaWiki\Specials\SpecialPrefixIndex\execute(), MediaWiki\Specials\SpecialProtectedPages\execute(), MediaWiki\Specials\SpecialProtectedTitles\execute(), MediaWiki\Specials\SpecialRandomPage\execute(), MediaWiki\Specials\SpecialRenameUser\execute(), MediaWiki\Specials\SpecialRevisionDelete\execute(), MediaWiki\Specials\SpecialRunJobs\execute(), MediaWiki\Specials\SpecialSearch\execute(), MediaWiki\Specials\SpecialTags\execute(), MediaWiki\Specials\SpecialUnblock\execute(), MediaWiki\Specials\SpecialUserRights\execute(), MediaWiki\Specials\SpecialWithoutInterwiki\execute(), MediaWiki\SpecialPage\ChangesListSpecialPage\execute(), MediaWiki\Specials\SpecialExpandTemplates\execute(), MediaWiki\Specials\SpecialPageData\execute(), MediaWiki\Specials\SpecialRecentChanges\execute(), MediaWiki\Specials\SpecialWatchlist\execute(), MediaWiki\Specials\SpecialRevisionDelete\extractBitParams(), MediaWiki\SpecialPage\ChangesListSpecialPage\fetchOptionsFromRequest(), MediaWiki\Specials\SpecialWatchlist\fetchOptionsFromRequest(), MediaWiki\SpecialPage\ChangesListSpecialPage\getDefaultOptions(), MediaWiki\SpecialPage\FormSpecialPage\getForm(), MediaWiki\Specials\SpecialPasswordReset\getFormFields(), MediaWiki\Specials\SpecialFilepath\getRedirect(), MediaWiki\SpecialPage\RedirectSpecialPage\getRedirectQuery(), MediaWiki\Specials\SpecialSearch\load(), MediaWiki\Specials\SpecialUpload\loadRequest(), MediaWiki\Specials\SpecialBlock\maybeAlterFormDefaults(), MediaWiki\Specials\SpecialEmailUser\onFormSubmit(), MediaWiki\Specials\SpecialBotPasswords\onSubmit(), MediaWiki\Specials\SpecialRandomInCategory\onSubmit(), MediaWiki\Specials\SpecialChangeEmail\onSuccess(), MediaWiki\Specials\SpecialPasswordReset\onSuccess(), MediaWiki\Specials\SpecialWhatLinksHere\onSuccess(), MediaWiki\Specials\SpecialSearch\saveNamespaces(), MediaWiki\Specials\SpecialUserRights\saveUserGroups(), MediaWiki\Specials\SpecialBlock\setParameter(), MediaWiki\Specials\SpecialChangeContentModel\setParameter(), MediaWiki\Specials\SpecialNewPages\setup(), MediaWiki\Specials\SpecialMovePage\showForm(), MediaWiki\Specials\SpecialRevisionDelete\showForm(), MediaWiki\Specials\SpecialUndelete\showHistory(), MediaWiki\Specials\SpecialEditTags\submit(), MediaWiki\Specials\SpecialRevisionDelete\submit(), MediaWiki\Specials\SpecialPreferences\submitReset(), and MediaWiki\Specials\SpecialRevisionDelete\tryShowFile().

◆ getRestriction()

MediaWiki\SpecialPage\SpecialPage::getRestriction ( )

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

Returns
string

Definition at line 234 of file SpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\$mRestriction.

◆ getRobotPolicy()

MediaWiki\SpecialPage\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 978 of file SpecialPage.php.

◆ getSafeTitleFor()

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

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

Parameters
string$name
string | false$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 183 of file SpecialPage.php.

References MediaWiki\MediaWikiServices\getInstance(), and NS_SPECIAL.

Referenced by MediaWiki\Specials\SpecialFilepath\getRedirect(), MediaWiki\Specials\Redirects\SpecialMylog\getRedirect(), MediaWiki\Skin\SkinComponentUtils\makeSpecialUrl(), and MediaWiki\Skin\SkinComponentUtils\makeSpecialUrlSubpage().

◆ getShortDescription()

MediaWiki\SpecialPage\SpecialPage::getShortDescription ( string $path = '')

Similar to getDescription but takes into account sub pages and designed for display in tabs.

Since
1.39
Stability: stable
to override if special page has complex parameter handling. Use default message keys where possible.
Parameters
string$path(optional)
Returns
string

Reimplemented in MediaWiki\Specials\SpecialContribute, MediaWiki\Specials\SpecialContributions, MediaWiki\Specials\SpecialEditWatchlist, and MediaWiki\Specials\SpecialWatchlist.

Definition at line 821 of file SpecialPage.php.

◆ getSkin()

◆ getSpecialPageFactory()

MediaWiki\SpecialPage\SpecialPage::getSpecialPageFactory ( )
finalprotected

◆ getSubpagesForPrefixSearch()

MediaWiki\SpecialPage\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.

Stability: stable
to override
Returns
string[] subpages to search from

Reimplemented in MediaWiki\Specials\Redirects\SpecialMylog, MediaWiki\Specials\SpecialEditWatchlist, MediaWiki\Specials\SpecialListUsers, MediaWiki\Specials\SpecialLog, MediaWiki\Specials\SpecialRedirect, MediaWiki\Specials\SpecialTags, and MediaWiki\Specials\SpecialWatchlist.

Definition at line 626 of file SpecialPage.php.

◆ getTitleFor()

static MediaWiki\SpecialPage\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 | false | null$subpageSubpage string, or false/null to not use a subpage
string$fragmentThe link fragment (after the "#")
Returns
Title

Definition at line 154 of file SpecialPage.php.

Referenced by MediaWiki\Preferences\SignatureValidator\applyPreSaveTransform(), MediaWiki\Specials\SpecialUserLogin\beforeExecute(), MediaWiki\Specials\SpecialEditWatchlist\execute(), MediaWiki\Specials\SpecialListGroupRights\execute(), MediaWiki\Specials\SpecialPasswordPolicies\execute(), MediaWiki\Specials\SpecialResetTokens\execute(), MediaWiki\Specials\SpecialWatchlist\execute(), MediaWiki\Specials\SpecialEditWatchlist\executeViewEditWatchlist(), MediaWiki\Specials\SpecialListDuplicatedFiles\formatResult(), MediaWiki\Specials\SpecialUnusedTemplates\formatResult(), MediaWiki\Pager\UploadStashPager\formatValue(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getFieldDefinitions(), MediaWiki\Search\TitleMatcher\getNearMatchInternal(), MediaWiki\SpecialPage\ChangesListSpecialPage\getRcFiltersConfigSummary(), MediaWiki\SpecialPage\ChangesListSpecialPage\getRcFiltersConfigVars(), MediaWiki\SpecialPage\SpecialRedirectToSpecial\getRedirect(), MediaWiki\Specials\Redirects\SpecialAllMyUploads\getRedirect(), MediaWiki\Specials\Redirects\SpecialMycontributions\getRedirect(), MediaWiki\Specials\Redirects\SpecialMyuploads\getRedirect(), MediaWiki\Pager\AllMessagesTablePager\getTitle(), MediaWiki\Linker\Linker\getUploadUrl(), MediaWiki\SpecialPage\ContributionsSpecialPage\getUserLinks(), MediaWiki\User\ExternalUserNames\getUserLinkTitle(), MediaWiki\SpecialPage\AuthManagerSpecialPage\handleReauthBeforeExecute(), MediaWiki\SpecialPage\WantedQueryPage\makeWlhLink(), MediaWiki\SpecialPage\SpecialPage\newSearchPage(), MediaWiki\Specials\SpecialMediaStatistics\outputTableRow(), MediaWiki\Specials\SpecialBlock\postHtml(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendPasswordResetEmail(), MediaWiki\Specials\SpecialEditTags\showConvenienceLinks(), MediaWiki\Specials\SpecialRevisionDelete\showConvenienceLinks(), MediaWiki\Specials\SpecialUpload\showUploadWarning(), MediaWiki\Linker\Linker\specialLink(), and MediaWiki\Preferences\DefaultPreferencesFactory\watchlistPreferences().

◆ getTitleValueFor()

static MediaWiki\SpecialPage\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 | false | null$subpageSubpage string, or false/null to not use a subpage
string$fragmentThe link fragment (after the "#")
Returns
TitleValue

Definition at line 169 of file SpecialPage.php.

References MediaWiki\MediaWikiServices\getInstance(), and NS_SPECIAL.

Referenced by MediaWiki\Linker\Linker\userLink().

◆ getUser()

MediaWiki\SpecialPage\SpecialPage::getUser ( )

Shortcut to get the User executing this instance.

Returns
User
Since
1.18

Definition at line 892 of file SpecialPage.php.

References getContext().

Referenced by MediaWiki\Specials\SpecialUserRights\addLogEntry(), MediaWiki\Specials\SpecialUserLogout\alterForm(), MediaWiki\Specials\SpecialNewFiles\buildForm(), MediaWiki\Specials\SpecialBotPasswords\checkExecutePermissions(), MediaWiki\Specials\SpecialUndelete\checkPermissions(), MediaWiki\SpecialPage\ChangesListSpecialPage\considerActionsForDefaultSavedQuery(), MediaWiki\Specials\SpecialWatchlist\doMainQuery(), MediaWiki\Specials\SpecialUserRights\doSaveUserGroups(), MediaWiki\Specials\SpecialConfirmEmail\execute(), MediaWiki\Specials\SpecialEditWatchlist\execute(), MediaWiki\SpecialPage\ContributionsSpecialPage\execute(), MediaWiki\SpecialPage\FormSpecialPage\execute(), MediaWiki\Specials\SpecialContribute\execute(), MediaWiki\Specials\SpecialEditTags\execute(), MediaWiki\Specials\SpecialEmailUser\execute(), MediaWiki\Specials\SpecialImport\execute(), MediaWiki\Specials\SpecialMovePage\execute(), MediaWiki\Specials\SpecialPreferences\execute(), MediaWiki\Specials\SpecialRenameUser\execute(), MediaWiki\Specials\SpecialRevisionDelete\execute(), MediaWiki\Specials\SpecialUndelete\execute(), MediaWiki\Specials\SpecialUpload\execute(), MediaWiki\Specials\SpecialUserLogout\execute(), MediaWiki\Specials\SpecialUserRights\execute(), MediaWiki\SpecialPage\ChangesListSpecialPage\execute(), MediaWiki\SpecialPage\LoginSignupSpecialPage\execute(), MediaWiki\Specials\SpecialEditRecovery\execute(), MediaWiki\Specials\SpecialUnlinkAccounts\execute(), MediaWiki\Specials\SpecialUploadStash\execute(), MediaWiki\Specials\SpecialWatchlist\execute(), MediaWiki\Specials\SpecialNewPages\filterLinks(), MediaWiki\Specials\SpecialUndelete\formatRevisionRow(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getBenefitsContainerHtml(), MediaWiki\Specials\SpecialBlock\getFormFields(), MediaWiki\Specials\SpecialBotPasswords\getFormFields(), MediaWiki\Specials\SpecialChangeEmail\getFormFields(), MediaWiki\Specials\SpecialPasswordReset\getFormFields(), MediaWiki\Specials\SpecialResetTokens\getFormFields(), MediaWiki\Specials\SpecialEmailUser\getFormFields(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getPageHtml(), MediaWiki\Specials\Redirects\SpecialAllMyUploads\getRedirect(), MediaWiki\Specials\Redirects\SpecialMycontributions\getRedirect(), MediaWiki\Specials\Redirects\SpecialMylog\getRedirect(), MediaWiki\Specials\Redirects\SpecialMypage\getRedirect(), MediaWiki\Specials\Redirects\SpecialMytalk\getRedirect(), MediaWiki\Specials\Redirects\SpecialMyuploads\getRedirect(), MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp(), MediaWiki\Specials\SpecialUndelete\isAllowed(), MediaWiki\Specials\SpecialSearch\load(), MediaWiki\SpecialPage\AuthManagerSpecialPage\loadAuth(), MediaWiki\Specials\SpecialUpload\loadRequest(), MediaWiki\SpecialPage\LoginSignupSpecialPage\mainLoginForm(), MediaWiki\Specials\SpecialBlock\maybeAlterFormDefaults(), MediaWiki\Specials\SpecialBotPasswords\onSubmit(), MediaWiki\Specials\SpecialChangeEmail\onSubmit(), MediaWiki\Specials\SpecialLockdb\onSubmit(), MediaWiki\Specials\SpecialUserLogout\onSubmit(), MediaWiki\Specials\SpecialResetTokens\onSubmit(), MediaWiki\Specials\SpecialBotPasswords\onSuccess(), MediaWiki\Specials\SpecialUserLogout\onSuccess(), MediaWiki\Specials\SpecialWatchlist\outputChangesList(), MediaWiki\Specials\SpecialWatchlist\outputFeedLinks(), MediaWiki\Specials\SpecialEditWatchlist\outputSubtitle(), MediaWiki\SpecialPage\AuthManagerSpecialPage\performAuthenticationStep(), MediaWiki\SpecialPage\ChangesListSpecialPage\registerFilters(), MediaWiki\Specials\SpecialWatchlist\registerFilters(), MediaWiki\Specials\SpecialSearch\saveNamespaces(), MediaWiki\Specials\SpecialUserRights\saveUserGroups(), MediaWiki\Specials\SpecialUserLogin\setHeaders(), MediaWiki\Specials\SpecialUserRights\showEditUserGroupsForm(), MediaWiki\Specials\SpecialMovePage\showForm(), MediaWiki\Specials\SpecialEditTags\showForm(), MediaWiki\Specials\SpecialRevisionDelete\showForm(), MediaWiki\Specials\SpecialUndelete\showHistory(), MediaWiki\Specials\SpecialUpload\showRecoverableUploadError(), MediaWiki\SpecialPage\LoginSignupSpecialPage\showSuccessPage(), MediaWiki\Specials\SpecialUpload\showUploadWarning(), MediaWiki\Specials\SpecialEditTags\submit(), MediaWiki\Specials\SpecialRevisionDelete\submit(), MediaWiki\Specials\SpecialPreferences\submitReset(), MediaWiki\Specials\SpecialConfirmEmail\submitSend(), MediaWiki\Specials\SpecialChangeCredentials\success(), MediaWiki\Specials\SpecialCreateAccount\successfulAction(), MediaWiki\Specials\SpecialUserLogin\successfulAction(), MediaWiki\Specials\SpecialRevisionDelete\tryShowFile(), MediaWiki\Specials\SpecialUserRights\userCanChangeRights(), and MediaWiki\Specials\SpecialEmailUser\userForm().

◆ including()

◆ isCached()

MediaWiki\SpecialPage\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.

Stability: stable
to override
Returns
bool
Since
1.21

Reimplemented in MediaWiki\SpecialPage\QueryPage.

Definition at line 327 of file SpecialPage.php.

◆ isExpensive()

◆ isIncludable()

MediaWiki\SpecialPage\SpecialPage::isIncludable ( )

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

Stability: stable
to override
Returns
bool

Reimplemented in MediaWiki\SpecialPage\IncludableSpecialPage, MediaWiki\Specials\SpecialApiHelp, MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialWantedPages.

Definition at line 255 of file SpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\$mIncludable.

◆ isListed()

◆ isRestricted()

MediaWiki\SpecialPage\SpecialPage::isRestricted ( )

Can be overridden by subclasses with more complicated permissions schemes.

Stability: stable
to override
Returns
bool Should the page be displayed with the restricted-access pages?

Definition at line 339 of file SpecialPage.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ maxIncludeCacheTime()

MediaWiki\SpecialPage\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 overridden to return 0.
Since
1.26
Stability: 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 270 of file SpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\getCacheTTL(), MediaWiki\SpecialPage\SpecialPage\getConfig(), and MediaWiki\MainConfigNames\MiserMode.

◆ msg()

MediaWiki\SpecialPage\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 991 of file SpecialPage.php.

References $params, and getContext().

Referenced by MediaWiki\Specials\SpecialBlock\alterForm(), MediaWiki\Specials\SpecialChangeEmail\alterForm(), MediaWiki\Specials\SpecialLockdb\alterForm(), MediaWiki\Specials\SpecialPasswordReset\alterForm(), MediaWiki\Specials\SpecialUnlockdb\alterForm(), MediaWiki\Specials\SpecialUserLogout\alterForm(), MediaWiki\Specials\SpecialEditTags\buildCheckBoxes(), MediaWiki\Specials\SpecialRevisionDelete\buildCheckBoxes(), MediaWiki\Specials\SpecialNewFiles\buildForm(), MediaWiki\Specials\SpecialComparePages\checkExistingRevision(), MediaWiki\Specials\SpecialRecentChangesLinked\doMainQuery(), MediaWiki\Specials\SpecialEditWatchlist\execute(), MediaWiki\SpecialPage\ContributionsSpecialPage\execute(), MediaWiki\Specials\SpecialAllMessages\execute(), MediaWiki\Specials\SpecialAllPages\execute(), MediaWiki\Specials\SpecialApiHelp\execute(), MediaWiki\Specials\SpecialAutoblockList\execute(), MediaWiki\Specials\SpecialBlockList\execute(), MediaWiki\Specials\SpecialCategories\execute(), MediaWiki\Specials\SpecialContribute\execute(), MediaWiki\Specials\SpecialDeletedContributions\execute(), MediaWiki\Specials\SpecialExport\execute(), MediaWiki\Specials\SpecialFileDuplicateSearch\execute(), MediaWiki\Specials\SpecialListFiles\execute(), MediaWiki\Specials\SpecialListGrants\execute(), MediaWiki\Specials\SpecialListGroupRights\execute(), MediaWiki\Specials\SpecialListUsers\execute(), MediaWiki\Specials\SpecialMovePage\execute(), MediaWiki\Specials\SpecialPagesWithProp\execute(), MediaWiki\Specials\SpecialPasswordPolicies\execute(), MediaWiki\Specials\SpecialPreferences\execute(), MediaWiki\Specials\SpecialPrefixIndex\execute(), MediaWiki\Specials\SpecialStatistics\execute(), MediaWiki\Specials\SpecialTrackingCategories\execute(), MediaWiki\Specials\SpecialUnblock\execute(), MediaWiki\Specials\SpecialUndelete\execute(), MediaWiki\Specials\SpecialUserRights\execute(), MediaWiki\SpecialPage\DisabledSpecialPage\execute(), MediaWiki\Specials\SpecialChangeCredentials\execute(), MediaWiki\Specials\SpecialEditRecovery\execute(), MediaWiki\Specials\SpecialLinkAccounts\execute(), MediaWiki\Specials\SpecialUnlinkAccounts\execute(), MediaWiki\Specials\SpecialEditTags\failure(), MediaWiki\Specials\SpecialRevisionDelete\failure(), MediaWiki\Specials\SpecialNewPages\feed(), MediaWiki\Specials\SpecialNewPages\feedItemDesc(), MediaWiki\Specials\SpecialNewPages\filterLinks(), MediaWiki\SpecialPage\WantedQueryPage\formatResult(), MediaWiki\Specials\SpecialBrokenRedirects\formatResult(), MediaWiki\Specials\SpecialDoubleRedirects\formatResult(), MediaWiki\Specials\SpecialFewestRevisions\formatResult(), MediaWiki\Specials\SpecialLinkSearch\formatResult(), MediaWiki\Specials\SpecialListDuplicatedFiles\formatResult(), MediaWiki\Specials\SpecialMIMESearch\formatResult(), MediaWiki\Specials\SpecialMostCategories\formatResult(), MediaWiki\Specials\SpecialMostInterwikis\formatResult(), MediaWiki\Specials\SpecialMostLinked\formatResult(), MediaWiki\Specials\SpecialMostLinkedCategories\formatResult(), MediaWiki\Specials\SpecialPagesWithProp\formatResult(), MediaWiki\Specials\SpecialShortPages\formatResult(), MediaWiki\Specials\SpecialUnwatchedPages\formatResult(), MediaWiki\Specials\SpecialWantedCategories\formatResult(), MediaWiki\Specials\SpecialUndelete\formatRevisionRow(), MediaWiki\Specials\SpecialChangeCredentials\getAuthForm(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getBenefitsContainerHtml(), MediaWiki\Specials\SpecialMostImages\getCellHtml(), MediaWiki\Specials\Redirects\SpecialTalkPage\getDescription(), MediaWiki\Specials\SpecialCreateAccount\getDescription(), MediaWiki\Specials\SpecialDiff\getDescription(), MediaWiki\Specials\SpecialEditTags\getDescription(), MediaWiki\Specials\SpecialEmailUser\getDescription(), MediaWiki\Specials\SpecialMute\getDescription(), MediaWiki\Specials\SpecialUserLogin\getDescription(), MediaWiki\Specials\SpecialRecentChangesLinked\getExtraOptions(), MediaWiki\SpecialPage\FormSpecialPage\getForm(), MediaWiki\Specials\SpecialBlock\getFormFields(), MediaWiki\Specials\SpecialBotPasswords\getFormFields(), MediaWiki\Specials\SpecialChangeContentModel\getFormFields(), MediaWiki\Specials\SpecialChangeEmail\getFormFields(), MediaWiki\Specials\SpecialPageLanguage\getFormFields(), MediaWiki\Specials\SpecialResetTokens\getFormFields(), MediaWiki\Specials\SpecialEmailUser\getFormFields(), MediaWiki\Specials\SpecialActiveUsers\getIntroText(), MediaWiki\Specials\SpecialBrokenRedirects\getPageHeader(), MediaWiki\Specials\SpecialDeadendPages\getPageHeader(), MediaWiki\Specials\SpecialDoubleRedirects\getPageHeader(), MediaWiki\Specials\SpecialLonelyPages\getPageHeader(), MediaWiki\Specials\SpecialUnusedCategories\getPageHeader(), MediaWiki\Specials\SpecialUnusedImages\getPageHeader(), MediaWiki\Specials\SpecialUnusedTemplates\getPageHeader(), MediaWiki\Specials\SpecialWantedFiles\getPageHeader(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getPageHtml(), MediaWiki\Specials\SpecialWatchlist\getShortDescriptionHelper(), MediaWiki\Specials\SpecialMediaStatistics\getTableHeaderRow(), MediaWiki\Specials\SpecialProtectedPages\getTypeMenu(), MediaWiki\Specials\SpecialUpload\getUploadForm(), MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp(), MediaWiki\SpecialPage\LoginSignupSpecialPage\load(), MediaWiki\Specials\SpecialUpload\loadRequest(), MediaWiki\Specials\SpecialUserRights\makeGroupNameList(), MediaWiki\SpecialPage\WantedQueryPage\makeWlhLink(), MediaWiki\Specials\SpecialLockdb\onSubmit(), MediaWiki\Specials\SpecialRandomInCategory\onSubmit(), MediaWiki\Specials\SpecialBotPasswords\onSuccess(), MediaWiki\Specials\SpecialChangeContentModel\onSuccess(), MediaWiki\Specials\SpecialLockdb\onSuccess(), MediaWiki\Specials\SpecialPasswordReset\onSuccess(), MediaWiki\Specials\SpecialUnlockdb\onSuccess(), MediaWiki\Specials\SpecialWhatLinksHere\onSuccess(), MediaWiki\Specials\SpecialWatchlist\outputChangesList(), MediaWiki\Specials\SpecialMediaStatistics\outputMediaType(), MediaWiki\SpecialPage\ChangesListSpecialPage\outputNoResults(), MediaWiki\Specials\SpecialRecentChangesLinked\outputNoResults(), MediaWiki\Specials\SpecialMediaStatistics\outputResults(), MediaWiki\Specials\SpecialEditWatchlist\outputSubtitle(), MediaWiki\Specials\SpecialMediaStatistics\outputTableEnd(), MediaWiki\Specials\SpecialMediaStatistics\outputTableRow(), MediaWiki\SpecialPage\ChangesListSpecialPage\outputTimeout(), MediaWiki\Specials\SpecialBlock\postHtml(), MediaWiki\Specials\SpecialBlock\preHtml(), MediaWiki\Specials\SpecialTags\processCreateTagForm(), MediaWiki\Specials\SpecialTags\processTagForm(), MediaWiki\Specials\SpecialEmailUser\sendEmailForm(), MediaWiki\Specials\SpecialUserLogin\setHeaders(), MediaWiki\Specials\SpecialNewFiles\setTopText(), MediaWiki\Specials\SpecialSearch\setupPage(), MediaWiki\Specials\SpecialTags\showActivateDeactivateForm(), MediaWiki\Specials\SpecialEditTags\showConvenienceLinks(), MediaWiki\Specials\SpecialRevisionDelete\showConvenienceLinks(), MediaWiki\Specials\SpecialTags\showDeleteTagForm(), MediaWiki\Specials\SpecialUserRights\showEditUserGroupsForm(), MediaWiki\Specials\SpecialMovePage\showForm(), MediaWiki\Specials\SpecialEditTags\showForm(), MediaWiki\Specials\SpecialRevisionDelete\showForm(), MediaWiki\Specials\SpecialUndelete\showHistory(), MediaWiki\Specials\SpecialAutoblockList\showList(), MediaWiki\Specials\SpecialBlockList\showList(), MediaWiki\Specials\SpecialProtectedPages\showOptions(), MediaWiki\Specials\SpecialUpload\showRecoverableUploadError(), MediaWiki\Specials\SpecialUpload\showUploadError(), MediaWiki\Specials\SpecialUpload\showUploadStatus(), MediaWiki\Specials\SpecialUpload\showUploadWarning(), MediaWiki\Specials\SpecialRevisionDelete\submit(), MediaWiki\Specials\SpecialConfirmEmail\submitSend(), MediaWiki\Specials\SpecialEditTags\success(), MediaWiki\Specials\SpecialLinkAccounts\success(), MediaWiki\Specials\SpecialRevisionDelete\success(), MediaWiki\Specials\SpecialCreateAccount\successfulAction(), MediaWiki\Specials\SpecialUserLogin\successfulAction(), MediaWiki\Specials\SpecialUserRights\switchForm(), and MediaWiki\Specials\SpecialChangeContentModel\validateTitle().

◆ newSearchPage()

static MediaWiki\SpecialPage\SpecialPage::newSearchPage ( User $user)
static

Get the users preferred search page.

It will fall back to Special:Search if the preference points to a page that doesn't exist or is not defined.

Since
1.38
Parameters
User$userSearch page can be customized by user preference.
Returns
Title

Definition at line 127 of file SpecialPage.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\SpecialPage\SpecialPage\getTitleFor().

◆ outputHeader()

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

Outputs a summary message on top of special pages By 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'

Stability: stable
to override
Parameters
string$summaryMessageKeyMessage key of the summary

Definition at line 781 of file SpecialPage.php.

Referenced by MediaWiki\Specials\SpecialBookSources\execute(), MediaWiki\Specials\SpecialEditWatchlist\execute(), MediaWiki\SpecialPage\ContributionsSpecialPage\execute(), MediaWiki\SpecialPage\FormSpecialPage\execute(), MediaWiki\Specials\SpecialActiveUsers\execute(), MediaWiki\Specials\SpecialAllPages\execute(), MediaWiki\Specials\SpecialAutoblockList\execute(), MediaWiki\Specials\SpecialBlockList\execute(), MediaWiki\Specials\SpecialCategories\execute(), MediaWiki\Specials\SpecialComparePages\execute(), MediaWiki\Specials\SpecialContribute\execute(), MediaWiki\Specials\SpecialDeletedContributions\execute(), MediaWiki\Specials\SpecialEditTags\execute(), MediaWiki\Specials\SpecialEmailUser\execute(), MediaWiki\Specials\SpecialExport\execute(), MediaWiki\Specials\SpecialFileDuplicateSearch\execute(), MediaWiki\Specials\SpecialImport\execute(), MediaWiki\Specials\SpecialLinkSearch\execute(), MediaWiki\Specials\SpecialListFiles\execute(), MediaWiki\Specials\SpecialListGrants\execute(), MediaWiki\Specials\SpecialListGroupRights\execute(), MediaWiki\Specials\SpecialListUsers\execute(), MediaWiki\Specials\SpecialLog\execute(), MediaWiki\Specials\SpecialMergeHistory\execute(), MediaWiki\Specials\SpecialMIMESearch\execute(), MediaWiki\Specials\SpecialMovePage\execute(), MediaWiki\Specials\SpecialNewFiles\execute(), MediaWiki\Specials\SpecialNewPages\execute(), MediaWiki\Specials\SpecialPagesWithProp\execute(), MediaWiki\Specials\SpecialPasswordPolicies\execute(), MediaWiki\Specials\SpecialPreferences\execute(), MediaWiki\Specials\SpecialPrefixIndex\execute(), MediaWiki\Specials\SpecialProtectedPages\execute(), MediaWiki\Specials\SpecialProtectedTitles\execute(), MediaWiki\Specials\SpecialRevisionDelete\execute(), MediaWiki\Specials\SpecialSpecialPages\execute(), MediaWiki\Specials\SpecialStatistics\execute(), MediaWiki\Specials\SpecialTags\execute(), MediaWiki\Specials\SpecialTrackingCategories\execute(), MediaWiki\Specials\SpecialUnblock\execute(), MediaWiki\Specials\SpecialUndelete\execute(), MediaWiki\Specials\SpecialUpload\execute(), MediaWiki\Specials\SpecialUserRights\execute(), MediaWiki\SpecialPage\ChangesListSpecialPage\execute(), MediaWiki\SpecialPage\DisabledSpecialPage\execute(), MediaWiki\Specials\SpecialChangeCredentials\execute(), MediaWiki\Specials\SpecialLinkAccounts\execute(), MediaWiki\Specials\SpecialUnlinkAccounts\execute(), MediaWiki\Specials\SpecialSearch\setupPage(), MediaWiki\SpecialPage\SpecialRedirectWithAction\showNoRedirectPage(), MediaWiki\Specials\SpecialDiff\showNoRedirectPage(), MediaWiki\Specials\SpecialNewSection\showNoRedirectPage(), and MediaWiki\Specials\SpecialPermanentLink\showNoRedirectPage().

◆ prefixSearchArray()

static MediaWiki\SpecialPage\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 681 of file SpecialPage.php.

Referenced by MediaWiki\Specials\SpecialPagesWithProp\prefixSearchSubpages().

◆ prefixSearchString()

MediaWiki\SpecialPage\SpecialPage::prefixSearchString ( $search,
$limit,
$offset,
SearchEngineFactory $searchEngineFactory = null )
protected

Perform a regular substring search for prefixSearchSubpages.

Since
1.36 Added $searchEngineFactory parameter
Parameters
string$searchPrefix to search for
int$limitMaximum number of results to return (usually 10)
int$offsetNumber of results to skip (usually 0)
SearchEngineFactory | null$searchEngineFactoryProvide the service
Returns
string[] Matching subpages

Definition at line 650 of file SpecialPage.php.

References SearchEngineFactory\create().

Referenced by MediaWiki\SpecialPage\SpecialRedirectWithAction\prefixSearchSubpages(), MediaWiki\Specials\SpecialAllPages\prefixSearchSubpages(), MediaWiki\Specials\SpecialChangeContentModel\prefixSearchSubpages(), MediaWiki\Specials\SpecialNewSection\prefixSearchSubpages(), MediaWiki\Specials\SpecialPageLanguage\prefixSearchSubpages(), MediaWiki\Specials\SpecialRecentChangesLinked\prefixSearchSubpages(), and MediaWiki\Specials\SpecialUndelete\prefixSearchSubpages().

◆ prefixSearchSubpages()

MediaWiki\SpecialPage\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" ]</tt> \par "Stability: 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 MediaWiki\SpecialPage\ContributionsSpecialPage, MediaWiki\SpecialPage\SpecialRedirectWithAction, MediaWiki\Specials\SpecialAllPages, MediaWiki\Specials\SpecialBlock, MediaWiki\Specials\SpecialChangeContentModel, MediaWiki\Specials\SpecialDeletedContributions, MediaWiki\Specials\SpecialEmailUser, MediaWiki\Specials\SpecialFileDuplicateSearch, MediaWiki\Specials\SpecialFilepath, MediaWiki\Specials\SpecialListFiles, MediaWiki\Specials\SpecialMovePage, MediaWiki\Specials\SpecialNewSection, MediaWiki\Specials\SpecialPageLanguage, MediaWiki\Specials\SpecialPagesWithProp, MediaWiki\Specials\SpecialRecentChangesLinked, MediaWiki\Specials\SpecialRenameUser, MediaWiki\Specials\SpecialUnblock, MediaWiki\Specials\SpecialUndelete, MediaWiki\Specials\SpecialUserRights, and MediaWiki\Specials\SpecialWhatLinksHere.

Definition at line 608 of file SpecialPage.php.

◆ requireLogin()

MediaWiki\SpecialPage\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 434 of file SpecialPage.php.

References getUser().

◆ requireNamedUser()

MediaWiki\SpecialPage\SpecialPage::requireNamedUser ( $reasonMsg = 'exception-nologin-text',
$titleMsg = 'exception-nologin' )

If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

Since
1.39
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 450 of file SpecialPage.php.

References getUser().

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

◆ run()

MediaWiki\SpecialPage\SpecialPage::run ( $subPage)
final

Entry point.

Since
1.20
Parameters
string | null$subPage

Definition at line 711 of file SpecialPage.php.

◆ setAuthManager()

◆ setContentLanguage()

MediaWiki\SpecialPage\SpecialPage::setContentLanguage ( Language $contentLanguage)
final

Set content language.

Access: internal
For factory only
Parameters
Language$contentLanguage
Since
1.36

Definition at line 948 of file SpecialPage.php.

◆ setContext()

MediaWiki\SpecialPage\SpecialPage::setContext ( $context)

Sets the context this SpecialPage is executed in.

Parameters
IContextSource$context
Since
1.18

Definition at line 846 of file SpecialPage.php.

Referenced by Skin\buildNavUrls(), and MediaWiki\SpecialPage\LoginSignupSpecialPage\execute().

◆ setHeaders()

MediaWiki\SpecialPage\SpecialPage::setHeaders ( )
protected

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

Stability: stable
to override

Reimplemented in MediaWiki\Specials\SpecialUserLogin.

Definition at line 691 of file SpecialPage.php.

References wfDeprecated().

Referenced by MediaWiki\Specials\SpecialConfirmEmail\execute(), MediaWiki\Specials\SpecialEmailInvalidate\execute(), MediaWiki\Specials\SpecialBookSources\execute(), MediaWiki\Specials\SpecialEditWatchlist\execute(), MediaWiki\SpecialPage\ContributionsSpecialPage\execute(), MediaWiki\SpecialPage\FormSpecialPage\execute(), MediaWiki\Specials\SpecialActiveUsers\execute(), MediaWiki\Specials\SpecialAllMessages\execute(), MediaWiki\Specials\SpecialAllPages\execute(), MediaWiki\Specials\SpecialApiSandbox\execute(), MediaWiki\Specials\SpecialAutoblockList\execute(), MediaWiki\Specials\SpecialBlankpage\execute(), MediaWiki\Specials\SpecialBlockList\execute(), MediaWiki\Specials\SpecialCategories\execute(), MediaWiki\Specials\SpecialComparePages\execute(), MediaWiki\Specials\SpecialContribute\execute(), MediaWiki\Specials\SpecialDeletedContributions\execute(), MediaWiki\Specials\SpecialEditTags\execute(), MediaWiki\Specials\SpecialEmailUser\execute(), MediaWiki\Specials\SpecialExport\execute(), MediaWiki\Specials\SpecialFileDuplicateSearch\execute(), MediaWiki\Specials\SpecialGoToInterwiki\execute(), MediaWiki\Specials\SpecialImport\execute(), MediaWiki\Specials\SpecialLinkSearch\execute(), MediaWiki\Specials\SpecialListFiles\execute(), MediaWiki\Specials\SpecialListGrants\execute(), MediaWiki\Specials\SpecialListGroupRights\execute(), MediaWiki\Specials\SpecialListUsers\execute(), MediaWiki\Specials\SpecialLog\execute(), MediaWiki\Specials\SpecialMergeHistory\execute(), MediaWiki\Specials\SpecialMIMESearch\execute(), MediaWiki\Specials\SpecialMovePage\execute(), MediaWiki\Specials\SpecialNewFiles\execute(), MediaWiki\Specials\SpecialNewPages\execute(), MediaWiki\Specials\SpecialPagesWithProp\execute(), MediaWiki\Specials\SpecialPasswordPolicies\execute(), MediaWiki\Specials\SpecialPreferences\execute(), MediaWiki\Specials\SpecialPrefixIndex\execute(), MediaWiki\Specials\SpecialProtectedPages\execute(), MediaWiki\Specials\SpecialProtectedTitles\execute(), MediaWiki\Specials\SpecialRandomPage\execute(), MediaWiki\Specials\SpecialRenameUser\execute(), MediaWiki\Specials\SpecialRevisionDelete\execute(), MediaWiki\Specials\SpecialSpecialPages\execute(), MediaWiki\Specials\SpecialStatistics\execute(), MediaWiki\Specials\SpecialTags\execute(), MediaWiki\Specials\SpecialTrackingCategories\execute(), MediaWiki\Specials\SpecialUnblock\execute(), MediaWiki\Specials\SpecialUndelete\execute(), MediaWiki\Specials\SpecialUpload\execute(), MediaWiki\Specials\SpecialUserLogout\execute(), MediaWiki\Specials\SpecialUserRights\execute(), MediaWiki\SpecialPage\ChangesListSpecialPage\execute(), MediaWiki\SpecialPage\DisabledSpecialPage\execute(), MediaWiki\SpecialPage\LoginSignupSpecialPage\execute(), MediaWiki\Specials\SpecialChangeCredentials\execute(), MediaWiki\Specials\SpecialExpandTemplates\execute(), MediaWiki\Specials\SpecialLinkAccounts\execute(), MediaWiki\Specials\SpecialUnlinkAccounts\execute(), MediaWiki\Specials\SpecialSearch\setupPage(), MediaWiki\SpecialPage\SpecialRedirectWithAction\showNoRedirectPage(), MediaWiki\Specials\SpecialDiff\showNoRedirectPage(), MediaWiki\Specials\SpecialNewSection\showNoRedirectPage(), and MediaWiki\Specials\SpecialPermanentLink\showNoRedirectPage().

◆ setHookContainer()

MediaWiki\SpecialPage\SpecialPage::setHookContainer ( HookContainer $hookContainer)
Since
1.35
Access: internal
Parameters
HookContainer$hookContainer

Definition at line 1166 of file SpecialPage.php.

◆ setLinkRenderer()

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

Definition at line 1120 of file SpecialPage.php.

◆ setReauthPostData()

MediaWiki\SpecialPage\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.

Note
Call self::setAuthManager from special page constructor when overriding
Stability: stable
to override
Since
1.32
Parameters
array$data

Reimplemented in MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 487 of file SpecialPage.php.

◆ setSpecialPageFactory()

MediaWiki\SpecialPage\SpecialPage::setSpecialPageFactory ( SpecialPageFactory $specialPageFactory)
final
Access: internal
For factory only
Since
1.36
Parameters
SpecialPageFactory$specialPageFactory

Definition at line 1200 of file SpecialPage.php.

◆ userCanExecute()

MediaWiki\SpecialPage\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.

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

Reimplemented in MediaWiki\Specials\SpecialPasswordReset, MediaWiki\Specials\SpecialUndelete, and MediaWiki\Specials\SpecialUpload.

Definition at line 355 of file SpecialPage.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ useTransactionalTimeLimit()

Member Data Documentation

◆ $mContext

IContextSource MediaWiki\SpecialPage\SpecialPage::$mContext
protected

Current request context.

Definition at line 96 of file SpecialPage.php.

◆ $mIncludable

bool MediaWiki\SpecialPage\SpecialPage::$mIncludable
protected

Whether the special page can be included in an article.

Definition at line 90 of file SpecialPage.php.

Referenced by MediaWiki\SpecialPage\SpecialPage\isIncludable().

◆ $mIncluding

bool MediaWiki\SpecialPage\SpecialPage::$mIncluding
protected

Whether or not this special page is being included from an article.

Definition at line 87 of file SpecialPage.php.

◆ $mName

string MediaWiki\SpecialPage\SpecialPage::$mName
protected

The canonical name of this special page Also used as the message key for the default.

heading, @see getDescription()

Definition at line 72 of file SpecialPage.php.

Referenced by MediaWiki\SpecialPage\SpecialPage\getName().

◆ $mRestriction

string MediaWiki\SpecialPage\SpecialPage::$mRestriction
protected

Minimum user level required to access this page, or "" for anyone.

Also used to categorise the pages in Special:Specialpages

Definition at line 81 of file SpecialPage.php.

Referenced by MediaWiki\SpecialPage\SpecialPage\getRestriction().


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