Parent class for all special pages. More...

Inherits MessageLocalizer.

Collaboration diagram for MediaWiki\SpecialPage\SpecialPage:

[legend]

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 name of this Special Page.

	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.

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

	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)

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

	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.

	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 Per 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 65 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	$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 211 of file SpecialPage.php.

Member Function Documentation

◆ addFeedLinks()

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

protected

Adds RSS/atom links.

Parameters

array $params

Definition at line 1018 of file SpecialPage.php.

References wfAppendQuery(), and wfScript().

Referenced by MediaWiki\Specials\SpecialContributions\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	$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 1036 of file SpecialPage.php.

◆ 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 756 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 744 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	$query	Optional URL query parameter string
bool	$atend	Optional param for specified if this is the last page
string \| false	$subpage	Optional param for specifying subpage

Returns: string

Definition at line 1143 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 $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 517 of file SpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\getAuthManager(), MediaWiki\SpecialPage\SpecialPage\getFullTitle(), MediaWiki\SpecialPage\SpecialPage\getName(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\getRequest(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), PROTO_HTTPS, MediaWiki\SpecialPage\SpecialPage\setReauthPostData(), wfArrayToCgi(), and wfMessage().

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

◆ checkPermissions()

MediaWiki\SpecialPage\SpecialPage::checkPermissions ( )

Checks if userCanExecute, and if not throws a PermissionsError.

Stability: stable: to override

Since: 1.19

Returns: void

Exceptions

PermissionsError

Reimplemented in MediaWiki\Specials\SpecialCreateAccount, and MediaWiki\Specials\SpecialUndelete.

Definition at line 404 of file SpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\displayRestrictionError(), MediaWiki\SpecialPage\SpecialPage\getUser(), and MediaWiki\SpecialPage\SpecialPage\userCanExecute().

◆ checkReadOnly()

MediaWiki\SpecialPage\SpecialPage::checkReadOnly ( )

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

Since: 1.19

Returns: void

Exceptions

ReadOnlyError

Definition at line 417 of file SpecialPage.php.

References MediaWiki\MediaWikiServices\getInstance().

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

Referenced by MediaWiki\SpecialPage\SpecialPage\checkPermissions(), and MediaWiki\Specials\SpecialUndelete\checkPermissions().

◆ doesWrites()

MediaWiki\SpecialPage\SpecialPage::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable: to override

Returns: bool

Since: 1.27

Definition at line 1084 of file SpecialPage.php.

◆ 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

Definition at line 770 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 639 of file SpecialPage.php.

◆ getAuthManager()

MediaWiki\SpecialPage\SpecialPage::getAuthManager ( )

finalprotected

Note: Call self::setAuthManager from special page constructor when using

Since: 1.36

Returns: AuthManager

Definition at line 584 of file SpecialPage.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ getAuthority()

MediaWiki\SpecialPage\SpecialPage::getAuthority ( )

Shortcut to get the Authority executing this instance.

Returns: Authority

Since: 1.36

Definition at line 911 of file SpecialPage.php.

◆ 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 303 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 966 of file SpecialPage.php.

References getContext().

◆ getContentLanguage()

MediaWiki\SpecialPage\SpecialPage::getContentLanguage ( )

final

Shortcut to get content language.

Returns: Language

Since: 1.36

Definition at line 941 of file SpecialPage.php.

◆ getContext()

MediaWiki\SpecialPage\SpecialPage::getContext ( )

Gets the context this SpecialPage is executed in.

Returns: IContextSource|RequestContext

Since: 1.18

Definition at line 865 of file SpecialPage.php.

References wfDebug().

◆ 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\SpecialCreateAccount, MediaWiki\Specials\SpecialDiff, MediaWiki\Specials\SpecialEditTags, MediaWiki\Specials\SpecialEmailUser, MediaWiki\Specials\SpecialMute, and MediaWiki\Specials\SpecialUserLogin.

Definition at line 815 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 1061 of file SpecialPage.php.

◆ getFullTitle()

MediaWiki\SpecialPage\SpecialPage::getFullTitle ( )

Return the full title, including $par.

Returns: Title

Since: 1.18

Definition at line 976 of file SpecialPage.php.

References getContext().

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

◆ 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

Definition at line 1098 of file SpecialPage.php.

◆ getHookContainer()

MediaWiki\SpecialPage\SpecialPage::getHookContainer ( )

protected

Since: 1.35

Returns: HookContainer

Definition at line 1184 of file SpecialPage.php.

Referenced by MediaWiki\Specials\SpecialActiveUsers\execute(), MediaWiki\Specials\SpecialDeletedContributions\execute(), MediaWiki\Specials\SpecialListUsers\execute(), MediaWiki\Specials\SpecialUpload\getInitialPageText(), MediaWiki\Specials\SpecialLog\getLogTypesOnUser(), MediaWiki\SpecialPage\QueryPage\getPages(), MediaWiki\Specials\SpecialUpload\getUploadForm(), and MediaWiki\Specials\SpecialSearch\showResults().

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

◆ getLanguage()

MediaWiki\SpecialPage\SpecialPage::getLanguage ( )

Shortcut to get user's language.

Returns: Language

Since: 1.19

Definition at line 931 of file SpecialPage.php.

References getContext().

◆ getLinkRenderer()

MediaWiki\SpecialPage\SpecialPage::getLinkRenderer ( )

Since: 1.28

Returns: LinkRenderer

Definition at line 1116 of file SpecialPage.php.

◆ getLocalName()

MediaWiki\SpecialPage\SpecialPage::getLocalName ( )

Get the localised name of the special page.

Stability: stable: to override

Returns: string

Definition at line 321 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 468 of file SpecialPage.php.

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

◆ getName()

MediaWiki\SpecialPage\SpecialPage::getName ( )

Get the name of this Special Page.

Returns: string

Reimplemented in MediaWiki\Specials\SpecialDiff.

Definition at line 225 of file SpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\$mName.

◆ getOutput()

MediaWiki\SpecialPage\SpecialPage::getOutput ( )

Get the OutputPage being used for this instance.

Returns: OutputPage

Since: 1.18

Definition at line 891 of file SpecialPage.php.

References getContext().

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

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

References getContext().

◆ getRestriction()

MediaWiki\SpecialPage\SpecialPage::getRestriction ( )

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

Returns: string

Definition at line 233 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 987 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	$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 182 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 830 of file SpecialPage.php.

◆ getSkin()

MediaWiki\SpecialPage\SpecialPage::getSkin ( )

Shortcut to get the skin being used for this instance.

Returns: Skin

Since: 1.18

Definition at line 921 of file SpecialPage.php.

References getContext().

◆ getSpecialPageFactory()

MediaWiki\SpecialPage\SpecialPage::getSpecialPageFactory ( )

finalprotected

Since: 1.36

Returns: SpecialPageFactory

Definition at line 1217 of file SpecialPage.php.

Referenced by MediaWiki\Specials\SpecialBlockList\execute(), MediaWiki\Specials\SpecialAutoblockList\getBlockListPager(), MediaWiki\Specials\SpecialBlockList\getBlockListPager(), and MediaWiki\SpecialPage\SpecialPage\getLocalName().

◆ 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 628 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	$subpage	Subpage string, or false/null to not use a subpage
string	$fragment	The link fragment (after the "#")

Returns: Title

Definition at line 153 of file SpecialPage.php.

◆ 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	$subpage	Subpage string, or false/null to not use a subpage
string	$fragment	The link fragment (after the "#")

Returns: TitleValue

Definition at line 168 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 901 of file SpecialPage.php.

References getContext().

◆ including()

MediaWiki\SpecialPage\SpecialPage::including ( $x = null )

Whether the special page is being evaluated via transclusion.

Parameters

bool | null $x

Returns: bool

Definition at line 312 of file SpecialPage.php.

References wfSetVar().

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

◆ isExpensive()

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

Stability: stable: to override

Returns: bool

Definition at line 338 of file SpecialPage.php.

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

References MediaWiki\SpecialPage\SpecialPage\$mIncludable.

◆ isListed()

MediaWiki\SpecialPage\SpecialPage::isListed ( )

Whether this special page is listed in Special:SpecialPages.

Stability: stable: to override

Since: 1.3 (r3583)

Returns: bool

Definition at line 245 of file SpecialPage.php.

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

References MediaWiki\MediaWikiServices\getInstance().

◆ listed()

MediaWiki\SpecialPage\SpecialPage::listed ( $x = null )

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

Since: 1.6

Deprecated: since 1.35 Set via subclassing UnlistedSpecialPage, get via isListed()

Parameters

bool | null $x

Returns: bool

Definition at line 270 of file SpecialPage.php.

References wfDeprecated(), and wfSetVar().

◆ 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 295 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 1000 of file SpecialPage.php.

References getContext().

◆ 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 $user Search page can be customized by user preference.

Returns: Title

Definition at line 126 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 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'

Stability: stable: to override

Parameters

string $summaryMessageKey Message key of the summary

Definition at line 790 of file SpecialPage.php.

◆ 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 683 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	$search	Prefix to search for
int	$limit	Maximum number of results to return (usually 10)
int	$offset	Number of results to skip (usually 0)
SearchEngineFactory \| null	$searchEngineFactory	Provide the service

Returns: string[] Matching subpages

Definition at line 652 of file SpecialPage.php.

References SearchEngineFactory\create(), and MediaWiki\MediaWikiServices\getInstance().

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 $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 610 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 436 of file SpecialPage.php.

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

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

◆ setAuthManager()

MediaWiki\SpecialPage\SpecialPage::setAuthManager ( AuthManager $authManager )

finalprotected

Set the injected AuthManager from the special page constructor.

Since: 1.36

Parameters

AuthManager $authManager

Definition at line 574 of file SpecialPage.php.

Referenced by MediaWiki\Specials\SpecialChangeCredentials\__construct(), MediaWiki\Specials\SpecialChangeEmail\__construct(), MediaWiki\Specials\SpecialCreateAccount\__construct(), MediaWiki\Specials\SpecialLinkAccounts\__construct(), MediaWiki\Specials\SpecialUnlinkAccounts\__construct(), MediaWiki\Specials\SpecialUserLogin\__construct(), and MediaWiki\Specials\SpecialBotPasswords\__construct().

◆ 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 957 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 855 of file SpecialPage.php.

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

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

References MediaWiki\MainConfigNames\UseMediaWikiUIEverywhere, and wfDeprecated().

◆ setHookContainer()

MediaWiki\SpecialPage\SpecialPage::setHookContainer ( HookContainer $hookContainer )

Since: 1.35

Access: internal

Parameters

HookContainer $hookContainer

Definition at line 1175 of file SpecialPage.php.

◆ setLinkRenderer()

MediaWiki\SpecialPage\SpecialPage::setLinkRenderer ( LinkRenderer $linkRenderer )

Since: 1.28

Parameters

LinkRenderer $linkRenderer

Definition at line 1129 of file SpecialPage.php.

◆ setListed()

MediaWiki\SpecialPage\SpecialPage::setListed ( $listed )

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

Since: 1.3

Deprecated: since 1.35

Parameters

bool $listed Set via subclassing UnlistedSpecialPage, get via isListed()

Returns: bool

Definition at line 257 of file SpecialPage.php.

References wfDeprecated(), and wfSetVar().

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

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

◆ setSpecialPageFactory()

MediaWiki\SpecialPage\SpecialPage::setSpecialPageFactory ( SpecialPageFactory $specialPageFactory )

final

Access: internal: For factory only

Since: 1.36

Parameters

SpecialPageFactory $specialPageFactory

Definition at line 1209 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 $user The 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 380 of file SpecialPage.php.

References MediaWiki\MediaWikiServices\getInstance().

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

◆ useTransactionalTimeLimit()

MediaWiki\SpecialPage\SpecialPage::useTransactionalTimeLimit ( )

protected

Call wfTransactionalTimeLimit() if this request was POSTed.

Since: 1.26

Definition at line 1106 of file SpecialPage.php.

References wfTransactionalTimeLimit().

Referenced by MediaWiki\Specials\SpecialImport\execute(), MediaWiki\Specials\SpecialMergeHistory\execute(), MediaWiki\Specials\SpecialMovePage\execute(), MediaWiki\Specials\SpecialRenameUser\execute(), MediaWiki\Specials\SpecialRevisionDelete\execute(), MediaWiki\Specials\SpecialUndelete\execute(), MediaWiki\Specials\SpecialUpload\execute(), and MediaWiki\Specials\SpecialUploadStash\execute().

Member Data Documentation

◆ $mContext

IContextSource MediaWiki\SpecialPage\SpecialPage::$mContext

protected

Current request context.

Definition at line 95 of file SpecialPage.php.

◆ $mIncludable

bool MediaWiki\SpecialPage\SpecialPage::$mIncludable

protected

Whether the special page can be included in an article.

Definition at line 89 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 86 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 71 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 80 of file SpecialPage.php.

Referenced by MediaWiki\SpecialPage\SpecialPage\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

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFeedLinks()

◆ addHelpLink()

◆ afterExecute()

◆ beforeExecute()

◆ buildPrevNextNavigation()

◆ checkLoginSecurityLevel()

◆ checkPermissions()

◆ checkReadOnly()

◆ displayRestrictionError()

◆ doesWrites()

◆ execute()

◆ getAssociatedNavigationLinks()

◆ getAuthManager()

◆ getAuthority()

◆ getCacheTTL()

◆ getConfig()

◆ getContentLanguage()

◆ getContext()

◆ getDescription()

◆ getFinalGroupName()

◆ getFullTitle()

◆ getGroupName()

◆ getHookContainer()

◆ getHookRunner()

◆ getLanguage()

◆ getLinkRenderer()

◆ getLocalName()

◆ getLoginSecurityLevel()

◆ getName()

◆ getOutput()

◆ getPageTitle()

◆ getRequest()

◆ getRestriction()

◆ getRobotPolicy()

◆ getSafeTitleFor()

◆ getShortDescription()

◆ getSkin()

◆ getSpecialPageFactory()

◆ getSubpagesForPrefixSearch()

◆ getTitleFor()

◆ getTitleValueFor()

◆ getUser()

◆ including()

◆ isCached()

◆ isExpensive()

◆ isIncludable()

◆ isListed()

◆ isRestricted()

◆ listed()

◆ maxIncludeCacheTime()

◆ msg()

◆ newSearchPage()

◆ outputHeader()

◆ prefixSearchArray()

◆ prefixSearchString()

◆ prefixSearchSubpages()

◆ requireLogin()

◆ requireNamedUser()

◆ run()

◆ setAuthManager()

◆ setContentLanguage()

◆ setContext()

◆ setHeaders()

◆ setHookContainer()

◆ setLinkRenderer()

◆ setListed()

◆ setReauthPostData()

◆ setSpecialPageFactory()

◆ userCanExecute()

◆ useTransactionalTimeLimit()

Member Data Documentation