Some internal bits split of from Skin.php. More...

Static Public Member Functions
static	accesskey ( $name, $localizer=null)
	Given the id of an interface element, constructs the appropriate accesskey attribute from the system messages.

static	blockLink ( $userId, $userText)

static	buildRollbackLink (RevisionRecord $revRecord, IContextSource $context=null, $editCount=false)
	Build a raw rollback link, useful for collections of "tool" links.

static	commentBlock ( $comment, $title=null, $local=false, $wikiId=null, $useParentheses=true)
	Wrap a comment in standard punctuation and formatting if it's non-empty, otherwise return empty string.

static	emailLink ( $userId, $userText)

static	expandLocalLinks (string $html)
	Helper function to expand local links.

static	formatComment ( $comment, $title=null, $local=false, $wikiId=null)
	This function is called by all recent changes variants, by the page history, and by the user contributions list.

static	formatHiddenCategories ( $hiddencats)
	Returns HTML for the "hidden categories on this page" list.

static	formatLinksInComment ( $comment, $title=null, $local=false, $wikiId=null)
	Formats wiki links and media links in text; all other wiki formatting is ignored.

static	formatRevisionSize ( $size)

static	generateRollback (RevisionRecord $revRecord, IContextSource $context=null, $options=[ 'verify'])
	Generate a rollback link for a given revision.

static	generateTOC ( $tree, Language $lang=null)
	Generate a table of contents from a section tree.

static	getImageLinkMTOParams ( $frameParams, $query='', $parser=null)
	Get the link parameters for MediaTransformOutput::toHtml() from given frame parameters supplied by the Parser.

static	getInvalidTitleDescription (IContextSource $context, $namespace, $title)
	Get a message saying that an invalid title was encountered.

static	getRevDeleteLink (Authority $performer, RevisionRecord $revRecord, LinkTarget $title)
	Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the settings on the revision.

static	getRevisionDeletedClass (RevisionRecord $revisionRecord)
	Returns css class of a deleted revision.

static	getRollbackEditCount (RevisionRecord $revRecord, $verify)
	This function will return the number of revisions which a rollback would revert and, if $verify is set it will verify that a revision can be reverted (that the user isn't the only contributor and the revision we might rollback to isn't deleted).

static	link ( $target, $html=null, $customAttribs=[], $query=[], $options=[])
	This function returns an HTML link to the given target.

static	linkKnown ( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
	Identical to link(), except $options defaults to 'known'.

static	makeBrokenImageLinkObj ( $title, $label='', $query='', $unused1='', $unused2='', $time=false, array $handlerParams=[], bool $currentExists=false)
	Make a "broken" link to an image.

static	makeExternalImage ( $url, $alt='')
	Return the code for images which were added via external links, via Parser::maybeMakeExternalImage().

static	makeExternalLink ( $url, $text, $escape=true, $linktype='', $attribs=[], $title=null)
	Make an external link.

static	makeHeadline ( $level, $attribs, $anchor, $html, $link, $fallbackAnchor=false)
	Create a headline for content.

static	makeImageLink (Parser $parser, LinkTarget $title, $file, $frameParams=[], $handlerParams=[], $time=false, $query='', $widthOption=null)
	Given parameters derived from [[Image:Foo\|options...]], generate the HTML that that syntax inserts in the page.

static	makeMediaLinkFile (LinkTarget $title, $file, $html='')
	Create a direct link to a given uploaded file.

static	makeMediaLinkObj ( $title, $html='', $time=false)
	Create a direct link to a given uploaded file.

static	makeSelfLinkObj ( $nt, $html='', $query='', $trail='', $prefix='')
	Make appropriate markup for a link to the current article.

static	makeThumbLink2 (LinkTarget $title, $file, $frameParams=[], $handlerParams=[], $time=false, $query='', array $classes=[], ?Parser $parser=null)

static	makeThumbLinkObj (LinkTarget $title, $file, $label='', $alt='', $align=null, $params=[], $framed=false, $manualthumb='')
	Make HTML for a thumbnail including image, border and caption.

static	normaliseSpecialPage (LinkTarget $target)

static	normalizeSubpageLink ( $contextTitle, $target, &$text)

static	processResponsiveImages ( $file, $thumb, $hp)
	Process responsive images: add 1.5x and 2x subimages to the thumbnail, where applicable.

static	revComment (RevisionRecord $revRecord, $local=false, $isPublic=false, $useParentheses=true)
	Wrap and format the given revision's comment block, if the current user is allowed to view it.

static	revDeleteLink ( $query=[], $restricted=false, $delete=true)
	Creates a (show/hide) link for deleting revisions/log entries.

static	revDeleteLinkDisabled ( $delete=true)
	Creates a dead (show/hide) link for deleting revisions/log entries.

static	revUserLink (RevisionRecord $revRecord, $isPublic=false)
	Generate a user link if the current user is allowed to view it.

static	revUserTools (RevisionRecord $revRecord, $isPublic=false, $useParentheses=true)
	Generate a user tool link cluster if the current user is allowed to view it.

static	specialLink ( $name, $key='')
	Make a link to a special page given its name and, optionally, a message key from the link text.

static	splitTrail ( $trail)
	Split a link trail, return the "inside" portion and the remainder of the trail as a two-element array.

static	titleAttrib ( $name, $options=null, array $msgParams=[], $localizer=null)
	Given the id of an interface element, constructs the appropriate title attribute from the system messages.

static	tocIndent ()
	Add another level to the Table of Contents.

static	tocLine ( $anchor, $tocline, $tocnumber, $level, $sectionIndex=false)
	parameter level defines if we are on an indentation level

static	tocLineEnd ()
	End a Table Of Contents line.

static	tocList ( $toc, Language $lang=null)
	Wraps the TOC in a div with ARIA navigation role and provides the hide/collapse JavaScript.

static	tocUnindent ( $level)
	Finish one or more sublevels on the Table of Contents.

static	tooltip ( $name, $options=null)
	Returns raw bits of HTML, use titleAttrib()

static	tooltipAndAccesskeyAttribs ( $name, array $msgParams=[], $options=null, $localizer=null, $user=null, $config=null, $relevantTitle=null)
	Returns the attributes for the tooltip and access key.

static	userLink ( $userId, $userName, $altUserName=false)
	Make user link (or user contributions for unregistered users)

static	userTalkLink ( $userId, $userText)

static	userToolLinks ( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null, $useParentheses=true)
	Generate standard user tool links (talk, contributions, block link, etc.)

static	userToolLinksRedContribs ( $userId, $userText, $edits=null, $useParentheses=true)
	Alias for userToolLinks( $userId, $userText, true );.

Public Attributes
const	TOOL_LINKS_EMAIL = 2

const	TOOL_LINKS_NOBLOCK = 1
	Flags for userToolLinks()

Static Public Attributes
static	$accesskeycache

Static Protected Member Functions
static	getUploadUrl ( $destFile, $query='')
	Get the URL to upload a certain file.

Detailed Description

Some internal bits split of from Skin.php.

These functions are used for primarily page content: links, embedded images, table of contents. Links are also used in the skin.

Todo: turn this into a legacy interface for HtmlPageLinkRenderer and similar services.

Definition at line 42 of file Linker.php.

Member Function Documentation

◆ accesskey()

static Linker::accesskey	(		$name,
			$localizer = null )

static

Given the id of an interface element, constructs the appropriate accesskey attribute from the system messages.

(Note, this is usually the id but isn't always, because sometimes the accesskey needs to go on a different element than the id, for reverse-compatibility, etc.)

Since: 1.16.3

Parameters

string	$name	Id of the element, minus prefixes.
MessageLocalizer \| null	$localizer

Returns: string|false Contents of the accesskey attribute (which you must HTML- escape), or false for no accesskey attribute

Definition at line 2128 of file Linker.php.

Referenced by DummyLinker\accesskey(), OOUIHTMLForm\getButtons(), EditPage\getEditButtons(), and HTMLFormField\getTooltipAndAccessKeyOOUI().

◆ blockLink()

static Linker::blockLink	(		$userId,
			$userText )

static

Since: 1.16.3

Parameters

int	$userId
string	$userText	User name in database.

Returns: string HTML fragment with block link

Definition at line 1276 of file Linker.php.

References SpecialPage\getTitleFor(), link(), wfDebug(), and wfMessage().

Referenced by DummyLinker\blockLink(), and userToolLinks().

◆ buildRollbackLink()

static Linker::buildRollbackLink	(	RevisionRecord	$revRecord,
		IContextSource	$context = null,
			$editCount = false )

static

Build a raw rollback link, useful for collections of "tool" links.

Since: 1.16.3. $context added in 1.20. $editCount added in 1.21 $rev could be a RevisionRecord since 1.35

Todo: Unused outside of this file - should it be made private?

Parameters

RevisionRecord	$revRecord	(Switched from the old Revision class to RevisionRecord since 1.35)
IContextSource \| null	$context	Context to use or null for the main context.
int \| false \| null	$editCount	Number of edits that would be reverted

Returns: string HTML fragment

Definition at line 1962 of file Linker.php.

References $title, MediaWiki\Revision\RevisionRecord\getPageAsLinkTarget(), MediaWiki\Revision\RevisionRecord\getUser(), and Message\numParam().

Referenced by DummyLinker\buildRollbackLink().

◆ commentBlock()

static Linker::commentBlock	(	$comment,
		$title = null,
		$local = false,
		$wikiId = null,
		$useParentheses = true )

static

Wrap a comment in standard punctuation and formatting if it's non-empty, otherwise return empty string.

This method produces HTML that requires CSS styles in mediawiki.interface.helpers.styles.

Since: 1.16.3. $wikiId added in 1.26

Deprecated: since 1.38 use CommentFormatter

Parameters

string	$comment
LinkTarget \| null	$title	LinkTarget object (to generate link to section in autocomment) or null
bool	$local	Whether section links should refer to local page
string \| null	$wikiId	Id (as used by WikiMap) of the wiki to generate links to. For use with external changes.
bool	$useParentheses	Whether the comment is wrapped in parentheses

Returns: string

Definition at line 1585 of file Linker.php.

References $title.

Referenced by DummyLinker\commentBlock(), LogFormatter\getComment(), RevDelFileItem\getComment(), and McrUndoAction\getFormFields().

◆ emailLink()

static Linker::emailLink	(		$userId,
			$userText )

static

Parameters

int	$userId
string	$userText	User name in database.

Returns: string HTML fragment with e-mail user link

Definition at line 1297 of file Linker.php.

References SpecialPage\getTitleFor(), link(), wfLogWarning(), and wfMessage().

Referenced by DummyLinker\emailLink(), and userToolLinks().

◆ expandLocalLinks()

static Linker::expandLocalLinks ( string $html )

static

Helper function to expand local links.

Mostly used in action=render

Since: 1.38

Stability: unstable

Parameters

string $html

Returns: string HTML

Definition at line 1414 of file Linker.php.

References PROTO_RELATIVE, and wfExpandUrl().

Referenced by ParserOutput\getText(), and DifferenceEngine\showDiff().

◆ formatComment()

static Linker::formatComment	(	$comment,
		$title = null,
		$local = false,
		$wikiId = null )

static

This function is called by all recent changes variants, by the page history, and by the user contributions list.

It is responsible for formatting edit summaries. It escapes any HTML in the summary, but adds some CSS to format auto-generated comments (from section editing) and formats [[wikilinks]].

This method produces HTML that can require CSS styles in mediawiki.interface.helpers.styles.

Since: 1.16.3. $wikiId added in 1.26

Deprecated: since 1.38 use CommentFormatter

Parameters

string	$comment
LinkTarget \| null	$title	LinkTarget object (to generate link to the section in autocomment) or null
bool	$local	Whether section links should refer to local page
string \| null	$wikiId	Id (as used by WikiMap) of the wiki to generate links to. For use with external changes.

Returns: string HTML

Definition at line 1449 of file Linker.php.

References $title.

Referenced by BenchmarkCommentFormatter\execute(), ApiQueryRevisionsBase\extractRevisionInfo(), DummyLinker\formatComment(), FeedUtils\formatDiff(), ImageListPager\formatValue(), and ApiQueryImageInfo\getInfo().

◆ formatHiddenCategories()

static Linker::formatHiddenCategories ( $hiddencats )

static

Returns HTML for the "hidden categories on this page" list.

Since: 1.16.3

Parameters

array $hiddencats Array of hidden categories from WikiPage::getHiddenCategories or similar

Returns: string HTML output

Definition at line 2035 of file Linker.php.

References wfMessage().

Referenced by DummyLinker\formatHiddenCategories(), InfoAction\pageInfo(), and EditPage\showEditForm().

◆ formatLinksInComment()

static Linker::formatLinksInComment	(	$comment,
		$title = null,
		$local = false,
		$wikiId = null )

static

Formats wiki links and media links in text; all other wiki formatting is ignored.

Since: 1.16.3. $wikiId added in 1.26

Deprecated: since 1.38 use CommentFormatter

Parameters

string	$comment	Text to format links in. WARNING! Since the output of this function is html, $comment must be sanitized for use as html. You probably want to pass $comment through Sanitizer::escapeHtmlAllowEntities() before calling this function.
LinkTarget \| null	$title	An optional LinkTarget object used to links to sections
bool	$local	Whether section links should refer to local page
string \| null	$wikiId	Id of the wiki to link to (if not the local wiki), as used by WikiMap.

Returns: string HTML; -taint onlysafefor_html

Definition at line 1475 of file Linker.php.

References $title.

Referenced by DummyLinker\formatLinksInComment().

◆ formatRevisionSize()

static Linker::formatRevisionSize ( $size )

static

Since: 1.16.3

Parameters

int $size

Returns: string

Definition at line 1623 of file Linker.php.

References wfMessage().

Referenced by SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), DummyLinker\formatRevisionSize(), ContribsPager\formatRow(), and ProtectedPagesPager\formatValue().

◆ generateRollback()

static Linker::generateRollback	(	RevisionRecord	$revRecord,
		IContextSource	$context = null,
			$options = [ 'verify' ] )

static

Generate a rollback link for a given revision.

Currently it's the caller's responsibility to ensure that the revision is the top one. If it's not, of course, the user will get an error message.

If the calling page is called with the parameter &bot=1, all rollback links also get that parameter. It causes the edit itself and the rollback to be marked as "bot" edits. Bot edits are hidden by default from recent changes, so this allows sysops to combat a busy vandal without bothering other users.

If the option verify is set this function will return the link only in case the revision can be reverted. Please note that due to performance limitations it might be assumed that a user isn't the only contributor of a page while (s)he is, which will lead to useless rollback links. Furthermore this wont work if $wgShowRollbackEditCount is disabled, so this can only function as an additional check.

If the option noBrackets is set the rollback link wont be enclosed in "[]".

Since: 1.16.3. $context added in 1.20. $options added in 1.21 $rev could be a RevisionRecord since 1.35

Parameters

RevisionRecord	$revRecord	(Switched from the old Revision class to RevisionRecord since 1.35)
IContextSource \| null	$context	Context to use or null for the main context.
array	$options

Returns: string

Definition at line 1834 of file Linker.php.

Referenced by ContribsPager\formatRow(), DummyLinker\generateRollback(), ChangesList\insertRollback(), and DifferenceEngine\showDiffPage().

◆ generateTOC()

static Linker::generateTOC	(		$tree,
		Language	$lang = null )

static

Generate a table of contents from a section tree.

Since: 1.16.3. $lang added in 1.17

Parameters

array[]	$tree	Return value of ParserOutput::getSections()
Language \| null	$lang	Language for the toc title, defaults to user language

Returns: string HTML fragment

Definition at line 1737 of file Linker.php.

References $lang.

Referenced by DummyLinker\generateTOC(), and ApiHelp\getHelp().

◆ getImageLinkMTOParams()

static Linker::getImageLinkMTOParams	(	$frameParams,
		$query = '',
		$parser = null )

static

Get the link parameters for MediaTransformOutput::toHtml() from given frame parameters supplied by the Parser.

Parameters

array	$frameParams	The frame parameters
string	$query	An optional query string to add to description page links
Parser \| null	$parser

Returns: array

Definition at line 551 of file Linker.php.

Referenced by makeImageLink(), makeThumbLink2(), and TraditionalImageGallery\toHTML().

◆ getInvalidTitleDescription()

static Linker::getInvalidTitleDescription	(	IContextSource	$context,
			$namespace,
			$title )

static

Get a message saying that an invalid title was encountered.

This should be called after a method like Title::makeTitleSafe() returned a value indicating that the title object is invalid.

Parameters

IContextSource	$context	Context to use to get the messages
int	$namespace	Namespace number
string	$title	Text of the title, without the namespace part

Returns: string

Definition at line 189 of file Linker.php.

References $title, MessageLocalizer\msg(), and NS_MAIN.

Referenced by SpecialFewestRevisions\formatResult(), SpecialMostCategories\formatResult(), SpecialMostInterwikis\formatResult(), SpecialMostLinked\formatResult(), SpecialMostLinkedCategories\formatResult(), SpecialMostLinkedTemplates\formatResult(), SpecialShortPages\formatResult(), SpecialUnwatchedPages\formatResult(), PageQueryPage\formatResult(), SpecialProtectedtitles\formatRow(), ProtectedPagesPager\formatValue(), and DummyLinker\getInvalidTitleDescription().

◆ getRevDeleteLink()

static Linker::getRevDeleteLink	(	Authority	$performer,
		RevisionRecord	$revRecord,
		LinkTarget	$title )

static

Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the settings on the revision.

Will use forward-compatible revision ID in the Special:RevDelete link if possible, otherwise the timestamp-based ID which may break after undeletion.

Parameters

Authority	$performer
RevisionRecord	$revRecord	(Switched from the old Revision class to RevisionRecord since 1.35)
LinkTarget	$title

Returns: string HTML fragment

Definition at line 2153 of file Linker.php.

References $title, MediaWiki\Revision\RevisionRecord\getId(), MediaWiki\Revision\RevisionRecord\getTimestamp(), MediaWiki\Revision\RevisionRecord\getVisibility(), MediaWiki\Permissions\Authority\isAllowed(), MediaWiki\Revision\RevisionRecord\isDeleted(), and MediaWiki\Revision\RevisionRecord\userCan().

Referenced by ContribsPager\formatRow(), DummyLinker\getRevDeleteLink(), and Article\setOldSubtitle().

◆ getRevisionDeletedClass()

static Linker::getRevisionDeletedClass ( RevisionRecord $revisionRecord )

static

Returns css class of a deleted revision.

Parameters

RevisionRecord $revisionRecord

Returns: string 'history-deleted', 'mw-history-suppressed' added if suppressed too

Since: 1.37

Definition at line 1351 of file Linker.php.

Referenced by SpecialMergeHistory\formatRevisionRow(), ChangeTagsRevisionItem\getHTML(), RevDelRevisionItem\getHTML(), RevisionItem\getHTML(), DifferenceEngine\getRevisionHeader(), ChangesList\revDateLink(), and revUserLink().

◆ getRollbackEditCount()

static Linker::getRollbackEditCount	(	RevisionRecord	$revRecord,
			$verify )

static

This function will return the number of revisions which a rollback would revert and, if $verify is set it will verify that a revision can be reverted (that the user isn't the only contributor and the revision we might rollback to isn't deleted).

These checks can only function as an additional check as this function only checks against the last $wgShowRollbackEditCount edits.

Returns null if $wgShowRollbackEditCount is disabled or false if $verify is set and the user is the only contributor of the page.

Todo: Unused outside of this file - should it be made private?

Parameters

RevisionRecord	$revRecord	(Switched from the old Revision class to RevisionRecord since 1.35)
bool	$verify	Try to verify that this revision can really be rolled back

Returns: int|false|null

Definition at line 1893 of file Linker.php.

References $dbr, $res, $revQuery, DB_REPLICA, MediaWiki\Revision\RevisionRecord\getPageId(), MediaWiki\Revision\RevisionRecord\getUser(), and wfGetDB().

Referenced by DummyLinker\getRollbackEditCount().

◆ getUploadUrl()

static Linker::getUploadUrl	(		$destFile,
			$query = '' )

staticprotected

Get the URL to upload a certain file.

Since: 1.16.3

Parameters

LinkTarget	$destFile	LinkTarget object of the file to upload
string	$query	Urlencoded query string to prepend

Returns: string Urlencoded URL

Definition at line 943 of file Linker.php.

References SpecialPage\getTitleFor(), and wfAppendQuery().

Referenced by makeMediaLinkFile().

◆ link()

static Linker::link	(	$target,
		$html = null,
		$customAttribs = [],
		$query = [],
		$options = [] )

static

This function returns an HTML link to the given target.

It serves a few purposes: 1) If $target is a LinkTarget, the correct URL to link to will be figured out automatically. 2) It automatically adds the usual classes for various types of link targets: "new" for red links, "stub" for short articles, etc. 3) It escapes all attribute values safely so there's no risk of XSS. 4) It provides a default tooltip if the target is a LinkTarget (the page name of the target). link() replaces the old functions in the makeLink() family.

Since: 1.18 Method exists since 1.16 as non-static, made static in 1.18.

Deprecated: since 1.28, use MediaWiki\Linker\LinkRenderer instead

Parameters

LinkTarget	$target	Can currently only be a LinkTarget, but this may change to support Images, literal URLs, etc.
string \| null	$html	The HTML contents of the element, i.e., the link text. This is raw HTML and will not be escaped. If null, defaults to the prefixed text of the LinkTarget; or if the LinkTarget is just a fragment, the contents of the fragment.
array	$customAttribs	A key => value array of extra HTML attributes, such as title and class. (href is ignored.) Classes will be merged with the default classes, while other attributes will replace default attributes. All passed attribute values will be HTML-escaped. A false attribute value means to suppress that attribute.
array	$query	The query string to append to the URL you're linking to, in key => value array form. Query keys and values will be URL-encoded.
string \| array	$options	String or array of strings: 'known': Page is known to exist, so don't check if it does. 'broken': Page is known not to exist, so don't check if it does. 'noclasses': Don't add any classes automatically (includes "new", "stub", "mw-redirect", "extiw"). Only use the class attribute provided, if any, so you get a simple blue link with no funny i- cons. 'forcearticlepath': Use the article path always, even with a querystring. Has compatibility issues on some setups, so avoid wherever possible. 'http': Force a full URL with http:// as the scheme. 'https': Force a full URL with https:// as the scheme.

Returns: string HTML attribute

Definition at line 91 of file Linker.php.

References wfWarn().

Referenced by blockLink(), emailLink(), DummyLinker\link(), linkKnown(), makeBrokenImageLinkObj(), makeImageLink(), userLink(), userTalkLink(), and userToolLinks().

◆ linkKnown()

static Linker::linkKnown	(	$target,
		$html = null,
		$customAttribs = [],
		$query = [],
		$options = [ 'known' ] )

static

Identical to link(), except $options defaults to 'known'.

Since: 1.16.3

Deprecated: since 1.28, use MediaWiki\Linker\LinkRenderer instead

See also: Linker::link

Parameters

LinkTarget	$target
string \| null	$html
array	$customAttribs
array	$query
string \| array	$options

Returns: string

Definition at line 143 of file Linker.php.

References link().

Referenced by DummyLinker\linkKnown(), and specialLink().

◆ makeBrokenImageLinkObj()

static Linker::makeBrokenImageLinkObj	(		$title,
			$label = '',
			$query = '',
			$unused1 = '',
			$unused2 = '',
			$time = false,
		array	$handlerParams = [],
		bool	$currentExists = false )

static

Make a "broken" link to an image.

Since: 1.16.3

Parameters

LinkTarget	$title
string	$label	Link label (plain text)
string	$query	Query string
string	$unused1	Unused parameter kept for b/c
string	$unused2	Unused parameter kept for b/c
bool	$time	A file of a certain timestamp was requested
array	$handlerParams

Since: 1.36

Parameters

bool $currentExists

Returns: string

Definition at line 870 of file Linker.php.

References $title, link(), NS_FILE, wfCgiToArray(), and wfWarn().

Referenced by DummyLinker\makeBrokenImageLinkObj(), makeImageLink(), makeThumbLink2(), and TraditionalImageGallery\toHTML().

◆ makeExternalImage()

static Linker::makeExternalImage	(		$url,
			$alt = '' )

static

Return the code for images which were added via external links, via Parser::maybeMakeExternalImage().

Since: 1.16.3

Parameters

string	$url
string	$alt

Returns: string

Definition at line 244 of file Linker.php.

References $success, and wfDebug().

Referenced by DummyLinker\makeExternalImage().

◆ makeExternalLink()

static Linker::makeExternalLink	(	$url,
		$text,
		$escape = true,
		$linktype = '',
		$attribs = [],
		$title = null )

static

Make an external link.

Since: 1.16.3. $title added in 1.21

Parameters

string	$url	URL to link to
-taint	$url	escapes_html
string	$text	Text of link
-taint	$text	escapes_html
bool	$escape	Do we escape the link text?
-taint	$escape	none
string	$linktype	Type of external link. Gets added to the classes
-taint	$linktype	escapes_html
array	$attribs	Array of extra attributes to
-taint	$attribs	escapes_html
LinkTarget \| null	$title	LinkTarget object used for title specific link attributes
-taint	$title	none

Returns: string

Definition at line 1061 of file Linker.php.

References $success, $title, $wgTitle, Parser\getExternalLinkRel(), and wfDebug().

Referenced by SpecialLinkSearch\formatResult(), AllMessagesTablePager\formatValue(), Skin\getCopyright(), SpecialVersion\getCreditsForExtension(), SpecialVersion\getExternalLibraries(), SpecialVersion\getParserFunctionHooks(), SpecialVersion\getParserTags(), ImagePage\imageDupes(), DummyLinker\makeExternalLink(), WikiMap\makeForeignLink(), Article\showRedirectedFromHeader(), and ImagePage\uploadLinksBox().

◆ makeHeadline()

static Linker::makeHeadline	(	$level,
		$attribs,
		$anchor,
		$html,
		$link,
		$fallbackAnchor = false )

static

Create a headline for content.

Since: 1.16.3

Parameters

int	$level	The level of the headline (1-6)
string	$attribs	Any attributes for the headline, starting with a space and ending with '>' This must be at least '>' for no attribs
string	$anchor	The anchor to give the headline (the bit after the #)
string	$html	HTML for the text of the header
string	$link	HTML to add for the section edit link
string \| false	$fallbackAnchor	A second, optional anchor to give for backward compatibility (false to omit)

Returns: string HTML headline

Definition at line 1775 of file Linker.php.

References $fallback.

Referenced by DummyLinker\makeHeadline(), and ApiMain\modifyHelp().

◆ makeImageLink()

static Linker::makeImageLink	(	Parser	$parser,
		LinkTarget	$title,
			$file,
			$frameParams = [],
			$handlerParams = [],
			$time = false,
			$query = '',
			$widthOption = null )

static

Given parameters derived from [[Image:Foo|options...]], generate the HTML that that syntax inserts in the page.

Parameters

Parser	$parser
LinkTarget	$title	LinkTarget object of the file (not the currently viewed page)
File \| false	$file	File object, or false if it doesn't exist
array	$frameParams	Associative array of parameters external to the media handler. Boolean parameters are indicated by presence or absence, the value is arbitrary and will often be false. thumbnail If present, downscale and frame manualthumb Image name to use as a thumbnail, instead of automatic scaling framed Shows image in original size in a frame frameless Downscale but don't frame upright If present, tweak default sizes for portrait orientation upright_factor Fudge factor for "upright" tweak (default 0.75) border If present, show a border around the image align Horizontal alignment (left, right, center, none) valign Vertical alignment (baseline, sub, super, top, text-top, middle, bottom, text-bottom) alt Alternate text for image (i.e. alt attribute). Plain text. title Used for tooltips if caption isn't visible. class HTML for image classes. Plain text. caption HTML for image caption. link-url URL to link to link-title LinkTarget object to link to link-target Value for the target attribute, only with link-url no-link Boolean, suppress description link
array	$handlerParams	Associative array of media handler parameters, to be passed to transform(). Typical keys are "width" and "page". targetlang (optional) Target language code, see Parser::getTargetLanguage()
string \| false	$time	Timestamp of the file, set as false for current
string	$query	Query params for desc url
int \| null	$widthOption	Used by the parser to remember the user preference thumbnailsize

Since: 1.20

Returns: string HTML for an image, with links, wrappers, etc.

Definition at line 301 of file Linker.php.

References $file, $res, $s, $title, Parser\getBadFileLookup(), getImageLinkMTOParams(), Parser\getTargetLanguage(), Parser\getTitle(), link(), makeBrokenImageLinkObj(), makeThumbLink2(), processResponsiveImages(), wfDebug(), and wfMessage().

Referenced by Parser\makeImage(), and DummyLinker\makeImageLink().

◆ makeMediaLinkFile()

static Linker::makeMediaLinkFile	(	LinkTarget	$title,
			$file,
			$html = '' )

static

Create a direct link to a given uploaded file.

This will make a broken link if $file is false.

Since: 1.16.3

Parameters

LinkTarget	$title
File \| false	$file	File object or false
string	$html	Pre-sanitized HTML

Returns: string HTML

Todo: Handle invalid or missing images better.

Definition at line 993 of file Linker.php.

References $file, $title, getUploadUrl(), and wfDebug().

Referenced by DummyLinker\makeMediaLinkFile(), and makeMediaLinkObj().

◆ makeMediaLinkObj()

static Linker::makeMediaLinkObj	(	$title,
		$html = '',
		$time = false )

static

Create a direct link to a given uploaded file.

Since: 1.16.3

Parameters

LinkTarget	$title
string	$html	Pre-sanitized HTML
string \| false	$time	MW timestamp of file creation time

Returns: string HTML

Definition at line 974 of file Linker.php.

References $title, and makeMediaLinkFile().

Referenced by SpecialMIMESearch\formatResult(), and DummyLinker\makeMediaLinkObj().

◆ makeSelfLinkObj()

static Linker::makeSelfLinkObj	(	$nt,
		$html = '',
		$query = '',
		$trail = '',
		$prefix = '' )

static

Make appropriate markup for a link to the current article.

This is since MediaWiki 1.29.0 rendered as an tag without an href and with a class showing the link text. The calling sequence is the same as for the other make*LinkObj static functions, but $query is not used.

Since: 1.16.3

Parameters

LinkTarget	$nt
string	$html
string	$query
string	$trail
string	$prefix

Returns: string

Definition at line 165 of file Linker.php.

References splitTrail().

Referenced by DummyLinker\makeSelfLinkObj(), and LinkHolderArray\replaceInternal().

◆ makeThumbLink2()

static Linker::makeThumbLink2	(	LinkTarget	$title,
			$file,
			$frameParams = [],
			$handlerParams = [],
			$time = false,
			$query = '',
		array	$classes = [],
		?Parser	$parser = null )

static

Parameters

LinkTarget	$title
File \| false	$file
array	$frameParams
array	$handlerParams
bool	$time
string	$query
string[]	$classes

Since: 1.36

Parameters

Parser | null $parser

Since: 1.38

Returns: string

Definition at line 627 of file Linker.php.

References $file, $s, $title, getImageLinkMTOParams(), makeBrokenImageLinkObj(), NS_FILE, processResponsiveImages(), wfAppendQuery(), and wfMessage().

Referenced by makeImageLink(), DummyLinker\makeThumbLink2(), and makeThumbLinkObj().

◆ makeThumbLinkObj()

static Linker::makeThumbLinkObj	(	LinkTarget	$title,
			$file,
			$label = '',
			$alt = '',
			$align = null,
			$params = [],
			$framed = false,
			$manualthumb = '' )

static

Make HTML for a thumbnail including image, border and caption.

Parameters

LinkTarget	$title
File \| false	$file	File object or false if it doesn't exist
string	$label
string	$alt
string \| null	$align
array	$params
bool	$framed
string	$manualthumb

Returns: string

Definition at line 594 of file Linker.php.

References $file, $title, and makeThumbLink2().

Referenced by DummyLinker\makeThumbLinkObj(), and ImagePage\openShowImage().

◆ normaliseSpecialPage()

static Linker::normaliseSpecialPage ( LinkTarget $target )

static

Since: 1.16.3

Deprecated: since 1.35, use LinkRenderer::normalizeTarget()

Parameters

LinkTarget $target

Returns: LinkTarget

Definition at line 210 of file Linker.php.

References wfDeprecated().

◆ normalizeSubpageLink()

static Linker::normalizeSubpageLink	(		$contextTitle,
			$target,
		&	$text )

static

Parameters

LinkTarget \| null	$contextTitle
string	$target
string	&$text

Returns: string

Definition at line 1488 of file Linker.php.

Referenced by Parser\braceSubstitution(), and DummyLinker\normalizeSubpageLink().

◆ processResponsiveImages()

static Linker::processResponsiveImages	(	$file,
		$thumb,
		$hp )

static

Process responsive images: add 1.5x and 2x subimages to the thumbnail, where applicable.

Parameters

File	$file
MediaTransformOutput \| null	$thumb
array	$hp	Image parameters

Definition at line 833 of file Linker.php.

References $file.

Referenced by MediaWiki\Parser\Parsoid\Config\DataAccess\getFileInfo(), ApiQueryImageInfo\getInfo(), makeImageLink(), makeThumbLink2(), ImagePage\openShowImage(), DummyLinker\processResponsiveImages(), and TraditionalImageGallery\toHTML().

◆ revComment()

static Linker::revComment	(	RevisionRecord	$revRecord,
			$local = false,
			$isPublic = false,
			$useParentheses = true )

static

Wrap and format the given revision's comment block, if the current user is allowed to view it.

This method produces HTML that requires CSS styles in mediawiki.interface.helpers.styles.

Since: 1.16.3

Deprecated: since 1.38 use CommentFormatter

Parameters

RevisionRecord	$revRecord	(Switched from the old Revision class to RevisionRecord since 1.35)
bool	$local	Whether section links should refer to local page
bool	$isPublic	Show only if all users can see it
bool	$useParentheses	(optional) Wrap comments in parentheses where needed

Returns: string HTML fragment

Definition at line 1607 of file Linker.php.

Referenced by SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), SpecialNewpages\formatRow(), ChangeTagsRevisionItem\getHTML(), RevDelRevisionItem\getHTML(), RevisionItem\getHTML(), DummyLinker\revComment(), Article\setOldSubtitle(), and DifferenceEngine\showDiffPage().

◆ revDeleteLink()

static Linker::revDeleteLink	(	$query = [],
		$restricted = false,
		$delete = true )

static

Creates a (show/hide) link for deleting revisions/log entries.

This method produces HTML that requires CSS styles in mediawiki.interface.helpers.styles.

Parameters

array	$query	Query parameters to be passed to link()
bool	$restricted	Set to true to use a "<strong>" instead of a "<span>"
bool	$delete	Set to true to use (show/hide) rather than (show)

Returns: string HTML "<a>" link to Special:Revisiondelete, wrapped in a span to allow for customization of appearance with CSS

Definition at line 2205 of file Linker.php.

References SpecialPage\getTitleFor(), and wfMessage().

Referenced by ImageHistoryList\imageHistoryLine(), and DummyLinker\revDeleteLink().

◆ revDeleteLinkDisabled()

static Linker::revDeleteLinkDisabled ( $delete = true )

static

Creates a dead (show/hide) link for deleting revisions/log entries.

This method produces HTML that requires CSS styles in mediawiki.interface.helpers.styles.

Since: 1.16.3

Parameters

bool $delete Set to true to use (show/hide) rather than (show)

Returns: string HTML text wrapped in a span to allow for customization of appearance with CSS

Definition at line 2229 of file Linker.php.

References wfMessage().

Referenced by ImageHistoryList\imageHistoryLine(), and DummyLinker\revDeleteLinkDisabled().

◆ revUserLink()

static Linker::revUserLink	(	RevisionRecord	$revRecord,
			$isPublic = false )

static

Generate a user link if the current user is allowed to view it.

This method produces HTML that requires CSS styles in mediawiki.interface.helpers.styles.

Since: 1.16.3

Parameters

RevisionRecord	$revRecord	(Switched from the old Revision class to RevisionRecord since 1.35)
bool	$isPublic	Show only if all users can see it

Returns: string HTML fragment

Definition at line 1323 of file Linker.php.

References getRevisionDeletedClass(), MediaWiki\Revision\RevisionRecord\getUser(), MediaWiki\Revision\RevisionRecord\isDeleted(), MediaWiki\Revision\RevisionRecord\userCan(), userLink(), and wfMessage().

Referenced by ChangeTagsRevisionItem\getHTML(), RevDelRevisionItem\getHTML(), RevisionItem\getHTML(), and DummyLinker\revUserLink().

◆ revUserTools()

static Linker::revUserTools	(	RevisionRecord	$revRecord,
			$isPublic = false,
			$useParentheses = true )

static

Generate a user tool link cluster if the current user is allowed to view it.

This method produces HTML that requires CSS styles in mediawiki.interface.helpers.styles.

Since: 1.16.3

Parameters

RevisionRecord	$revRecord	(Switched from the old Revision class to RevisionRecord since 1.35)
bool	$isPublic	Show only if all users can see it
bool	$useParentheses	(optional) Wrap comments in parentheses where needed

Returns: string HTML

Definition at line 1371 of file Linker.php.

References MediaWiki\Revision\RevisionRecord\getUser(), MediaWiki\Revision\RevisionRecord\isDeleted(), MediaWiki\Revision\RevisionRecord\userCan(), and wfMessage().

Referenced by SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), SpecialNewpages\formatRow(), RollbackAction\handleRollbackRequest(), InfoAction\pageInfo(), DummyLinker\revUserTools(), Article\setOldSubtitle(), and DifferenceEngine\showDiffPage().

◆ specialLink()

static Linker::specialLink	(		$name,
			$key = '' )

static

Make a link to a special page given its name and, optionally, a message key from the link text.

Usage example: Linker::specialLink( 'Recentchanges' )

Since: 1.16.3

Parameters

string	$name
string	$key

Returns: string

Definition at line 1035 of file Linker.php.

References SpecialPage\getTitleFor(), linkKnown(), and wfMessage().

Referenced by DummyLinker\specialLink().

◆ splitTrail()

static Linker::splitTrail ( $trail )

static

Split a link trail, return the "inside" portion and the remainder of the trail as a two-element array.

Parameters

string $trail

Returns: string[]

Definition at line 1796 of file Linker.php.

Referenced by LinkHolderArray\makeHolder(), makeSelfLinkObj(), and DummyLinker\splitTrail().

◆ titleAttrib()

static Linker::titleAttrib	(		$name,
			$options = null,
		array	$msgParams = [],
			$localizer = null )

static

Given the id of an interface element, constructs the appropriate title attribute from the system messages.

(Note, this is usually the id but isn't always, because sometimes the accesskey needs to go on a different element than the id, for reverse-compatibility, etc.)

Since: 1.16.3 $msgParams added in 1.27

Parameters

string	$name	Id of the element, minus prefixes.
string \| array \| null	$options	Null, string or array with some of the following options: 'withaccess' to add an access-key hint 'nonexisting' to add an accessibility hint that page does not exist
array	$msgParams	Parameters to pass to the message
MessageLocalizer \| null	$localizer

Returns: string|false Contents of the title attribute (which you must HTML- escape), or false for no title attribute

Definition at line 2080 of file Linker.php.

Referenced by OOUIHTMLForm\getButtons(), EditPage\getCheckboxesWidget(), EditPage\getEditButtons(), HTMLFormField\getTooltipAndAccessKeyOOUI(), DifferenceEngine\showDiffPage(), EditPage\showEditForm(), and DummyLinker\titleAttrib().

◆ tocIndent()

static Linker::tocIndent ( )

static

Add another level to the Table of Contents.

Since: 1.16.3

Returns: string

Definition at line 1638 of file Linker.php.

Referenced by SpecialEditWatchlist\getNormalForm(), and DummyLinker\tocIndent().

◆ tocLine()

static Linker::tocLine	(	$anchor,
		$tocline,
		$tocnumber,
		$level,
		$sectionIndex = false )

static

parameter level defines if we are on an indentation level

Since: 1.16.3

Parameters

string	$anchor
string	$tocline
string	$tocnumber
int	$level
int \| false	$sectionIndex

Returns: string

Definition at line 1664 of file Linker.php.

Referenced by SpecialEditWatchlist\getNormalForm(), and DummyLinker\tocLine().

◆ tocLineEnd()

static Linker::tocLineEnd ( )

static

End a Table Of Contents line.

tocUnindent() will be used instead if we're ending a line below the new level.

Since: 1.16.3

Returns: string

Definition at line 1688 of file Linker.php.

Referenced by SpecialEditWatchlist\getNormalForm(), and DummyLinker\tocLineEnd().

◆ tocList()

static Linker::tocList	(		$toc,
		Language	$lang = null )

static

Wraps the TOC in a div with ARIA navigation role and provides the hide/collapse JavaScript.

Since: 1.16.3

Parameters

string	$toc	Html of the Table Of Contents
Language \| null	$lang	Language for the toc title, defaults to user language

Returns: string Full html of the TOC

Definition at line 1700 of file Linker.php.

References $lang, $title, and wfMessage().

Referenced by SpecialEditWatchlist\getNormalForm(), and DummyLinker\tocList().

◆ tocUnindent()

static Linker::tocUnindent ( $level )

static

Finish one or more sublevels on the Table of Contents.

Since: 1.16.3

Parameters

int $level

Returns: string

Definition at line 1649 of file Linker.php.

Referenced by DummyLinker\tocUnindent().

◆ tooltip()

static Linker::tooltip	(		$name,
			$options = null )

static

Returns raw bits of HTML, use titleAttrib()

Since: 1.16.3

Parameters

string	$name
array \| null	$options

Returns: null|string

Definition at line 2342 of file Linker.php.

Referenced by DummyLinker\tooltip().

◆ tooltipAndAccesskeyAttribs()

static Linker::tooltipAndAccesskeyAttribs	(		$name,
		array	$msgParams = [],
			$options = null,
			$localizer = null,
			$user = null,
			$config = null,
			$relevantTitle = null )

static

Returns the attributes for the tooltip and access key.

Since: 1.16.3. $msgParams introduced in 1.27

Parameters

string	$name
array	$msgParams	Params for constructing the message
string \| array \| null	$options	Options to be passed to titleAttrib.
MessageLocalizer \| null	$localizer
User \| null	$user	Only needed for generating tooltip for watchlist expiry.
Config \| null	$config	Only needed for generating tooltip for watchlist expiry.
Title \| null	$relevantTitle	Only needed for generating tooltip for watchlist expiry.

See also: Linker::titleAttrib for what options could be passed to $options.

Returns: array

Definition at line 2299 of file Linker.php.

Referenced by McrUndoAction\alterForm(), HTMLForm\getButtons(), VFormHTMLForm\getButtons(), HistoryPager\getStartBody(), HTMLFormField\getTooltipAndAccessKey(), SkinTemplate\makeSearchButtonInternal(), UserrightsPage\showEditUserGroupsForm(), and DummyLinker\tooltipAndAccesskeyAttribs().

◆ userLink()

static Linker::userLink	(	$userId,
		$userName,
		$altUserName = false )

static

Make user link (or user contributions for unregistered users)

This method produces HTML that requires CSS styles in mediawiki.interface.helpers.styles.

Parameters

int	$userId	User id in database.
string	$userName	User name in database.
string \| false	$altUserName	Text to display instead of the user name (optional)

Returns: string HTML fragment

Since: 1.16.3. $altUserName was added in 1.19.

Definition at line 1114 of file Linker.php.

References link(), NS_USER, wfDebug(), and wfMessage().

Referenced by ActiveUsersPager\formatRow(), ContribsPager\formatRow(), UsersPager\formatRow(), ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), RevDelFileItem\getUserTools(), ImageHistoryList\imageHistoryLine(), ChangesList\insertUserRelatedLinks(), CreditsAction\link(), LogFormatter\makeUserLink(), revUserLink(), and DummyLinker\userLink().

◆ userTalkLink()

static Linker::userTalkLink	(		$userId,
			$userText )

static

Since: 1.16.3

Parameters

int	$userId	User id in database.
string	$userText	User name in database.

Returns: string HTML fragment with user talk link

Definition at line 1254 of file Linker.php.

References link(), NS_USER_TALK, wfDebug(), and wfMessage().

Referenced by ContribsPager\formatRow(), DummyLinker\userTalkLink(), and userToolLinks().

◆ userToolLinks()

static Linker::userToolLinks	(	$userId,
		$userText,
		$redContribsWhenNoEdits = false,
		$flags = 0,
		$edits = null,
		$useParentheses = true )

static

Generate standard user tool links (talk, contributions, block link, etc.)

Since: 1.16.3

Parameters

int	$userId	User identifier
string	$userText	User name or IP address
bool	$redContribsWhenNoEdits	Should the contributions link be red if the user has no edits?
int	$flags	Customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK and Linker::TOOL_LINKS_EMAIL).
int \| null	$edits	User edit count (optional, for performance)
bool	$useParentheses	(optional) Wrap comments in parentheses where needed

Returns: string HTML fragment

Definition at line 1159 of file Linker.php.

References $wgLang, blockLink(), emailLink(), SpecialPage\getTitleFor(), link(), User\newFromId(), TOOL_LINKS_NOBLOCK, userTalkLink(), wfDebug(), and wfMessage().

Referenced by ActiveUsersPager\formatRow(), ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), RevDelFileItem\getUserTools(), ImageHistoryList\imageHistoryLine(), ChangesList\insertUserRelatedLinks(), LogFormatter\makeUserLink(), RCCacheEntryFactory\newFromRecentChange(), UserrightsPage\showEditUserGroupsForm(), DummyLinker\userToolLinks(), and userToolLinksRedContribs().

◆ userToolLinksRedContribs()

static Linker::userToolLinksRedContribs	(	$userId,
		$userText,
		$edits = null,
		$useParentheses = true )

static

Alias for userToolLinks( $userId, $userText, true );.

Since: 1.16.3

Parameters

int	$userId	User identifier
string	$userText	User name or IP address
int \| null	$edits	User edit count (optional, for performance)
bool	$useParentheses	(optional) Wrap comments in parentheses where needed

Returns: string

Definition at line 1242 of file Linker.php.

References userToolLinks().

Referenced by UsersPager\formatRow(), and DummyLinker\userToolLinksRedContribs().

Member Data Documentation

◆ $accesskeycache

Linker::$accesskeycache

static

Definition at line 2114 of file Linker.php.

◆ TOOL_LINKS_EMAIL

const Linker::TOOL_LINKS_EMAIL = 2

Definition at line 47 of file Linker.php.

Referenced by UserrightsPage\showEditUserGroupsForm().

◆ TOOL_LINKS_NOBLOCK

const Linker::TOOL_LINKS_NOBLOCK = 1

Flags for userToolLinks()

Definition at line 46 of file Linker.php.

Referenced by BlockListPager\formatValue(), BlockLogFormatter\getMessageParameters(), and userToolLinks().

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

includes/Linker.php

Static Public Member Functions

Public Attributes

Static Public Attributes

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ accesskey()

◆ blockLink()

◆ buildRollbackLink()

◆ commentBlock()

◆ emailLink()

◆ expandLocalLinks()

◆ formatComment()

◆ formatHiddenCategories()

◆ formatLinksInComment()

◆ formatRevisionSize()

◆ generateRollback()

◆ generateTOC()

◆ getImageLinkMTOParams()

◆ getInvalidTitleDescription()

◆ getRevDeleteLink()

◆ getRevisionDeletedClass()

◆ getRollbackEditCount()

◆ getUploadUrl()

◆ link()

◆ linkKnown()

◆ makeBrokenImageLinkObj()

◆ makeExternalImage()

◆ makeExternalLink()

◆ makeHeadline()

◆ makeImageLink()

◆ makeMediaLinkFile()

◆ makeMediaLinkObj()

◆ makeSelfLinkObj()

◆ makeThumbLink2()

◆ makeThumbLinkObj()

◆ normaliseSpecialPage()

◆ normalizeSubpageLink()

◆ processResponsiveImages()

◆ revComment()

◆ revDeleteLink()

◆ revDeleteLinkDisabled()

◆ revUserLink()

◆ revUserTools()

◆ specialLink()

◆ splitTrail()

◆ titleAttrib()

◆ tocIndent()

◆ tocLine()

◆ tocLineEnd()

◆ tocList()

◆ tocUnindent()

◆ tooltip()

◆ tooltipAndAccesskeyAttribs()

◆ userLink()

◆ userTalkLink()

◆ userToolLinks()

◆ userToolLinksRedContribs()

Member Data Documentation

◆ $accesskeycache

◆ TOOL_LINKS_EMAIL

◆ TOOL_LINKS_NOBLOCK