Parent class for all special pages. More...

Inheritance diagram for SpecialPage:

Collaboration diagram for SpecialPage:

Public Member Functions
	__construct ($name= '', $restriction= '', $listed=true, $function=false, $file= '', $includable=false)
	Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...

	addHelpLink ($to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators. More...

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError. More...

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError. More...

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have. More...

	doesWrites ()
	Indicates whether this special page may perform database writes. More...

	execute ($subPage)
	Default execute method Checks user permissions. More...

	getConfig ()
	Shortcut to get main config object. More...

	getContext ()
	Gets the context this SpecialPage is executed in. More...

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

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

	getFullTitle ()
	Return the full title, including $par. More...

	getLanguage ()
	Shortcut to get user's language. More...

	getLocalName ()
	Get the localised name of the special page. More...

	getName ()
	Get the name of this Special Page. More...

	getOutput ()
	Get the OutputPage being used for this instance. More...

	getPageTitle ($subpage=false)
	Get a self-referential title object. More...

	getRequest ()
	Get the WebRequest being used for this instance. More...

	getRestriction ()
	Get the permission that a user must have to execute this page. More...

	getSkin ()
	Shortcut to get the skin being used for this instance. More...

	getTitle ($subpage=false)
	Get a self-referential title object. More...

	getUser ()
	Shortcut to get the User executing this instance. More...

	including ($x=null)
	Whether the special page is being evaluated via transclusion. More...

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode. More...

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

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

	isListed ()
	Whether this special page is listed in Special:SpecialPages. More...

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes. More...

	listed ($x=null)
	Get or set whether this special page is listed in Special:SpecialPages. More...

	maxIncludeCacheTime ()
	How long to cache page when it is being included. More...

	msg ()
	Wrapper around wfMessage that sets the current context. More...

	outputHeader ($summaryMessageKey= '')
	Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...

	prefixSearchSubpages ($search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept. More...

	requireLogin ($reasonMsg= 'exception-nologin-text', $titleMsg= 'exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error. More...

	run ($subPage)
	Entry point. More...

	setContext ($context)
	Sets the context this SpecialPage is executed in. More...

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

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ($listed)
	Set whether this page is listed in Special:Specialpages, at run-time. More...

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

Static Public Member Functions
static	getSafeTitleFor ($name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage. More...

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

static	getTitleValueFor ($name, $subpage=false, $fragment= '')
	Get a localised TitleValue object for a specified special page name. More...

Protected Member Functions
	addFeedLinks ($params)
	Adds RSS/atom links. More...

	afterExecute ($subPage)
	Gets called after. More...

	beforeExecute ($subPage)
	Gets called before. More...

	checkLoginSecurityLevel ($level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process. More...

	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'. More...

	getLinkRenderer ()

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

	getRobotPolicy ()
	Return the robot policy. More...

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches. More...

	prefixSearchString ($search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages. More...

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed. More...

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

Protected Attributes
IContextSource	$mContext
	Current request context. More...

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Private Attributes
MediaWiki Linker LinkRenderer null	$linkRenderer

	$mListed

	$mLocalName

Detailed Description

Parent class for all special pages.

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

Definition at line 36 of file SpecialPage.php.

Constructor & Destructor Documentation

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

Parameters

string	$name	Name of the special page, as seen in links and URLs
string	$restriction	User right required, e.g. "block" or "delete"
bool	$listed	Whether the page is listed in Special:Specialpages
callable \| bool	$function	Unused
string	$file	Unused
bool	$includable	Whether the page can be included in normal pages

Definition at line 136 of file SpecialPage.php.

References $name.

Member Function Documentation

SpecialPage::addFeedLinks ( $params )

protected

Adds RSS/atom links.

Parameters

array $params

Definition at line 767 of file SpecialPage.php.

References $params, as, getConfig(), getOutput(), wfAppendQuery(), and wfScript().

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

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	$to	Target MediaWiki.org page title or encoded URL.
bool	$overrideBaseUrl	Whether $url is a full URL, to avoid MW.o.

Since: 1.25

Definition at line 785 of file SpecialPage.php.

References $wgContLang, getOutput(), global, Skin\makeUrl(), and msg().

Referenced by SpecialChangeContentModel\alterForm(), SpecialBlock\alterForm(), SpecialNewFiles\execute(), SpecialSpecialpages\execute(), SpecialContributions\execute(), SpecialLog\execute(), SpecialExport\execute(), SpecialPreferences\execute(), SpecialRecentChanges\execute(), SpecialWhatLinksHere\execute(), SpecialWatchlist\execute(), SpecialAllMessages\execute(), LinkSearchPage\execute(), UserrightsPage\execute(), SpecialSearch\execute(), SpecialNewpages\execute(), SpecialUpload\execute(), SpecialUndelete\execute(), SpecialRecentChangesLinked\getExtraOptions(), SpecialRandomInCategory\getFormFields(), SpecialDiff\getRedirect(), MovePageForm\showForm(), SpecialEditTags\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), and SpecialMergeHistory\showMergeForm().

SpecialPage::afterExecute ( $subPage )

protected

Gets called after.

See Also: SpecialPage::execute.

Since: 1.20

Parameters

string | null $subPage

Definition at line 556 of file SpecialPage.php.

Referenced by run().

SpecialPage::beforeExecute ( $subPage )

protected

Gets called before.

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

Since: 1.20

Parameters

string | null $subPage

Returns: bool|void

Definition at line 545 of file SpecialPage.php.

Referenced by run().

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 $level A 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

ErrorPageError If the security level cannot be met, even with reauthentication.

Definition at line 379 of file SpecialPage.php.

References $query, $request, $title, getFullTitle(), getName(), getOutput(), getRequest(), getTitleFor(), PROTO_HTTPS, true, wfArrayToCgi(), and wfMessage().

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

SpecialPage::checkPermissions ( )

Checks if userCanExecute, and if not throws a PermissionsError.

Since: 1.19

Returns: void

Exceptions

PermissionsError

Definition at line 306 of file SpecialPage.php.

References displayRestrictionError(), getUser(), and userCanExecute().

Referenced by FormSpecialPage\checkExecutePermissions(), EmailInvalidation\execute(), SpecialUnblock\execute(), SpecialWatchlist\execute(), EmailConfirmation\execute(), SpecialEditTags\execute(), SpecialUploadStash\execute(), SpecialEditWatchlist\execute(), SpecialMergeHistory\execute(), SpecialRevisionDelete\execute(), LoginSignupSpecialPage\execute(), execute(), and SpecialUndelete\execute().

SpecialPage::checkReadOnly ( )

If the wiki is currently in readonly mode, throws a ReadOnlyError.

Since: 1.19

Returns: void

Exceptions

ReadOnlyError

Definition at line 319 of file SpecialPage.php.

References wfReadOnly().

Referenced by FormSpecialPage\checkExecutePermissions(), SpecialPreferences\execute(), EmailInvalidation\execute(), SpecialUnblock\execute(), EmailConfirmation\execute(), SpecialEditTags\execute(), SpecialImport\execute(), MovePageForm\execute(), SpecialEditWatchlist\execute(), UserrightsPage\execute(), SpecialMergeHistory\execute(), SpecialRevisionDelete\execute(), SpecialUpload\execute(), SpecialUndelete\showHistory(), and SpecialUndelete\undelete().

SpecialPage::displayRestrictionError ( )

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

Exceptions

PermissionsError

Definition at line 295 of file SpecialPage.php.

Referenced by checkPermissions(), DeletedContributionsPage\execute(), and QueryPage\execute().

SpecialPage::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns: bool

Since: 1.27

Definition at line 826 of file SpecialPage.php.

SpecialPage::execute ( $subPage )

Default execute method Checks user permissions.

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

Parameters

string | null $subPage

Definition at line 568 of file SpecialPage.php.

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

Referenced by SpecialPageExecutor\getHTMLFromSpecialPage(), and run().

SpecialPage::getCacheTTL ( )

protected

Returns: int Seconds that this page can be cached

Definition at line 217 of file SpecialPage.php.

Referenced by maxIncludeCacheTime().

SpecialPage::getConfig ( )

Shortcut to get main config object.

Returns: Config

Since: 1.24

Definition at line 714 of file SpecialPage.php.

References getContext().

Referenced by SpecialPasswordReset\__construct(), addFeedLinks(), SpecialPasswordReset\alterForm(), SpecialNewFiles\buildForm(), ChangesListSpecialPage\buildMainQueryConds(), SpecialUnlockdb\checkExecutePermissions(), SpecialLockdb\checkExecutePermissions(), SpecialBotPasswords\checkExecutePermissions(), SpecialWatchlist\cutoffselector(), QueryPage\doFeed(), SpecialWatchlist\doHeader(), SpecialImport\doImport(), SpecialWatchlist\doMainQuery(), SpecialRecentChanges\doMainQuery(), MovePageForm\doSubmit(), SpecialTags\doTagRow(), SpecialApiSandbox\execute(), SpecialLog\execute(), SpecialExport\execute(), SpecialListGrants\execute(), SpecialListGroupRights\execute(), DeletedContributionsPage\execute(), SpecialRunJobs\execute(), SpecialWhatLinksHere\execute(), SpecialActiveUsers\execute(), SpecialWatchlist\execute(), SpecialAllMessages\execute(), LinkSearchPage\execute(), SpecialExpandTemplates\execute(), SpecialImport\execute(), SpecialEmailUser\execute(), QueryPage\execute(), SpecialNewpages\feed(), SpecialNewpages\feedTitle(), QueryPage\feedTitle(), UserrightsPage\fetchUser(), QueryPage\getDBLimit(), ChangesListSpecialPage\getDefaultOptions(), SpecialRecentChanges\getExtraOptions(), SpecialRecentChanges\getFeedQuery(), LoginSignupSpecialPage\getFieldDefinitions(), SpecialPageLanguage\getFormFields(), SpecialPasswordReset\getFormFields(), SpecialStatistics\getGroupStats(), SpecialProtectedtitles\getLevelMenu(), SpecialProtectedpages\getLevelMenu(), QueryPage\getLimitOffset(), SpecialImport\getMappingFormPart(), QueryPage\getMaxResults(), SpecialExport\getPagesFromCategory(), SpecialExport\getPagesFromNamespace(), SpecialStatistics\getPageStats(), UnusedimagesPage\getQueryInfo(), WantedPagesPage\getQueryInfo(), LinkSearchPage\getQueryInfo(), SpecialRemoveCredentials\getRequestBlacklist(), SpecialLinkAccounts\getRequestBlacklist(), SpecialUnlinkAccounts\getRequestBlacklist(), SpecialChangeCredentials\getRequestBlacklist(), SpecialLog\getSubpagesForPrefixSearch(), SpecialResetTokens\getTokensList(), SpecialStatistics\getUserStats(), SpecialSearch\goResult(), QueryPage\isCached(), QueryPage\isExpensive(), SpecialBotPasswords\isListed(), LinkSearchPage\linkParameters(), maxIncludeCacheTime(), SpecialPrefixindex\namespacePrefixForm(), SpecialUnlockdb\onSubmit(), SpecialLockdb\onSubmit(), SpecialPageLanguage\onSubmit(), SpecialRecentChanges\optionsPanel(), SpecialRecentChanges\outputChangesList(), SpecialWatchlist\outputChangesList(), SpecialListGroupRights\outputNamespaceProtectionInfo(), SpecialUploadStash\outputRemoteScaledThumb(), SpecialUploadStash\outputThumbFromStash(), SpecialLog\parseParams(), SpecialTrackingCategories\prepareTrackingCategoriesData(), SpecialUpload\processUpload(), SpecialUpload\processVerificationError(), SpecialBotPasswords\save(), setHeaders(), SpecialWatchlist\setTopText(), SpecialSearch\shouldRunSuggestedQuery(), MovePageForm\showForm(), SpecialImport\showForm(), SpecialUndelete\showHistory(), SpecialExpandTemplates\showHtmlPreview(), SpecialWhatLinksHere\showIndirectLinks(), SpecialSearch\showResults(), SpecialUndelete\showRevision(), SpecialUndelete\undelete(), and SpecialExport\validateLinkDepth().

SpecialPage::getContext ( )

Gets the context this SpecialPage is executed in.

Returns: IContextSource|RequestContext

Since: 1.18

Definition at line 648 of file SpecialPage.php.

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

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.

Returns: string

Definition at line 606 of file SpecialPage.php.

References msg().

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

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 805 of file SpecialPage.php.

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

SpecialPage::getFullTitle ( )

Return the full title, including $par.

Returns: Title

Since: 1.18

Definition at line 724 of file SpecialPage.php.

References getContext().

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

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

Returns: string

Since: 1.21

Definition at line 838 of file SpecialPage.php.

Referenced by getFinalGroupName().

SpecialPage::getLanguage ( )

Shortcut to get user's language.

Returns: Language

Since: 1.19

Definition at line 705 of file SpecialPage.php.

References getContext().

SpecialPage::getLinkRenderer ( )

protected

Since: 1.28

Returns: \MediaWiki\Linker\LinkRenderer

Definition at line 856 of file SpecialPage.php.

References $linkRenderer.

Referenced by SpecialEditWatchlist\buildRemoveLine(), SpecialContributions\contributionsSub(), SpecialWatchlist\doHeader(), MovePageForm\doSubmit(), SpecialTags\doTagRow(), SpecialCategories\execute(), SpecialProtectedpages\execute(), SpecialNewpages\filterLinks(), UnusedtemplatesPage\formatResult(), MostlinkedCategoriesPage\formatResult(), ShortPagesPage\formatResult(), ListredirectsPage\formatResult(), LinkSearchPage\formatResult(), SpecialNewpages\formatRow(), SpecialBotPasswords\getFormFields(), DeletedContributionsPage\getSubTitle(), SpecialUpload\getUploadForm(), SpecialEditWatchlist\outputSubtitle(), SpecialChangeCredentials\showSubpageList(), MovePageForm\showSubpages(), SpecialEditWatchlist\showTitles(), SpecialUploadStash\showUploads(), SpecialUpload\showUploadWarning(), and SpecialUpload\showViewDeletedLinks().

SpecialPage::getLocalName ( )

Get the localised name of the special page.

Returns: string

Definition at line 234 of file SpecialPage.php.

References $mLocalName, and SpecialPageFactory\getLocalNameFor().

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.

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

Definition at line 351 of file SpecialPage.php.

Referenced by execute().

SpecialPage::getName ( )

Get the name of this Special Page.

Returns: string

Definition at line 150 of file SpecialPage.php.

References $mName.

Referenced by checkLoginSecurityLevel(), RandomPage\execute(), QueryPage\execute(), QueryPage\fetchFromCache(), QueryPage\getCachedTimestamp(), SpecialRecentChanges\getExtraOptions(), getFinalGroupName(), FormSpecialPage\getForm(), SpecialEmailUser\getFormFields(), AuthManagerSpecialPage\getLoginSecurityLevel(), FormSpecialPage\getMessagePrefix(), QueryPage\getRecacheDB(), SpecialMypage\getRedirect(), SpecialMytalk\getRedirect(), SpecialMycontributions\getRedirect(), SpecialMyuploads\getRedirect(), SpecialAllMyUploads\getRedirect(), AuthManagerSpecialPage\getToken(), AuthManagerSpecialPage\handleReauthBeforeExecute(), AuthManagerSpecialPage\handleReturnBeforeExecute(), LoginSignupSpecialPage\mainLoginForm(), SpecialLockdb\onSubmit(), SpecialChangeEmail\onSuccess(), outputHeader(), SpecialEditWatchlist\outputSubtitle(), QueryPage\recache(), ChangesListSpecialPage\runMainQueryHook(), LoginSignupSpecialPage\showSuccessPage(), and SpecialCreateAccount\successfulAction().

SpecialPage::getOutput ( )

Get the OutputPage being used for this instance.

Returns: OutputPage

Since: 1.18

Definition at line 675 of file SpecialPage.php.

References getContext().

SpecialPage::getPageTitle ( $subpage = false )

Get a self-referential title object.

Parameters

string | bool $subpage

Returns: Title

Since: 1.23

Definition at line 628 of file SpecialPage.php.

Referenced by SpecialUndelete\diffHeader(), SpecialRecentChanges\doHeader(), SpecialTags\doTagRow(), SpecialApiHelp\execute(), SpecialLinkAccounts\execute(), SpecialBlockList\execute(), SpecialWhatLinksHere\execute(), SpecialWatchlist\execute(), LinkSearchPage\execute(), SpecialExpandTemplates\execute(), SpecialImport\execute(), FileDuplicateSearchPage\execute(), SpecialSearch\execute(), SpecialEmailUser\execute(), LoginSignupSpecialPage\execute(), QueryPage\execute(), SpecialPageExecutor\executeSpecialPage(), SpecialNewpages\feed(), QueryPage\feedUrl(), SpecialNewpages\filterLinks(), SpecialUndelete\formatFileRow(), SpecialUndelete\formatRevisionRow(), LoginSignupSpecialPage\getAuthForm(), SpecialEditWatchlist\getClearForm(), SpecialVersion\getCreditsForExtension(), SpecialSearch\getDidYouMeanHtml(), SpecialSearch\getDidYouMeanRewrittenHtml(), LoginSignupSpecialPage\getFakeTemplate(), SpecialBotPasswords\getFormFields(), SpecialEditWatchlist\getNormalForm(), MIMEsearchPage\getPageHeader(), SpecialEditWatchlist\getRawForm(), UserrightsPage\getSuccessURL(), getTitle(), SpecialUpload\getUploadForm(), AuthManagerSpecialPage\handleReturnBeforeExecute(), SpecialVersion\listAuthors(), LoginSignupSpecialPage\load(), LoginSignupSpecialPage\mainLoginForm(), LoginSignupSpecialPage\makeLanguageSelectorLink(), SpecialRecentChanges\makeOptionsLink(), SpecialSearch\makeSearchLink(), SpecialPrefixindex\namespacePrefixForm(), SpecialBotPasswords\onSubmit(), SpecialBotPasswords\onSuccess(), AuthManagerSpecialPage\performAuthenticationStep(), SpecialJavaScriptTest\plainQUnit(), SpecialTags\processCreateTagForm(), SpecialTags\processTagForm(), SpecialWatchlist\setTopText(), SpecialSearch\shortDialog(), SpecialTags\showActivateDeactivateForm(), SpecialAllPages\showChunk(), SpecialTags\showDeleteTagForm(), UserrightsPage\showEditUserGroupsForm(), SpecialUndelete\showFileConfirmationForm(), MovePageForm\showForm(), SpecialEditTags\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), SpecialMergeHistory\showHistory(), SpecialUndelete\showHistory(), SpecialUndelete\showList(), SpecialMergeHistory\showMergeForm(), SpecialProtectedpages\showOptions(), SpecialProtectedtitles\showOptions(), SpecialPrefixindex\showPrefixChunk(), EmailConfirmation\showRequestForm(), SpecialPreferences\showResetForm(), SpecialSearch\showResults(), SpecialUndelete\showRevision(), SpecialUndelete\showSearchForm(), SpecialTags\showTagList(), SpecialUploadStash\showUploads(), SpecialPreferences\submitReset(), SpecialCreateAccount\successfulAction(), UserrightsPage\switchForm(), SpecialRevisionDelete\tryShowFile(), SpecialEmailUser\userForm(), SpecialWhatLinksHere\whatlinkshereForm(), and SpecialWhatLinksHere\wlhLink().

SpecialPage::getRequest ( )

Get the WebRequest being used for this instance.

Returns: WebRequest

Since: 1.18

Definition at line 665 of file SpecialPage.php.

References getContext().

SpecialPage::getRestriction ( )

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

Returns: string

Definition at line 158 of file SpecialPage.php.

References $mRestriction.

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 735 of file SpecialPage.php.

Referenced by setHeaders().

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

static

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

Parameters

string	$name
string \| bool	$subpage	Subpage string, or false to not use a subpage

Returns: Title|null Title object or null if the page doesn't exist

Definition at line 110 of file SpecialPage.php.

References $name, SpecialPageFactory\getLocalNameFor(), Title\makeTitleSafe(), and NS_SPECIAL.

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

SpecialPage::getSkin ( )

Shortcut to get the skin being used for this instance.

Returns: Skin

Since: 1.18

Definition at line 695 of file SpecialPage.php.

References getContext().

Referenced by SpecialEditWatchlist\buildRemoveLine(), SpecialListFiles\execute(), SpecialContributions\execute(), DeletedContributionsPage\execute(), SpecialUnblock\execute(), SpecialWhatLinksHere\execute(), UserrightsPage\execute(), SpecialEmailUser\execute(), QueryPage\execute(), SpecialUndelete\execute(), SpecialJavaScriptTest\exportQUnit(), LoginSignupSpecialPage\getFakeTemplate(), SpecialBlock\setParameter(), SpecialRecentChangesLinked\setTopText(), SpecialLog\show(), SpecialEditTags\showConvenienceLinks(), SpecialRevisionDelete\showConvenienceLinks(), and MovePageForm\showForm().

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.

Returns: string[] subpages to search from

Definition at line 437 of file SpecialPage.php.

Referenced by prefixSearchSubpages().

SpecialPage::getTitle ( $subpage = false )

Get a self-referential title object.

Parameters

string | bool $subpage

Returns: Title

Deprecated:: since 1.23, use SpecialPage::getPageTitle

Definition at line 617 of file SpecialPage.php.

References getPageTitle().

Referenced by SpecialTags\doTagRow(), SpecialUpload\getExistsWarning(), and SpecialRevisionDelete\showForm().

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

static

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

Since: 1.9; 1.21 $fragment parameter added

Parameters

string	$name
string \| bool	$subpage	Subpage string, or false to not use a subpage
string	$fragment	The link fragment (after the "#")

Returns: Title

Exceptions

MWException

Definition at line 82 of file SpecialPage.php.

References $name, and Title\newFromTitleValue().

Referenced by ApiQuerySiteinfo\appendExtensions(), EmailConfirmation\attemptConfirm(), SpecialUserLogin\beforeExecute(), Linker\blockLink(), SkinTemplate\buildContentNavigationUrls(), SkinTemplate\buildNavUrls(), SpecialEditWatchlist\buildRemoveLine(), SpecialEditWatchlist\buildTools(), MediaWiki\Auth\AuthManager\checkAccountCreatePermissions(), checkLoginSecurityLevel(), Title\checkReadPermissions(), ApiFormatBase\closePrinter(), DifferenceEngine\deletedLink(), SpecialTags\doTagRow(), Linker\emailLink(), TidyUpBug37714\execute(), ApiHelp\execute(), SpecialUserLogout\execute(), SpecialListGroupRights\execute(), ApiFeedContributions\execute(), SpecialBlockList\execute(), SpecialWatchlist\execute(), ApiFeedWatchlist\execute(), SpecialResetTokens\execute(), SpecialEditWatchlist\execute(), SpecialEditWatchlist\executeViewEditWatchlist(), OldChangesList\formatChangeLine(), UnusedtemplatesPage\formatResult(), ListDuplicatedFilesPage\formatResult(), DeletedContribsPager\formatRevisionRow(), BlockListPager\formatValue(), ContentModelLogFormatter\getActionLinks(), MergeLogFormatter\getActionLinks(), MoveLogFormatter\getActionLinks(), BlockLogFormatter\getActionLinks(), DeleteLogFormatter\getActionLinks(), RevDelArchivedFileItem\getApiData(), RevDelFileItem\getApiData(), PreferencesForm\getButtons(), InfoAction\getContributors(), HistoryAction\getDescription(), RevDelArchiveItem\getDiffLink(), ApiFeedRecentChanges\getFeedObject(), LoginSignupSpecialPage\getFieldDefinitions(), SpecialUnblock\getFields(), MWGrants\getGrantsLink(), SpecialStatistics\getGroupStats(), OutputPage\getHeadLinksArray(), ApiHelp\getHelpInternal(), ChangeTagsLogItem\getHTML(), RevDelLogItem\getHTML(), RevDelArchivedFileItem\getLink(), RevDelFileItem\getLink(), RCCacheEntryFactory\getLogLink(), ApiParamInfo\getModuleInfo(), SearchNearMatcher\getNearMatchInternal(), SpecialStatistics\getPageStats(), ManualLogEntry\getRecentChange(), SpecialMycontributions\getRedirect(), SpecialRedirectToSpecial\getRedirect(), SpecialMyuploads\getRedirect(), SpecialAllMyUploads\getRedirect(), RevDelArchiveItem\getRevisionLink(), Skin\getSearchLink(), LogEventsList\getShowHideLinks(), UploadStashFile\getSpecialUrl(), DeletedContributionsPage\getSubTitle(), MediaWiki\getTitle(), AllMessagesTablePager\getTitle(), ImageListPager\getTitle(), SpecialPageFactory\getTitleForAlias(), Skin\getUndeleteLink(), ImagePage\getUploadUrl(), Linker\getUploadUrl(), SpecialStatistics\getUserStats(), AuthManagerSpecialPage\handleReauthBeforeExecute(), ImageHistoryList\imageHistoryLine(), CreditsAction\link(), Parser\magicLinkCallback(), EnhancedChangesList\makeCacheGroupingKey(), MostlinkedPage\makeWlhLink(), WantedQueryPage\makeWlhLink(), MostlinkedTemplatesPage\makeWlhLink(), RecentChangesUpdateJob\newCacheUpdateJob(), RecentChangesUpdateJob\newPurgeJob(), MarkpatrolledAction\onView(), ImagePage\openShowImage(), SpecialListGroupRights\outputNamespaceProtectionInfo(), MediaStatisticsPage\outputTableRow(), InfoAction\pageInfo(), MediaWiki\parseTitle(), MediaWiki\performRequest(), SpecialBlock\postText(), SkinTemplate\prepareQuickTemplate(), Preferences\profilePreferences(), EnhancedChangesList\recentChangesBlockLine(), SpecialUndelete\redirectToRevDel(), UserNotLoggedIn\report(), Linker\revDeleteLink(), LogPage\saveContent(), UserMailer\sendInternal(), SpecialEditTags\showConvenienceLinks(), SpecialRevisionDelete\showConvenienceLinks(), EditPage\showHeader(), LogEventsList\showOptions(), OutputPage\showPermissionsErrorPage(), SpecialUpload\showUploadWarning(), SpecialUpload\showViewDeletedLinks(), CoreParserFunctions\special(), Linker\specialLink(), RevDelLogList\suggestTarget(), SpecialPageTest\testGetTitleFor(), SpecialPageTest\testGetTitleForWithWarning(), SpecialPageTest\testInvalidGetTitleFor(), LinkerTest\testLinkBeginHook(), LinkerTest\testLinkEndHook(), ExtraParserTest\testTrackingCategorySpecial(), MediaWiki\tryNormaliseRedirect(), ChangeTags\updateTagsWithChecks(), Linker\userLink(), Linker\userToolLinks(), and Preferences\watchlistPreferences().

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

static

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

Since: 1.28

Parameters

string	$name
string \| bool	$subpage	Subpage string, or false to not use a subpage
string	$fragment	The link fragment (after the "#")

Returns: TitleValue

Definition at line 97 of file SpecialPage.php.

References $name, SpecialPageFactory\getLocalNameFor(), and NS_SPECIAL.

Referenced by Linker\normaliseSpecialPage(), and InfoAction\pageInfo().

SpecialPage::getUser ( )

Shortcut to get the User executing this instance.

Returns: User

Since: 1.18

Definition at line 685 of file SpecialPage.php.

References getContext().

SpecialPage::including ( $x = null )

Whether the special page is being evaluated via transclusion.

Parameters

bool $x

Returns: bool

Definition at line 226 of file SpecialPage.php.

References wfSetVar().

Referenced by SpecialContributions\contributionsSub(), SpecialListFiles\execute(), SpecialNewFiles\execute(), SpecialApiHelp\execute(), SpecialContributions\execute(), WantedPagesPage\execute(), SpecialRecentChanges\execute(), SpecialWhatLinksHere\execute(), SpecialListUsers\execute(), ChangesListSpecialPage\execute(), SpecialPrefixindex\execute(), SpecialNewpages\execute(), msg(), SpecialRecentChanges\outputChangesList(), outputHeader(), SpecialAllPages\showChunk(), SpecialWhatLinksHere\showIndirectLinks(), SpecialPrefixindex\showPrefixChunk(), and ChangesListSpecialPage\webOutput().

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.

Returns: bool

Since: 1.21

Definition at line 263 of file SpecialPage.php.

SpecialPage::isExpensive ( )

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

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

Returns: bool

Definition at line 250 of file SpecialPage.php.

SpecialPage::isIncludable ( )

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

Returns: bool

Definition at line 196 of file SpecialPage.php.

References $mIncludable.

SpecialPage::isListed ( )

Whether this special page is listed in Special:SpecialPages.

Since: 1.3 (r3583)

Returns: bool

Definition at line 168 of file SpecialPage.php.

References $mListed.

SpecialPage::isRestricted ( )

Can be overridden by subclasses with more complicated permissions schemes.

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

Definition at line 274 of file SpecialPage.php.

References User\groupHasPermission().

SpecialPage::listed ( $x = null )

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

Since: 1.6

Parameters

bool $x

Returns: bool

Definition at line 188 of file SpecialPage.php.

References wfSetVar().

SpecialPage::maxIncludeCacheTime ( )

How long to cache page when it is being included.

Note: If cache time is not 0, then the current user becomes an anon if you want to do any per-user customizations, than this method must be overriden to return 0.

Since: 1.26

Returns: int Time in seconds, 0 to disable caching altogether, false to use the parent page's cache settings

Definition at line 210 of file SpecialPage.php.

References getCacheTTL(), and getConfig().

SpecialPage::msg ( )

Wrapper around wfMessage that sets the current context.

Since: 1.16

Returns: Message

See Also: wfMessage

Definition at line 746 of file SpecialPage.php.

References getContext(), and including().

SpecialPage::outputHeader ( $summaryMessageKey = '' )

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

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

Parameters

string $summaryMessageKey Message key of the summary

Definition at line 583 of file SpecialPage.php.

References $wgContLang, getName(), getOutput(), global, including(), and msg().

Referenced by SpecialRedirect\alterForm(), SpecialListFiles\execute(), SpecialNewFiles\execute(), SpecialSpecialpages\execute(), SpecialContributions\execute(), SpecialLog\execute(), SpecialProtectedtitles\execute(), SpecialUnlinkAccounts\execute(), SpecialCategories\execute(), SpecialPreferences\execute(), SpecialExport\execute(), SpecialLinkAccounts\execute(), SpecialUserLogout\execute(), SpecialProtectedpages\execute(), SpecialListGrants\execute(), SpecialListGroupRights\execute(), DeletedContributionsPage\execute(), SpecialPagesWithProp\execute(), SpecialBlockList\execute(), SpecialUnblock\execute(), SpecialWhatLinksHere\execute(), SpecialListUsers\execute(), SpecialActiveUsers\execute(), ChangesListSpecialPage\execute(), SpecialBookSources\execute(), SpecialAllMessages\execute(), SpecialComparePages\execute(), SpecialVersion\execute(), SpecialPrefixindex\execute(), SpecialTags\execute(), LinkSearchPage\execute(), SpecialTrackingCategories\execute(), SpecialAllPages\execute(), SpecialEditTags\execute(), SpecialImport\execute(), MovePageForm\execute(), SpecialChangeCredentials\execute(), SpecialEditWatchlist\execute(), UserrightsPage\execute(), FileDuplicateSearchPage\execute(), SpecialSearch\execute(), SpecialEmailUser\execute(), SpecialMergeHistory\execute(), SpecialRevisionDelete\execute(), SpecialNewpages\execute(), MIMEsearchPage\execute(), SpecialUpload\execute(), QueryPage\execute(), execute(), SpecialUndelete\execute(), and SpecialUploadStash\showUploads().

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

staticprotected

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

Since: 1.24

Parameters

string	$search
int	$limit
array	$subpages
int	$offset

Returns: string[]

Definition at line 475 of file SpecialPage.php.

References $limit.

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

protected

Perform a regular substring search for prefixSearchSubpages.

Parameters

string	$search	Prefix to search for
int	$limit	Maximum number of results to return (usually 10)
int	$offset	Number of results to skip (usually 0)

Returns: string[] Matching subpages

Definition at line 448 of file SpecialPage.php.

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

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

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

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

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

prefixSearchSubpages( "ba" ) should return array( "bar", "baz" )
prefixSearchSubpages( "f" ) should return array( "foo" )
prefixSearchSubpages( "z" ) should return array()
prefixSearchSubpages( "" ) should return array( foo", "bar", "baz" )

Parameters

string	$search	Prefix to search for
int	$limit	Maximum number of results to return (usually 10)
int	$offset	Number of results to skip (usually 0)

Returns: string[] Matching subpages

Definition at line 420 of file SpecialPage.php.

References $limit, and getSubpagesForPrefixSearch().

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 336 of file SpecialPage.php.

References getUser().

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

SpecialPage::run ( $subPage )

final

Entry point.

Since: 1.20

Parameters

string | null $subPage

Definition at line 505 of file SpecialPage.php.

References afterExecute(), beforeExecute(), execute(), and Hooks\run().

SpecialPage::setContext ( $context )

Sets the context this SpecialPage is executed in.

Parameters

IContextSource $context

Since: 1.18

Definition at line 638 of file SpecialPage.php.

References $context.

Referenced by SkinTemplate\buildNavUrls(), ApiQueryUsers\execute(), SpecialPageExecutor\executeSpecialPage(), and LoginSignupSpecialPage\setSessionUserForCurrentRequest().

SpecialPage::setHeaders ( )

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

Definition at line 484 of file SpecialPage.php.

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

Referenced by SpecialListFiles\execute(), SpecialNewFiles\execute(), SpecialApiSandbox\execute(), SpecialJavaScriptTest\execute(), SpecialBlankpage\execute(), SpecialSpecialpages\execute(), SpecialLog\execute(), SpecialContributions\execute(), SpecialProtectedtitles\execute(), SpecialCategories\execute(), SpecialUnlinkAccounts\execute(), SpecialPreferences\execute(), SpecialStatistics\execute(), SpecialExport\execute(), SpecialUserLogout\execute(), SpecialLinkAccounts\execute(), EmailInvalidation\execute(), SpecialProtectedpages\execute(), SpecialListGrants\execute(), SpecialListGroupRights\execute(), DeletedContributionsPage\execute(), SpecialBlockList\execute(), SpecialPagesWithProp\execute(), SpecialUnblock\execute(), SpecialListUsers\execute(), SpecialWhatLinksHere\execute(), ChangesListSpecialPage\execute(), SpecialActiveUsers\execute(), SpecialBookSources\execute(), SpecialAllMessages\execute(), EmailConfirmation\execute(), SpecialComparePages\execute(), SpecialVersion\execute(), SpecialPrefixindex\execute(), SpecialTags\execute(), LinkSearchPage\execute(), SpecialExpandTemplates\execute(), RandomPage\execute(), SpecialTrackingCategories\execute(), SpecialAllPages\execute(), SpecialEditTags\execute(), SpecialImport\execute(), MovePageForm\execute(), SpecialChangeCredentials\execute(), SpecialEditWatchlist\execute(), UserrightsPage\execute(), FileDuplicateSearchPage\execute(), SpecialSearch\execute(), SpecialEmailUser\execute(), SpecialMergeHistory\execute(), SpecialRevisionDelete\execute(), SpecialNewpages\execute(), MIMEsearchPage\execute(), FormSpecialPage\execute(), SpecialUpload\execute(), LoginSignupSpecialPage\execute(), QueryPage\execute(), execute(), SpecialUndelete\execute(), and SpecialUploadStash\showUploads().

SpecialPage::setLinkRenderer ( LinkRenderer $linkRenderer )

Since: 1.28

Parameters

\\MediaWiki\\Linker\\LinkRenderer $linkRenderer

Definition at line 868 of file SpecialPage.php.

References $linkRenderer.

SpecialPage::setListed ( $listed )

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

Since: 1.3

Parameters

bool $listed

Returns: bool

Definition at line 178 of file SpecialPage.php.

References wfSetVar().

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.

Parameters

User $user The user to check

Returns: bool Does the user have permission to view the page?

Definition at line 287 of file SpecialPage.php.

References User\isAllowed().

Referenced by checkPermissions(), DeletedContributionsPage\execute(), and QueryPage\execute().

SpecialPage::useTransactionalTimeLimit ( )

protected

Call wfTransactionalTimeLimit() if this request was POSTed.

Since: 1.26

Definition at line 846 of file SpecialPage.php.

References getRequest(), and wfTransactionalTimeLimit().

Referenced by SpecialImport\execute(), SpecialUploadStash\execute(), MovePageForm\execute(), SpecialMergeHistory\execute(), SpecialRevisionDelete\execute(), SpecialUpload\execute(), and SpecialUndelete\execute().

Member Data Documentation

IContextSource SpecialPage::$mContext

protected

Current request context.

Definition at line 61 of file SpecialPage.php.

Referenced by getContext().

SpecialPage::$mIncludable

protected

Definition at line 55 of file SpecialPage.php.

Referenced by isIncludable().

SpecialPage::$mIncluding

protected

Definition at line 52 of file SpecialPage.php.

SpecialPage::$mListed

private

Definition at line 49 of file SpecialPage.php.

Referenced by isListed().

SpecialPage::$mLocalName

private

Definition at line 42 of file SpecialPage.php.

Referenced by getLocalName().

SpecialPage::$mName

protected

Definition at line 39 of file SpecialPage.php.

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

SpecialPage::$mRestriction

protected

Definition at line 46 of file SpecialPage.php.

Referenced by getRestriction().

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

includes/specialpage/SpecialPage.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation