Redirect to the talk page of a given page. More...

Inherits MediaWiki\SpecialPage\FormSpecialPage.

Collaboration diagram for MediaWiki\Specials\Redirects\SpecialTalkPage:

[legend]

Public Member Functions

__construct (private readonly TitleParser $titleParser)

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.Since 1.45, returning a string from this method is no longer allowed.

Stability: stable: to override

Returns: Message

isListed ()

Whether this special page is listed in Special:SpecialPages.

Stability: stable: to override

Since: 1.3 (r3583)

Returns: bool

onSubmit (array $formData)

Process the form on submission.

Parameters

array	$data
HTMLForm \| null	$form

Returns: bool|string|array|Status As documented for HTMLForm::trySubmit.

requiresUnblock ()

Whether this action cannot be executed by a blocked user, default to requiresPost()

Returns: bool

requiresWrite ()

Whether this action requires the wiki not to be locked, default to requiresPost()

Returns: bool

Public Member Functions inherited from MediaWiki\SpecialPage\FormSpecialPage

execute ( $par)

Basic SpecialPage workflow: get a form, send it to the user; get some data back,.

onSuccess ()

Do something exciting on successful processing of the form, most likely to show a confirmation message.

requiresPost ()

Whether this action should using POST method to submit, default to true.

Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage

__construct ( $name='')

Default constructor for special pages Derivative classes should call this from their constructor.

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 POST requests to this special page require write access to the wiki.

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.

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, e.g.

getShortDescription (string $path='')

Similar to SpecialPage::getDescription, but takes into account subpages 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}}.

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', bool $alwaysRedirectToLoginPage=false)

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

Protected Member Functions
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.

	getDisplayFormat ()
	Get display format for the form.See HTMLForm documentation for available values. Since 1.25 Returns string

	getFormFields ()
	Get an HTMLForm descriptor array. Returns array

	getMessagePrefix ()
	Get message prefix for HTMLForm. Since 1.21 Returns string

Protected Member Functions inherited from MediaWiki\SpecialPage\FormSpecialPage
	checkExecutePermissions (User $user)
	Called from execute() to check if the given user can perform this action.

	getForm ()
	Get the HTMLForm to control behavior.

	getShowAlways ()
	Whether the form should always be shown despite the success of submission.

	getSubpageField ()
	Override this function to set the field name used in the subpage syntax.

	postHtml ()
	Add post-HTML to the form.

	preHtml ()
	Add pre-HTML to the form.

	setParameter ( $par)
	Maybe do something interesting with the subpage parameter.

	setReauthPostData (array $data)
	Preserve POST data across reauthentication.

Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after `execute`.

	authorizeAction (?string $action=null)
	Utility function for authorizing an action to be performed by the special page.

	beforeExecute ( $subPage)
	Gets called before `execute`.

	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!

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

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
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.

Static Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
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 inherited from MediaWiki\SpecialPage\FormSpecialPage
string null	$par = null
	The subpage of the special page.

array null	$reauthPostData = null
	POST data preserved across re-authentication.

Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage
IContextSource	$mContext
	Current request context.

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.

Detailed Description

Redirect to the talk page of a given page.

Definition at line 22 of file SpecialTalkPage.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\Redirects\SpecialTalkPage::__construct ( private readonly TitleParser $titleParser )

Definition at line 24 of file SpecialTalkPage.php.

Member Function Documentation

◆ alterForm()

MediaWiki\Specials\Redirects\SpecialTalkPage::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 40 of file SpecialTalkPage.php.

References MediaWiki\HTMLForm\HTMLForm\setMethod(), and MediaWiki\HTMLForm\HTMLForm\setSubmitTextMsg().

◆ getDescription()

MediaWiki\Specials\Redirects\SpecialTalkPage::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.Since 1.45, returning a string from this method is no longer allowed.

Stability: stable: to override

Returns: Message

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 99 of file SpecialTalkPage.php.

References MediaWiki\SpecialPage\SpecialPage\msg().

◆ getDisplayFormat()

MediaWiki\Specials\Redirects\SpecialTalkPage::getDisplayFormat ( )

protected

Get display format for the form.See HTMLForm documentation for available values.

Since: 1.25

Returns: string

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 71 of file SpecialTalkPage.php.

◆ getFormFields()

MediaWiki\Specials\Redirects\SpecialTalkPage::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Returns: array

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 29 of file SpecialTalkPage.php.

References MediaWiki\SpecialPage\FormSpecialPage\$par.

◆ getMessagePrefix()

MediaWiki\Specials\Redirects\SpecialTalkPage::getMessagePrefix ( )

protected

Get message prefix for HTMLForm.

Since: 1.21

Returns: string

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 94 of file SpecialTalkPage.php.

◆ isListed()

MediaWiki\Specials\Redirects\SpecialTalkPage::isListed ( )

Whether this special page is listed in Special:SpecialPages.

Stability: stable: to override

Since: 1.3 (r3583)

Returns: bool

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 89 of file SpecialTalkPage.php.

◆ onSubmit()

MediaWiki\Specials\Redirects\SpecialTalkPage::onSubmit ( array $formData )

Process the form on submission.

Parameters

array	$data
HTMLForm \| null	$form

Returns: bool|string|array|Status As documented for HTMLForm::trySubmit.

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 48 of file SpecialTalkPage.php.

References MediaWiki\SpecialPage\SpecialPage\getConfig(), MediaWiki\Title\MalformedTitleException\getMessageObject(), MediaWiki\SpecialPage\SpecialPage\getOutput(), and MediaWiki\MainConfigNames\ParserCacheExpireTime.

◆ requiresUnblock()

MediaWiki\Specials\Redirects\SpecialTalkPage::requiresUnblock ( )

Whether this action cannot be executed by a blocked user, default to requiresPost()

Returns: bool

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 81 of file SpecialTalkPage.php.

◆ requiresWrite()

MediaWiki\Specials\Redirects\SpecialTalkPage::requiresWrite ( )

Whether this action requires the wiki not to be locked, default to requiresPost()

Returns: bool

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 76 of file SpecialTalkPage.php.

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

includes/Specials/Redirects/SpecialTalkPage.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ getDescription()

◆ getDisplayFormat()

◆ getFormFields()

◆ getMessagePrefix()

◆ isListed()

◆ onSubmit()

◆ requiresUnblock()

◆ requiresWrite()