PHP Parser - Processes wiki markup (which uses a more user-friendly syntax, such as "[[link]]" for making links), and provides a one-way transformation of that wiki markup it into (X)HTML output / markup (which in turn the browser understands, and can display). More...

Collaboration diagram for Parser:

[legend]

Public Member Functions
	__clone ()
	Allow extensions to clean up when the parser is cloned.

	__construct ( $svcOptions=null, MagicWordFactory $magicWordFactory=null, Language $contLang=null, ParserFactory $factory=null, $urlProtocols=null, SpecialPageFactory $spFactory=null, $linkRendererFactory=null, $nsInfo=null, $logger=null, BadFileLookup $badFileLookup=null)
	Constructing parsers directly is deprecated! Use a ParserFactory.

	__destruct ()
	Reduce memory usage to reduce the impact of circular references.

	addTrackingCategory ( $msg)

	areSubpagesAllowed ()
	Return true if subpage links should be expanded on this page.

	argSubstitution ( $piece, $frame)
	Triple brace replacement – used for template arguments.

	armorLinks ( $text)
	Insert a NOPARSE hacky thing into any inline links in a chunk that's going to go through further parsing steps before inline URL expansion.

	attributeStripCallback (&$text, $frame=false)
	Callback from the Sanitizer for expanding items found in HTML attribute values, so they can be safely tested and escaped.

	braceSubstitution ( $piece, $frame)
	Return the text of a template, after recursively replacing any variables or templates within the template.

	callParserFunction ( $frame, $function, array $args=[])
	Call a parser function and return an array with text and flags.

	cleanSig ( $text, $parsing=false)
	Clean up signature text.

	clearState ()
	Clear Parser state.

	clearTagHooks ()
	Remove all tag hooks.

	disableCache ()
	Set a flag in the output object indicating that the content is dynamic and shouldn't be cached.

	doAllQuotes ( $text)
	Replace single quotes with HTML markup.

	doBlockLevels ( $text, $linestart)
	Make lists from lines starting with ':', '*', '#', etc.

	doDoubleUnderscore ( $text)
	Strip double-underscore items like NOGALLERY and NOTOC Fills $this->mDoubleUnderscores, returns the modified text.

	doHeadings ( $text)
	Parse headers and return html.

	doMagicLinks ( $text)
	Replace special strings like "ISBN xxx" and "RFC xxx" with magic external links.

	doQuotes ( $text)
	Helper function for doAllQuotes()

	doTableStuff ( $text)
	Parse the wiki syntax used to render tables.

	enableOOUI ()
	Set's up the PHP implementation of OOUI for use in this request and instructs OutputPage to enable OOUI for itself.

	extensionSubstitution ( $params, $frame)
	Return the text to be used for a given extension tag.

	fetchCurrentRevisionOfTitle ( $title)
	Fetch the current revision of a given title.

	fetchFileAndTitle ( $title, $options=[])
	Fetch a file and its title and register a reference to it.

	fetchTemplate ( $title)
	Fetch the unparsed text of a template and register a reference to it.

	fetchTemplateAndTitle ( $title)
	Fetch the unparsed text of a template and register a reference to it.

	firstCallInit ()
	Do various kinds of initialisation on the first call of the parser.

	formatHeadings ( $text, $origText, $isMain=true)
	This function accomplishes several tasks: 1) Auto-number headings if that option is enabled 2) Add an [edit] link to sections for users who have enabled the option and can edit the page 3) Add a Table of contents on the top for users who have enabled the option 4) Auto-anchor headings.

	getContentLanguage ()
	Get the content language that this Parser is using.

	getConverterLanguage ()
	Get the language object for language conversion.

	getCustomDefaultSort ()
	Accessor for $mDefaultSort Unlike getDefaultSort(), will return false if none is set.

	getDefaultSort ()
	Accessor for $mDefaultSort Will use the empty string if none is set.

	getExternalLinkAttribs ( $url)
	Get an associative array of additional HTML attributes appropriate for a particular external link.

	getFreshParser ()
	Return this parser if it is not doing anything, otherwise get a fresh parser.

	getFunctionHooks ()
	Get all registered function hook identifiers.

	getFunctionLang ()
	Get a language object for use in parser functions such as {{FORMATNUM:}}.

	getFunctionSynonyms ()

	getImageParams ( $handler)

	getLinkRenderer ()
	Get a LinkRenderer instance to make links with.

	getMagicWordFactory ()
	Get the MagicWordFactory that this Parser is using.

	getOptions ()
	Get the ParserOptions object.

	getOutput ()
	Get the ParserOutput object.

	getPreloadText ( $text, Title $title, ParserOptions $options, $params=[])
	Process the wikitext for the "?preload=" feature.

	getPreprocessor ()
	Get a preprocessor object.

	getRevisionId ()
	Get the ID of the revision we are parsing.

	getRevisionObject ()
	Get the revision object for $this->mRevisionId.

	getRevisionSize ()
	Get the size of the revision.

	getRevisionTimestamp ()
	Get the timestamp associated with the current revision, adjusted for the default server-local timestamp.

	getRevisionUser ()
	Get the name of the user that edited the last revision.

	getSection ( $text, $sectionId, $defaultText='')
	This function returns the text of a section, specified by a number ($section).

	getStripList ()
	Get a list of strippable XML-like elements.

	getStripState ()
	Get the StripState.

	getTags ()
	Accessor.

	getTargetLanguage ()
	Get the target language for the content being parsed.

	getTemplateDom ( $title)
	Get the semi-parsed DOM representation of a template with a given title, and its redirect destination title.

	getTitle ()
	Accessor for the Title object.

	getUrlProtocols ()

	getUser ()
	Get a User object either from $this->mUser, if set, or from the ParserOptions object otherwise.

	getUserSig (&$user, $nickname=false, $fancySig=null)
	Fetch the user's signature text, if any, and normalize to validated, ready-to-insert wikitext.

	getVariableValue ( $index, $frame=false)
	Return value of a magic variable (like PAGENAME)

	guessLegacySectionNameFromWikiText ( $text)
	Same as guessSectionNameFromWikiText(), but produces legacy anchors instead, if possible.

	guessSectionNameFromWikiText ( $text)
	Try to guess the section anchor name based on a wikitext fragment presumably extracted from a heading, for example "Header" from "== Header ==".

	incrementExpensiveFunctionCount ()
	Increment the expensive function count.

	incrementIncludeSize ( $type, $size)
	Increment an include size counter.

	initialiseVariables ()
	initialise the magic variables (like CURRENTMONTHNAME) and substitution modifiers

	insertStripItem ( $text)
	Add an item to the strip state Returns the unique tag which must be inserted into the stripped text The tag will be replaced with the original text in unstrip()

	internalParse ( $text, $isMain=true, $frame=false)
	Helper function for parse() that transforms wiki markup into half-parsed HTML.

	interwikiTransclude ( $title, $action)
	Transclude an interwiki link.

	isCurrentRevisionOfTitleCached ( $title)

	isValidHalfParsedText ( $data)
	Returns true if the given array, presumed to be generated by serializeHalfParsedText(), is compatible with the current version of the parser.

	killMarkers ( $text)
	Remove any strip markers found in the given text.

	limitationWarn ( $limitationType, $current='', $max='')
	Warn the user when a parser limitation is reached Will warn at most once the user per limitation type.

	magicLinkCallback ( $m)

	makeFreeExternalLink ( $url, $numPostProto)
	Make a free external link, given a user-supplied URL.

	makeImage ( $title, $options, $holders=false)
	Parse image options text and use it to make an image.

	markerSkipCallback ( $s, $callback)
	Call a callback function on all regions of the given text that are not inside strip markers, and replace those regions with the return value of the callback.

	maybeDoSubpageLink ( $target, &$text)
	Handle link to subpage if necessary.

	nextLinkID ()

	Options ( $x=null)
	Accessor/mutator for the ParserOptions object.

	OutputType ( $x=null)
	Accessor/mutator for the output type.

	parse ( $text, Title $title, ParserOptions $options, $linestart=true, $clearState=true, $revid=null)
	Convert wikitext to HTML Do not call this function recursively.

	parseLinkParameter ( $value)
	Parse the value of 'link' parameter in image syntax (`[[File:Foo.jpg\|link=<value>]]`).

	preprocess ( $text, Title $title=null, ParserOptions $options, $revid=null, $frame=false)
	Expand templates and variables in the text, producing valid, static wikitext.

	preprocessToDom ( $text, $flags=0)
	Preprocess some wikitext and return the document tree.

	preSaveTransform ( $text, Title $title, User $user, ParserOptions $options, $clearState=true)
	Transform wiki markup when saving a page by doing "\\r\\n" -> "\\n" conversion, substituting signatures, {{subst:}} templates, etc.

	recursivePreprocess ( $text, $frame=false)
	Recursive parser entry point that can be called from an extension tag hook.

	recursiveTagParse ( $text, $frame=false)
	Half-parse wikitext to half-parsed HTML.

	recursiveTagParseFully ( $text, $frame=false)
	Fully parse wikitext to fully parsed HTML.

	renderImageGallery ( $text, $params)
	Renders an image gallery from a text with one line per image.

	replaceExternalLinks ( $text)
	Replace external links (REL)

	replaceInternalLinks ( $text)
	Process [[ ]] wikilinks.

	replaceInternalLinks2 (&$text)
	Process [[ ]] wikilinks (RIL)

	replaceLinkHolders (&$text, $options=0)
	Replace "<!--LINK-->" link placeholders with actual links, in the buffer Placeholders created in Linker::link()

	replaceLinkHoldersText ( $text)
	Replace "<!--LINK-->" link placeholders with plain text of links (not HTML-formatted).

	replaceSection ( $oldText, $sectionId, $newText)
	This function returns $oldtext after the content of the section specified by $section has been replaced with $text.

	replaceTransparentTags ( $text)
	Replace transparent tags in $text with the values given by the callbacks.

	replaceVariables ( $text, $frame=false, $argsOnly=false)
	Replace magic variables, templates, and template arguments with the appropriate text.

	resetOutput ()
	Reset the ParserOutput.

	serializeHalfParsedText ( $text)
	Save the parser state required to convert the given half-parsed text to HTML.

	setDefaultSort ( $sort)
	Mutator for $mDefaultSort.

	setFunctionHook ( $id, callable $callback, $flags=0)
	Create a function, e.g.

	setFunctionTagHook ( $tag, callable $callback, $flags)
	Create a tag function, e.g.

	setHook ( $tag, callable $callback)
	Create an HTML-style tag, e.g.

	setLinkID ( $id)

	setOutputType ( $ot)
	Set the output type.

	setTitle (Title $t=null)
	Set the context title.

	setTransparentTagHook ( $tag, callable $callback)
	As setHook(), but letting the contents be parsed.

	setUser ( $user)
	Set the current user.

	startExternalParse (Title $title=null, ParserOptions $options, $outputType, $clearState=true, $revId=null)
	Set up some variables which are usually set up in parse() so that an external function can call some class members with confidence.

	stripSectionName ( $text)
	Strips a text string of wikitext for use in a section anchor.

	testPreprocess ( $text, Title $title, ParserOptions $options)

	testPst ( $text, Title $title, ParserOptions $options)

	testSrvus ( $text, Title $title, ParserOptions $options, $outputType=self::OT_HTML)
	strip/replaceVariables/unstrip for preprocessor regression testing

	Title (Title $x=null)
	Accessor/mutator for the Title object.

	transformMsg ( $text, $options, $title=null)
	Wrapper for preprocess()

	unserializeHalfParsedText ( $data)
	Load the parser state given in the $data array, which is assumed to have been generated by serializeHalfParsedText().

	validateSig ( $text)
	Check that the user's signature contains no bad XML.

Static Public Member Functions
static	cleanSigInSig ( $text)
	Strip 3, 4 or 5 tildes out of signatures.

static	createAssocArgs ( $args)
	Clean up argument array - refactored in 1.9 so parserfunctions can use it, too.

static	extractTagsAndParams ( $elements, $text, &$matches)
	Replaces all occurrences of HTML-style comments and the given tags in the text with a random marker and returns the next text.

static	getDefaultPreprocessorClass ()
	Which class should we use for the preprocessor if not otherwise specified?

static	getExternalLinkRel ( $url=false, $title=null)
	Get the rel attribute for a particular external link.

static	guessSectionNameFromStrippedText ( $text)
	Like guessSectionNameFromWikiText(), but takes already-stripped text as input.

static	normalizeLinkUrl ( $url)
	Replace unusual escape codes in a URL with their equivalent characters.

static	parseWidthParam ( $value, $parseHeight=true)
	Parsed a width param of imagelink like 300px or 200x300px.

static	splitWhitespace ( $s)
	Return a three-element array: leading whitespace, string contents, trailing whitespace.

static	statelessFetchRevision (Title $title, $parser=false)
	Wrapper around Revision::newFromTitle to allow passing additional parameters without passing them on to it.

static	statelessFetchTemplate ( $title, $parser=false)
	Static function to get a template Can be overridden via ParserOptions::setTemplateCallback().

static	stripOuterParagraph ( $html)
	Strip outer.

Public Attributes
MapCacheLRU null	$currentRevisionCache

	$mAutonumber

array	$mConf

	$mDefaultSort

	$mDefaultStripList = []

	$mDoubleUnderscores

	$mExpensiveFunctionCount

	$mExtLinkBracketedRegex

bool	$mFirstCall = true
	Whether firstCallInit still needs to be called.

	$mForceTocPosition

	$mFunctionHooks = []

	$mFunctionSynonyms = [ 0 => [], 1 => [] ]

	$mFunctionTagHooks = []

	$mGeneratedPPNodeCount

	$mHeadings

	$mHighestExpansionDepth

	$mImageParams = []

	$mImageParamsMagicArray = []

	$mIncludeCount

	$mIncludeSizes

bool string	$mInParse = false
	Recursive call protection.

	$mInputSize = false

array	$mLangLinkLanguages
	Array with the language name of each language link (i.e.

LinkHolderArray	$mLinkHolders

	$mLinkID

	$mMarkerIndex = 0

ParserOptions	$mOptions

ParserOutput	$mOutput

	$mOutputType

	$mPPNodeCount

Preprocessor	$mPreprocessor

	$mRevIdForTs

	$mRevisionId

	$mRevisionObject

	$mRevisionSize

	$mRevisionTimestamp

	$mRevisionUser

	$mShowToc

	$mStripList = []

StripState	$mStripState

MagicWordArray	$mSubstWords

	$mTagHooks = []

Title null	$mTitle
	Since 1.34, leaving `mTitle` uninitialized or setting `mTitle` to `null` is deprecated.

array	$mTplDomCache

	$mTplRedirCache

	$mTransparentTagHooks = []

	$mUrlProtocols

User	$mUser

	$mVarCache = []

MagicWordArray	$mVariables

	$ot

const	EXT_IMAGE_REGEX

const	EXT_LINK_ADDR = '(?:[0-9.]+\|\\[(?i:[0-9a-f:.]+)\\]\|[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}])'

const	EXT_LINK_URL_CLASS = '[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}]'

const	HALF_PARSED_VERSION = 2
	Update this version number when the output of serialiseHalfParsedText() changes in an incompatible way.

const	MARKER_PREFIX = "\x7f'\"`UNIQ-"

const	OT_HTML = 1

const	OT_MSG = 3

const	OT_PLAIN = 4

const	OT_PREPROCESS = 3

const	OT_WIKI = 2

const	PTD_FOR_INCLUSION = 1

const	SFH_NO_HASH = 1

const	SFH_OBJECT_ARGS = 2

const	SPACE_NOT_NL = '(?:\t\| \|&\#0160;\|&\#[Xx]0[Aa]0;\|\p{Zs})'

const	TOC_END = '</mw:toc>'

const	TOC_START = '<mw:toc>'

const	VERSION = '1.6.4'
	Update this version number when the ParserOutput format changes in an incompatible way, so the parser cache can automatically discard old data.

Static Public Attributes
static array	$constructorOptions
	TODO Make this a const when HHVM support is dropped (T192166)

Protected Member Functions
	fetchFileNoRegister ( $title, $options=[])
	Helper function for fetchFileAndTitle.

	lock ()
	Lock the current instance of the parser.

	makeKnownLinkHolder ( $nt, $text='', $trail='', $prefix='')
	Render a forced-blue link inline; protect against double expansion of URLs if we're in a mode that prepends full URL prefixes to internal links.

	makeLimitReport ()
	Set the limit report data in the current ParserOutput, and return the limit report HTML comment.

	setOutputFlag ( $flag, $reason)

	stripAltText ( $caption, $holders)

Protected Attributes
LinkRenderer	$mLinkRenderer

SectionProfiler	$mProfiler

Private Member Functions
	armorLinksPrivate ( $text)
	Insert a NOPARSE hacky thing into any inline links in a chunk that's going to go through further parsing steps before inline URL expansion.

	expandMagicVariable ( $index, $frame=false)
	Return value of a magic variable (like PAGENAME)

	extractSections ( $text, $sectionId, $mode, $newText='')
	Break wikitext input into sections, and either pull or replace some particular section's text.

	finalizeHeadings ( $text, $origText, $isMain=true)
	This function accomplishes several tasks: 1) Auto-number headings if that option is enabled 2) Add an [edit] link to sections for users who have enabled the option and can edit the page 3) Add a Table of contents on the top for users who have enabled the option 4) Auto-anchor headings.

	fuzzTestPreprocess ( $text, Title $title, ParserOptions $options)

	fuzzTestPst ( $text, Title $title, ParserOptions $options)

	fuzzTestSrvus ( $text, Title $title, ParserOptions $options, $outputType=self::OT_HTML)
	Strip/replaceVariables/unstrip for preprocessor regression testing.

	getImageParamsPrivate ( $handler)

	getRevisionTimestampSubstring ( $start, $len, $mtts, $variable)

	handleAllQuotes ( $text)
	Replace single quotes with HTML markup.

	handleDoubleUnderscore ( $text)
	Strip double-underscore items like NOGALLERY and NOTOC Fills $this->mDoubleUnderscores, returns the modified text.

	handleExternalLinks ( $text)
	Replace external links (REL)

	handleHeadings ( $text)
	Parse headers and return html.

	handleInternalLinks ( $text)
	Process [[ ]] wikilinks.

	handleInternalLinks2 (&$s)
	Process [[ ]] wikilinks (RIL)

	handleMagicLinks ( $text)
	Replace special strings like "ISBN xxx" and "RFC xxx" with magic external links.

	handleTables ( $text)
	Parse the wiki syntax used to render tables.

	initializeVariables ()
	Initialize the magic variables (like CURRENTMONTHNAME) and substitution modifiers.

	internalParseHalfParsed ( $text, $isMain=true, $linestart=true)
	Helper function for parse() that transforms half-parsed HTML into fully parsed HTML.

	makeKnownLinkHolderPrivate ( $nt, $text='', $trail='', $prefix='')
	Render a forced-blue link inline; protect against double expansion of URLs if we're in a mode that prepends full URL prefixes to internal links.

	makeLegacyAnchor ( $sectionName)

	maybeMakeExternalImage ( $url)
	make an image if it's allowed, either through the global option, through the exception, or through the on-wiki whitelist

	parseLinkParameterPrivate ( $value)
	Parse the value of 'link' parameter in image syntax (`[[File:Foo.jpg\|link=<value>]]`).

	pstPass2 ( $text, $user)
	Pre-save transform helper function.

	replaceLinkHoldersPrivate (&$text, $options=0)
	Replace "<!--LINK-->" link placeholders with actual links, in the buffer Placeholders created in Linker::link()

	replaceLinkHoldersTextPrivate ( $text)
	Replace "<!--LINK-->" link placeholders with plain text of links (not HTML-formatted).

	startParse (Title $title=null, ParserOptions $options, $outputType, $clearState=true)

	stripAltTextPrivate ( $caption, $holders)

Static Private Member Functions
static	getSectionNameFromStrippedText ( $text)

static	makeAnchor ( $sectionName)

static	normalizeSectionName ( $text)
	Apply the same normalization as code making links to this section would.

static	normalizeUrlComponent ( $component, $unsafe)

Private Attributes
BadFileLookup	$badFileLookup

Language	$contLang

ParserFactory	$factory

LinkRendererFactory	$linkRendererFactory

LoggerInterface	$logger

MagicWordFactory	$magicWordFactory

NamespaceInfo	$nsInfo

SpecialPageFactory	$specialPageFactory

ServiceOptions	$svcOptions
	This is called $svcOptions instead of $options like elsewhere to avoid confusion with $mOptions, which is public and widely used, and also with the local variable $options used for ParserOptions throughout this file.

Detailed Description

PHP Parser - Processes wiki markup (which uses a more user-friendly syntax, such as "[[link]]" for making links), and provides a one-way transformation of that wiki markup it into (X)HTML output / markup (which in turn the browser understands, and can display).

There are seven main entry points into the Parser class:

Parser::parse() produces HTML output
Parser::preSaveTransform() produces altered wiki markup
Parser::preprocess() removes HTML comments and expands templates
Parser::cleanSig() and Parser::cleanSigInSig() cleans a signature before saving it to preferences
Parser::getSection() return the content of a section from an article for section editing
Parser::replaceSection() replaces a section by number inside an article
Parser::getPreloadText() removes <noinclude> sections and <includeonly> tags

Warning: $wgUser or $wgTitle or $wgRequest or $wgLang. Keep them away!

Settings:: $wgNamespacesWithSubpages

Settings only within ParserOptions:: $wgAllowExternalImages $wgAllowSpecialInclusion $wgInterwikiMagic $wgMaxArticleSize

Definition at line 74 of file Parser.php.

Constructor & Destructor Documentation

◆ __construct()

Parser::__construct	(		$svcOptions = null,
		MagicWordFactory	$magicWordFactory = null,
		Language	$contLang = null,
		ParserFactory	$factory = null,
			$urlProtocols = null,
		SpecialPageFactory	$spFactory = null,
			$linkRendererFactory = null,
			$nsInfo = null,
			$logger = null,
		BadFileLookup	$badFileLookup = null )

Constructing parsers directly is deprecated! Use a ParserFactory.

Parameters

ServiceOptions \| null	$svcOptions
MagicWordFactory \| null	$magicWordFactory
Language \| null	$contLang	Content language
ParserFactory \| null	$factory
string \| null	$urlProtocols	As returned from wfUrlProtocols()
SpecialPageFactory \| null	$spFactory
LinkRendererFactory \| null	$linkRendererFactory
NamespaceInfo \| null	$nsInfo
LoggerInterface \| null	$logger
BadFileLookup \| null	$badFileLookup

Definition at line 352 of file Parser.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), MediaWiki\Config\ServiceOptions\get(), and wfUrlProtocols().

◆ __destruct()

Parser::__destruct ( )

Reduce memory usage to reduce the impact of circular references.

Definition at line 416 of file Parser.php.

Member Function Documentation

◆ __clone()

Parser::__clone ( )

Allow extensions to clean up when the parser is cloned.

Definition at line 430 of file Parser.php.

◆ addTrackingCategory()

Parser::addTrackingCategory ( $msg )

See also: ParserOutput::addTrackingCategory()

Parameters

string $msg Message key

Returns: bool Whether the addition was successful

Definition at line 4446 of file Parser.php.

Referenced by ScribuntoHooks\invokeHook().

◆ areSubpagesAllowed()

Parser::areSubpagesAllowed ( )

Return true if subpage links should be expanded on this page.

Returns: bool

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 2780 of file Parser.php.

References wfDeprecated().

◆ argSubstitution()

Parser::argSubstitution	(		$piece,
			$frame )

Triple brace replacement – used for template arguments.

Definition at line 4199 of file Parser.php.

◆ armorLinks()

Parser::armorLinks ( $text )

Insert a NOPARSE hacky thing into any inline links in a chunk that's going to go through further parsing steps before inline URL expansion.

Not needed quite as much as it used to be since free links are a bit more sensible these days. But bracketed links are still an issue.

Parameters

string $text More-or-less HTML

Returns: string Less-or-more HTML with NOPARSE bits

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 2755 of file Parser.php.

References wfDeprecated().

◆ armorLinksPrivate()

Parser::armorLinksPrivate ( $text )

private

Insert a NOPARSE hacky thing into any inline links in a chunk that's going to go through further parsing steps before inline URL expansion.

Not needed quite as much as it used to be since free links are a bit more sensible these days. But bracketed links are still an issue.

Parameters

string $text More-or-less HTML

Returns: string Less-or-more HTML with NOPARSE bits

Definition at line 2770 of file Parser.php.

◆ attributeStripCallback()

Parser::attributeStripCallback	(	&	$text,
			$frame = false )

Callback from the Sanitizer for expanding items found in HTML attribute values, so they can be safely tested and escaped.

Parameters

string	&$text
bool \| PPFrame	$frame

Returns: string

Definition at line 5998 of file Parser.php.

◆ braceSubstitution()

Parser::braceSubstitution	(		$piece,
			$frame )

Return the text of a template, after recursively replacing any variables or templates within the template.

Parameters

array	$piece	The parts of the template $piece['title']: the title, i.e. the part before the \| $piece['parts']: the parameter array $piece['lineStart']: whether the brace was at the start of a line
PPFrame	$frame	The current frame, contains template arguments

Exceptions

Exception

Returns: string|array The text of the template

Definition at line 3415 of file Parser.php.

References $args, $context, $title, getUser(), Linker\normalizeSubpageLink(), NS_TEMPLATE, RequestContext\setTitle(), wfEscapeWikiText(), and wfMessage().

◆ callParserFunction()

Parser::callParserFunction	(		$frame,
			$function,
		array	$args = [] )

Call a parser function and return an array with text and flags.

The returned array will always contain a boolean 'found', indicating whether the parser function was found or not. It may also contain the following: text: string|object, resulting wikitext or PP DOM object isHTML: bool, $text is HTML, armour it against wikitext transformation isChildObj: bool, $text is a DOM node needing expansion in a child frame isLocalObj: bool, $text is a DOM node needing expansion in the current frame nowiki: bool, wiki markup in $text should be escaped

Since: 1.21

Parameters

PPFrame	$frame	The current frame, contains template arguments
string	$function	Function name
array	$args	Arguments to the function

Exceptions

MWException

Returns: array

Definition at line 3769 of file Parser.php.

References $args.

◆ cleanSig()

Parser::cleanSig	(		$text,
			$parsing = false )

Clean up signature text.

1) Strip 3, 4 or 5 tildes out of signatures

See also: cleanSigInSig 2) Substitute all transclusions

Parameters

string	$text
bool	$parsing	Whether we're cleaning (preferences save) or parsing

Returns: string Signature text

Definition at line 5059 of file Parser.php.

References $wgTitle.

◆ cleanSigInSig()

static Parser::cleanSigInSig ( $text )

static

Strip 3, 4 or 5 tildes out of signatures.

Parameters

string $text

Returns: string Signature text with /~{3,5}/ removed

Definition at line 5096 of file Parser.php.

◆ clearState()

Parser::clearState ( )

Clear Parser state.

Access:\n private

Definition at line 484 of file Parser.php.

References firstCallInit(), and resetOutput().

Referenced by Cite\clearState(), and Cite\cloneState().

◆ clearTagHooks()

Parser::clearTagHooks ( )

Remove all tag hooks.

Definition at line 5234 of file Parser.php.

◆ createAssocArgs()

static Parser::createAssocArgs ( $args )

static

Clean up argument array - refactored in 1.9 so parserfunctions can use it, too.

Parameters

array $args

Returns: array

Deprecated: since 1.34; appears to be unused in core.

Definition at line 3343 of file Parser.php.

References $args, and wfDeprecated().

◆ disableCache()

Parser::disableCache ( )

Set a flag in the output object indicating that the content is dynamic and shouldn't be cached.

Deprecated: since 1.28; use getOutput()->updateCacheExpiry()

Definition at line 5980 of file Parser.php.

References wfDeprecated().

◆ doAllQuotes()

Parser::doAllQuotes ( $text )

Replace single quotes with HTML markup.

Access:\n private

Parameters

string $text

Returns: string The altered text

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 1855 of file Parser.php.

References wfDeprecated().

◆ doBlockLevels()

Parser::doBlockLevels	(		$text,
			$linestart )

Make lists from lines starting with ':', '*', '#', etc.

(DBL)

Parameters

string	$text
bool	$linestart	Whether or not this is at the start of a line.

Access:\n private

Returns: string The lists rendered as HTML

Definition at line 2808 of file Parser.php.

References BlockLevelPass\doBlockLevels().

◆ doDoubleUnderscore()

Parser::doDoubleUnderscore ( $text )

Strip double-underscore items like NOGALLERY and NOTOC Fills $this->mDoubleUnderscores, returns the modified text.

Parameters

string $text

Returns: string

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 4381 of file Parser.php.

References wfDeprecated().

◆ doHeadings()

Parser::doHeadings ( $text )

Parse headers and return html.

Access:\n private

Parameters

string $text

Returns: string

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 1825 of file Parser.php.

References wfDeprecated().

◆ doMagicLinks()

Parser::doMagicLinks ( $text )

Replace special strings like "ISBN xxx" and "RFC xxx" with magic external links.

DML

Access:\n private

Parameters

string $text

Returns: string

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 1633 of file Parser.php.

References wfDeprecated().

◆ doQuotes()

Parser::doQuotes ( $text )

Helper function for doAllQuotes()

Parameters

string $text

Returns: string

Definition at line 1885 of file Parser.php.

◆ doTableStuff()

Parser::doTableStuff ( $text )

Parse the wiki syntax used to render tables.

Access:\n private

Parameters

string $text

Returns: string

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 1244 of file Parser.php.

References wfDeprecated().

◆ enableOOUI()

Parser::enableOOUI ( )

Set's up the PHP implementation of OOUI for use in this request and instructs OutputPage to enable OOUI for itself.

Since: 1.26

Definition at line 6830 of file Parser.php.

◆ expandMagicVariable()

Parser::expandMagicVariable	(		$index,
			$frame = false )

private

Return value of a magic variable (like PAGENAME)

Parameters

string	$index	Magic variable identifier as mapped in MagicWordFactory::$mVariableIDs
bool \| PPFrame	$frame

Exceptions

MWException

Returns: string

Definition at line 2838 of file Parser.php.

References SiteStats\activeUsers(), SiteStats\articles(), CoreParserFunctions\cascadingsources(), SiteStats\edits(), SpecialVersion\getVersion(), SiteStats\images(), SiteStats\numberingroup(), SiteStats\pages(), true, SiteStats\users(), wfEscapeWikiText(), wfTimestamp(), and wfUrlencode().

◆ extensionSubstitution()

Parser::extensionSubstitution	(		$params,
			$frame )

Return the text to be used for a given extension tag.

This is the ghost of strip().

Parameters

array	$params	Associative array of parameters: name PPNode for the tag name attr PPNode for unparsed text where tag attributes are thought to be attributes Optional associative array of parsed attributes inner Contents of extension element noClose Original text did not have a close tag
PPFrame	$frame

Exceptions

MWException

Returns: string

Definition at line 4252 of file Parser.php.

References $content.

◆ extractSections()

Parser::extractSections	(	$text,
		$sectionId,
		$mode,
		$newText = '' )

private

Break wikitext input into sections, and either pull or replace some particular section's text.

External callers should use the getSection and replaceSection methods.

Parameters

string	$text	Page wikitext
string \| int	$sectionId	A section identifier string of the form: "<flag1> - <flag2> - ... - <section number>"

Currently the only recognised flag is "T", which means the target section number was derived during a template inclusion parse, in other words this is a template section edit link. If no flags are given, it was an ordinary section edit link. This flag is required to avoid a section numbering mismatch when a section is enclosed by "<includeonly>" (T8563).

The section number 0 pulls the text before the first heading; other numbers will pull the given section along with its lower-level subsections. If the section is not found, $mode=get will return $newtext, and $mode=replace will return $text.

Section 0 is always considered to exist, even if it only contains the empty string. If $text is the empty string and section 0 is replaced, $newText is returned.

Parameters

string	$mode	One of "get" or "replace"
string	$newText	Replacement text for section data.

Returns: string For "get", the extracted section text. for "replace", the whole page with the section replaced.

Definition at line 6096 of file Parser.php.

References $wgTitle.

◆ extractTagsAndParams()

static Parser::extractTagsAndParams	(		$elements,
			$text,
		&	$matches )

static

Replaces all occurrences of HTML-style comments and the given tags in the text with a random marker and returns the next text.

The output parameter $matches will be an associative array filled with data in the form:

'UNIQ-xxxxx' => [
  'element',
  'tag content',
  [ 'param' => 'x' ],
  '<element param="x">tag content</element>' ]

Parameters

array	$elements	List of element names. Comments are always extracted.
string	$text	Source text string.
array	&$matches	Out parameter, Array: extracted tags

Returns: string Stripped text

Definition at line 1144 of file Parser.php.

References $content, and $matches.

◆ fetchCurrentRevisionOfTitle()

Parser::fetchCurrentRevisionOfTitle ( $title )

Fetch the current revision of a given title.

Note that the revision (and even the title) may not exist in the database, so everything contributing to the output of the parser should use this method where possible, rather than getting the revisions themselves. This method also caches its results, so using it benefits performance.

Since: 1.24

Parameters

Title $title

Returns: Revision

Definition at line 3904 of file Parser.php.

References $title.

◆ fetchFileAndTitle()

Parser::fetchFileAndTitle	(		$title,
			$options = [] )

Fetch a file and its title and register a reference to it.

If 'broken' is a key in $options then the file will appear as a broken thumbnail.

Parameters

Title	$title
array	$options	Array of options to RepoGroup::findFile

Returns: array ( File or false, Title of file )

Definition at line 4087 of file Parser.php.

References $file, and $title.

◆ fetchFileNoRegister()

Parser::fetchFileNoRegister	(		$title,
			$options = [] )

protected

Helper function for fetchFileAndTitle.

Also useful if you need to fetch a file but not use it yet, for example to get the file's handler.

Parameters

Title	$title
array	$options	Array of options to RepoGroup::findFile

Returns: File|bool

Definition at line 4112 of file Parser.php.

References $file, and $title.

◆ fetchTemplate()

Parser::fetchTemplate ( $title )

Fetch the unparsed text of a template and register a reference to it.

Parameters

Title $title

Returns: string|bool

Definition at line 3978 of file Parser.php.

References $title.

◆ fetchTemplateAndTitle()

Parser::fetchTemplateAndTitle ( $title )

Fetch the unparsed text of a template and register a reference to it.

Parameters

Title $title

Returns: array ( string or false, Title )

Definition at line 3950 of file Parser.php.

References $title, and getTitle().

◆ finalizeHeadings()

Parser::finalizeHeadings	(	$text,
		$origText,
		$isMain = true )

private

This function accomplishes several tasks: 1) Auto-number headings if that option is enabled 2) Add an [edit] link to sections for users who have enabled the option and can edit the page 3) Add a Table of contents on the top for users who have enabled the option 4) Auto-anchor headings.

It loops through all headlines, collects the necessary data, then splits up the string and re-inserts the newly formatted headlines.

Parameters

string	$text
string	$origText	Original, untouched wikitext
bool	$isMain

Returns: mixed|string

Definition at line 4487 of file Parser.php.

References $matches, Linker\makeHeadline(), Linker\tocIndent(), Linker\tocLine(), Linker\tocLineEnd(), Linker\tocList(), and Linker\tocUnindent().

◆ firstCallInit()

Parser::firstCallInit ( )

Do various kinds of initialisation on the first call of the parser.

Definition at line 464 of file Parser.php.

References initializeVariables(), CoreParserFunctions\register(), and CoreTagHooks\register().

Referenced by clearState().

◆ formatHeadings()

Parser::formatHeadings	(	$text,
		$origText,
		$isMain = true )

This function accomplishes several tasks: 1) Auto-number headings if that option is enabled 2) Add an [edit] link to sections for users who have enabled the option and can edit the page 3) Add a Table of contents on the top for users who have enabled the option 4) Auto-anchor headings.

It loops through all headlines, collects the necessary data, then splits up the string and re-inserts the newly formatted headlines.

Parameters

string	$text
string	$origText	Original, untouched wikitext
bool	$isMain

Returns: mixed|string

Access:\n private

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 4467 of file Parser.php.

References wfDeprecated().

◆ fuzzTestPreprocess()

Parser::fuzzTestPreprocess	(		$text,
		Title	$title,
		ParserOptions	$options )

private

Parameters

string	$text
Title	$title
ParserOptions	$options

Returns: string

Definition at line 6601 of file Parser.php.

References $title.

◆ fuzzTestPst()

Parser::fuzzTestPst	(		$text,
		Title	$title,
		ParserOptions	$options )

private

Parameters

string	$text
Title	$title
ParserOptions	$options

Returns: string

Definition at line 6579 of file Parser.php.

References $title, and ParserOptions\getUser().

◆ fuzzTestSrvus()

Parser::fuzzTestSrvus	(		$text,
		Title	$title,
		ParserOptions	$options,
			$outputType = self::OT_HTML )

private

Strip/replaceVariables/unstrip for preprocessor regression testing.

Parameters

string	$text
Title	$title
ParserOptions	$options
int	$outputType

Returns: string

Definition at line 6549 of file Parser.php.

References $title.

◆ getContentLanguage()

Parser::getContentLanguage ( )

Get the content language that this Parser is using.

Since: 1.32

Returns: Language

Definition at line 1121 of file Parser.php.

Referenced by MediaWiki\Extensions\ParserFunctions\ParserFunctions\ifexistInternal().

◆ getConverterLanguage()

Parser::getConverterLanguage ( )

Get the language object for language conversion.

Deprecated: since 1.32, just use getTargetLanguage()

Returns: Language

Definition at line 1056 of file Parser.php.

References wfDeprecated().

◆ getCustomDefaultSort()

Parser::getCustomDefaultSort ( )

Accessor for $mDefaultSort Unlike getDefaultSort(), will return false if none is set.

Returns: string|bool

Definition at line 6400 of file Parser.php.

◆ getDefaultPreprocessorClass()

static Parser::getDefaultPreprocessorClass ( )

static

Which class should we use for the preprocessor if not otherwise specified?

Since: 1.34

Deprecated: since 1.34, removing configurability of preprocessor

Returns: string

Definition at line 457 of file Parser.php.

◆ getDefaultSort()

Parser::getDefaultSort ( )

Accessor for $mDefaultSort Will use the empty string if none is set.

This value is treated as a prefix, so the empty string is equivalent to sorting by page name.

Returns: string

Definition at line 6386 of file Parser.php.

◆ getExternalLinkAttribs()

Parser::getExternalLinkAttribs ( $url )

Get an associative array of additional HTML attributes appropriate for a particular external link.

This currently may include rel => nofollow (depending on configuration, namespace, and the URL's domain) and/or a target attribute (depending on configuration).

Definition at line 2188 of file Parser.php.

◆ getExternalLinkRel()

static Parser::getExternalLinkRel	(		$url = false,
			$title = null )

static

Get the rel attribute for a particular external link.

Since: 1.21

Definition at line 2166 of file Parser.php.

References $title, $wgNoFollowDomainExceptions, $wgNoFollowLinks, $wgNoFollowNsExceptions, and wfMatchesDomainList().

◆ getFreshParser()

Parser::getFreshParser ( )

Return this parser if it is not doing anything, otherwise get a fresh parser.

You can use this method by doing $newParser = $oldParser->getFreshParser(), or more simply $oldParser->getFreshParser()->parse( ... ); if you're unsure if $oldParser is safe to use.

Since: 1.24

Returns: Parser A parser object that is not parsing anything

Definition at line 6816 of file Parser.php.

◆ getFunctionHooks()

Parser::getFunctionHooks ( )

Get all registered function hook identifiers.

Returns: array

Definition at line 5319 of file Parser.php.

◆ getFunctionLang()

Parser::getFunctionLang ( )

Get a language object for use in parser functions such as {{FORMATNUM:}}.

Returns: Language

Definition at line 1024 of file Parser.php.

Referenced by MediaWiki\Extensions\ParserFunctions\ParserFunctions\timeCommon().

◆ getFunctionSynonyms()

Parser::getFunctionSynonyms ( )

Since: 1.32

Returns: array

Definition at line 6022 of file Parser.php.

◆ getImageParams()

Parser::getImageParams ( $handler )

Parameters

MediaHandler $handler

Returns: array

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 5574 of file Parser.php.

References wfDeprecated().

◆ getImageParamsPrivate()

Parser::getImageParamsPrivate ( $handler )

private

Parameters

MediaHandler $handler

Returns: array

Definition at line 5583 of file Parser.php.

References $type.

◆ getLinkRenderer()

Parser::getLinkRenderer ( )

Get a LinkRenderer instance to make links with.

Since: 1.28

Returns: LinkRenderer

Definition at line 1093 of file Parser.php.

◆ getMagicWordFactory()

Parser::getMagicWordFactory ( )

Get the MagicWordFactory that this Parser is using.

Since: 1.32

Returns: MagicWordFactory

Definition at line 1111 of file Parser.php.

Referenced by MediaWiki\Extensions\ParserFunctions\ParserFunctions\switch().

◆ getOptions()

Parser::getOptions ( )

Get the ParserOptions object.

Returns: ParserOptions

Definition at line 992 of file Parser.php.

Referenced by Cite\guardedRef(), and MediaWiki\Extensions\ParserFunctions\ParserFunctions\timeCommon().

◆ getOutput()

Parser::getOutput ( )

Get the ParserOutput object.

Returns: ParserOutput

Definition at line 983 of file Parser.php.

Referenced by CoreTagHooks\indicator(), ScribuntoHooks\invokeHook(), PageImages\Hooks\ParserFileProcessingHookHandlers\processFile(), and Cite\ref().

◆ getPreloadText()

Parser::getPreloadText	(		$text,
		Title	$title,
		ParserOptions	$options,
			$params = [] )

Process the wikitext for the "?preload=" feature.

(T7210)

"<noinclude>", "<includeonly>" etc. are parsed as for template transclusion, comments, templates, arguments, tags hooks and parser functions are untouched.

Parameters

string	$text
Title	$title
ParserOptions	$options
array	$params

Returns: string

Definition at line 885 of file Parser.php.

References $title, getPreprocessor(), lock(), preprocessToDom(), and startParse().

◆ getPreprocessor()

Parser::getPreprocessor ( )

Get a preprocessor object.

Returns: Preprocessor

Definition at line 1079 of file Parser.php.

Referenced by getPreloadText().

◆ getRevisionId()

Parser::getRevisionId ( )

Get the ID of the revision we are parsing.

The return value will be either:

a) Positive, indicating a specific revision ID (current or old)
b) Zero, meaning the revision ID is specified by getCurrentRevisionCallback()
c) Null, meaning the parse is for preview mode and there is no revision

Returns: int|null

Definition at line 6251 of file Parser.php.

◆ getRevisionObject()

Parser::getRevisionObject ( )

Get the revision object for $this->mRevisionId.

Returns: Revision|null Either a Revision object or null

Since: 1.23 (public since 1.23)

Definition at line 6261 of file Parser.php.

◆ getRevisionSize()

Parser::getRevisionSize ( )

Get the size of the revision.

Returns: int|null Revision size

Definition at line 6350 of file Parser.php.

◆ getRevisionTimestamp()

Parser::getRevisionTimestamp ( )

Get the timestamp associated with the current revision, adjusted for the default server-local timestamp.

Returns: string TS_MW timestamp

Definition at line 6305 of file Parser.php.

◆ getRevisionTimestampSubstring()

Parser::getRevisionTimestampSubstring	(	$start,
		$len,
		$mtts,
		$variable )

private

Parameters

int	$start
int	$len
int	$mtts	Max time-till-save; sets vary-revision-timestamp if result changes by then
string	$variable	Parser variable name

Returns: string

Definition at line 3194 of file Parser.php.

References wfTimestamp().

◆ getRevisionUser()

Parser::getRevisionUser ( )

Get the name of the user that edited the last revision.

Returns: string User name

Definition at line 6330 of file Parser.php.

References getUser().

◆ getSection()

Parser::getSection	(	$text,
		$sectionId,
		$defaultText = '' )

This function returns the text of a section, specified by a number ($section).

A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or the first section before any such heading (section 0).

If a section contains subsections, these are also returned.

Parameters

string	$text	Text to look in
string \| int	$sectionId	Section identifier as a number or string (e.g. 0, 1 or 'T-1').
string	$defaultText	Default to return if section is not found

Returns: string Text of the requested section

Definition at line 6221 of file Parser.php.

◆ getSectionNameFromStrippedText()

static Parser::getSectionNameFromStrippedText ( $text )

staticprivate

Definition at line 6404 of file Parser.php.

◆ getStripList()

Parser::getStripList ( )

Get a list of strippable XML-like elements.

Returns: array

Definition at line 1207 of file Parser.php.

◆ getStripState()

Parser::getStripState ( )

Get the StripState.

Returns: StripState

Definition at line 1216 of file Parser.php.

◆ getTags()

Parser::getTags ( )

Accessor.

Returns: array

Definition at line 6009 of file Parser.php.

◆ getTargetLanguage()

Parser::getTargetLanguage ( )

Get the target language for the content being parsed.

This is usually the language that the content is in.

Since: 1.19

Exceptions

MWException

Returns: Language

Definition at line 1037 of file Parser.php.

Referenced by Linker\makeImageLink(), and parse().

◆ getTemplateDom()

Parser::getTemplateDom ( $title )

Get the semi-parsed DOM representation of a template with a given title, and its redirect destination title.

Cached.

Parameters

Title $title

Returns: array

Definition at line 3861 of file Parser.php.

References $title.

◆ getTitle()

Parser::getTitle ( )

Accessor for the Title object.

Since 1.34, leaving mTitle uninitialized as null is deprecated.

Returns: Title|null

Definition at line 935 of file Parser.php.

References wfDeprecated().

Referenced by Scribunto\getParserEngine(), PageImages\Hooks\ParserFileProcessingHookHandlers\processFile(), and MediaWiki\Extensions\ParserFunctions\ParserFunctions\rel2abs().

◆ getUrlProtocols()

Parser::getUrlProtocols ( )

Since: 1.32

Returns: string

Definition at line 6031 of file Parser.php.

◆ getUser()

Parser::getUser ( )

Get a User object either from $this->mUser, if set, or from the ParserOptions object otherwise.

Returns: User

Definition at line 1067 of file Parser.php.

◆ getUserSig()

Parser::getUserSig	(	&	$user,
			$nickname = false,
			$fancySig = null )

Fetch the user's signature text, if any, and normalize to validated, ready-to-insert wikitext.

If you have pre-fetched the nickname or the fancySig option, you can specify them here to save a database query. Do not reuse this parser instance after calling getUserSig(), as it may have changed.

Parameters

User	&$user
string \| bool	$nickname	Nickname to use or false to use user's default nickname
bool \| null	$fancySig	whether the nicknname is the complete signature or null to use default value

Returns: string

Definition at line 4998 of file Parser.php.

References getTitle(), wfEscapeWikiText(), and wfMessage().

◆ getVariableValue()

Parser::getVariableValue	(		$index,
			$frame = false )

Return value of a magic variable (like PAGENAME)

Access:\n private

Parameters

string	$index	Magic variable identifier as mapped in MagicWordFactory::$mVariableIDs
bool \| PPFrame	$frame

Exceptions

MWException

Returns: string

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 2824 of file Parser.php.

References wfDeprecated().

◆ guessLegacySectionNameFromWikiText()

Parser::guessLegacySectionNameFromWikiText ( $text )

Same as guessSectionNameFromWikiText(), but produces legacy anchors instead, if possible.

For use in redirects, since various versions of Microsoft browsers interpret Location: headers as something other than UTF-8, resulting in breakage.

Parameters

string $text The section name

Returns: string Anchor (starting with '#')

Definition at line 6451 of file Parser.php.

◆ guessSectionNameFromStrippedText()

static Parser::guessSectionNameFromStrippedText ( $text )

static

Like guessSectionNameFromWikiText(), but takes already-stripped text as input.

Parameters

string $text Section name (plain text)

Returns: string Anchor (starting with '#')

Definition at line 6463 of file Parser.php.

◆ guessSectionNameFromWikiText()

Parser::guessSectionNameFromWikiText ( $text )

Try to guess the section anchor name based on a wikitext fragment presumably extracted from a heading, for example "Header" from "== Header ==".

Parameters

string $text

Returns: string Anchor (starting with '#')

Definition at line 6435 of file Parser.php.

◆ handleAllQuotes()

Parser::handleAllQuotes ( $text )

private

Replace single quotes with HTML markup.

Parameters

string $text

Returns: string The altered text

Definition at line 1867 of file Parser.php.

References $line, and $lines.

◆ handleDoubleUnderscore()

Parser::handleDoubleUnderscore ( $text )

private

Strip double-underscore items like NOGALLERY and NOTOC Fills $this->mDoubleUnderscores, returns the modified text.

Parameters

string $text

Returns: string

Definition at line 4393 of file Parser.php.

References NS_CATEGORY.

◆ handleExternalLinks()

Parser::handleExternalLinks ( $text )

private

Replace external links (REL)

Note: this is all very hackish and the order of execution matters a lot. Make sure to run tests/parser/parserTests.php if you change this code.

Parameters

string $text

Exceptions

MWException

Returns: string

Definition at line 2086 of file Parser.php.

References $s, Linker\makeExternalLink(), Linker\splitTrail(), and wfUrlProtocolsWithoutProtRel().

◆ handleHeadings()

Parser::handleHeadings ( $text )

private

Parse headers and return html.

Parameters

string $text

Returns: string

Definition at line 1836 of file Parser.php.

◆ handleInternalLinks()

Parser::handleInternalLinks ( $text )

private

Process [[ ]] wikilinks.

Parameters

string $text

Returns: string Processed text

Definition at line 2372 of file Parser.php.

◆ handleInternalLinks2()

Parser::handleInternalLinks2 ( & $s )

private

Process [[ ]] wikilinks (RIL)

Parameters

string &$s

Exceptions

MWException

Returns: LinkHolderArray

Definition at line 2397 of file Parser.php.

References $line, $s, Linker\normalizeSubpageLink(), NS_CATEGORY, and NS_FILE.

◆ handleMagicLinks()

Parser::handleMagicLinks ( $text )

private

Replace special strings like "ISBN xxx" and "RFC xxx" with magic external links.

DML

Parameters

string $text

Returns: string

Definition at line 1648 of file Parser.php.

References wfUrlProtocolsWithoutProtRel().

◆ handleTables()

Parser::handleTables ( $text )

private

Parse the wiki syntax used to render tables.

Parameters

string $text

Returns: string

Definition at line 1255 of file Parser.php.

References $line, $lines, and $matches.

◆ incrementExpensiveFunctionCount()

Parser::incrementExpensiveFunctionCount ( )

Increment the expensive function count.

Returns: bool False if the limit has been exceeded

Definition at line 4368 of file Parser.php.

Referenced by MediaWiki\Extensions\ParserFunctions\ParserFunctions\ifexistInternal().

◆ incrementIncludeSize()

Parser::incrementIncludeSize	(		$type,
			$size )

Increment an include size counter.

Parameters

string	$type	The type of expansion
int	$size	The size of the text

Returns: bool False if this inclusion would take it over the maximum, true otherwise

Definition at line 4354 of file Parser.php.

References $type.

◆ initialiseVariables()

Parser::initialiseVariables ( )

initialise the magic variables (like CURRENTMONTHNAME) and substitution modifiers

Access:\n private

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 3225 of file Parser.php.

References wfDeprecated().

◆ initializeVariables()

Parser::initializeVariables ( )

private

Initialize the magic variables (like CURRENTMONTHNAME) and substitution modifiers.

Definition at line 3234 of file Parser.php.

Referenced by firstCallInit().

◆ insertStripItem()

Parser::insertStripItem ( $text )

Add an item to the strip state Returns the unique tag which must be inserted into the stripped text The tag will be replaced with the original text in unstrip()

Parameters

string $text

Returns: string

Definition at line 1229 of file Parser.php.

Referenced by Poem\renderPoem().

◆ internalParse()

Parser::internalParse	(	$text,
		$isMain = true,
		$frame = false )

Helper function for parse() that transforms wiki markup into half-parsed HTML.

Only called for $mOutputType == self::OT_HTML.

Access:\n private

Parameters

string	$text	The text to parse
-taint	$text	escapes_html
bool	$isMain	Whether this is being called from the main parse() function
PPFrame \| bool	$frame	A pre-processor frame

Returns: string

Definition at line 1465 of file Parser.php.

Referenced by parse(), and recursiveTagParse().

◆ internalParseHalfParsed()

Parser::internalParseHalfParsed	(	$text,
		$isMain = true,
		$linestart = true )

private

Helper function for parse() that transforms half-parsed HTML into fully parsed HTML.

Parameters

string	$text
bool	$isMain
bool	$linestart

Returns: string

Definition at line 1537 of file Parser.php.

References wfDeprecated().

Referenced by parse(), and recursiveTagParseFully().

◆ interwikiTransclude()

Parser::interwikiTransclude	(		$title,
			$action )

Transclude an interwiki link.

Parameters

Title	$title
string	$action	Usually one of (raw, render)

Returns: string

Definition at line 4131 of file Parser.php.

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

◆ isCurrentRevisionOfTitleCached()

Parser::isCurrentRevisionOfTitleCached ( $title )

Parameters

Title $title

Returns: bool

Since: 1.34

Definition at line 3923 of file Parser.php.

References $title.

◆ isValidHalfParsedText()

Parser::isValidHalfParsedText ( $data )

Returns true if the given array, presumed to be generated by serializeHalfParsedText(), is compatible with the current version of the parser.

Deprecated: since 1.31

Parameters

array $data

Returns: bool

Definition at line 6726 of file Parser.php.

References wfDeprecated().

◆ killMarkers()

Parser::killMarkers ( $text )

Remove any strip markers found in the given text.

Parameters

string $text

Returns: string

Definition at line 6651 of file Parser.php.

◆ limitationWarn()

Parser::limitationWarn	(	$limitationType,
		$current = '',
		$max = '' )

Warn the user when a parser limitation is reached Will warn at most once the user per limitation type.

The results are shown during preview and run through the Parser (See EditPage.php)

Parameters

string	$limitationType	Should be one of: 'expensive-parserfunction' (corresponding messages: 'expensive-parserfunction-warning', 'expensive-parserfunction-category') 'post-expand-template-argument' (corresponding messages: 'post-expand-template-argument-warning', 'post-expand-template-argument-category') 'post-expand-template-inclusion' (corresponding messages: 'post-expand-template-inclusion-warning', 'post-expand-template-inclusion-category') 'node-count-exceeded' (corresponding messages: 'node-count-exceeded-warning', 'node-count-exceeded-category') 'expansion-depth-exceeded' (corresponding messages: 'expansion-depth-exceeded-warning', 'expansion-depth-exceeded-category')
string \| int \| null	$current	Current value
string \| int \| null	$max	Maximum allowed, when an explicit limit has been exceeded, provide the values (optional)

Definition at line 3392 of file Parser.php.

References wfMessage().

Referenced by parse().

◆ lock()

Parser::lock ( )

protected

Lock the current instance of the parser.

This is meant to stop someone from calling the parser recursively and messing up all the strip state.

Exceptions

MWException If parser is in a parse

Returns: ScopedCallback The lock will be released once the return value goes out of scope.

Definition at line 6769 of file Parser.php.

Referenced by getPreloadText(), parse(), and preprocess().

◆ magicLinkCallback()

Parser::magicLinkCallback ( $m )

Exceptions

MWException

Parameters

array $m

Returns: string HTML

Definition at line 1679 of file Parser.php.

References Linker\makeExternalLink(), and wfMessage().

◆ makeAnchor()

static Parser::makeAnchor ( $sectionName )

staticprivate

Definition at line 6411 of file Parser.php.

◆ makeFreeExternalLink()

Parser::makeFreeExternalLink	(		$url,
			$numPostProto )

Make a free external link, given a user-supplied URL.

Parameters

string	$url
int	$numPostProto	The number of characters after the protocol.

Returns: string HTML

Access:\n private

Definition at line 1751 of file Parser.php.

References Linker\makeExternalLink().

◆ makeImage()

Parser::makeImage	(	$title,
		$options,
		$holders = false )

Parse image options text and use it to make an image.

Parameters

Title	$title
string	$options
LinkHolderArray \| bool	$holders

Returns: string HTML

Definition at line 5637 of file Parser.php.

References $file, $title, $type, and Linker\makeImageLink().

◆ makeKnownLinkHolder()

Parser::makeKnownLinkHolder	(	$nt,
		$text = '',
		$trail = '',
		$prefix = '' )

protected

Render a forced-blue link inline; protect against double expansion of URLs if we're in a mode that prepends full URL prefixes to internal links.

Since this little disaster has to split off the trail text to avoid breaking URLs in the following text without breaking trails on the wiki links, it's been made into a horrible function.

Parameters

Title	$nt
string	$text
string	$trail
string	$prefix

Returns: string HTML-wikitext mix oh yuck

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 2712 of file Parser.php.

References wfDeprecated().

◆ makeKnownLinkHolderPrivate()

Parser::makeKnownLinkHolderPrivate	(	$nt,
		$text = '',
		$trail = '',
		$prefix = '' )

private

Render a forced-blue link inline; protect against double expansion of URLs if we're in a mode that prepends full URL prefixes to internal links.

Since this little disaster has to split off the trail text to avoid breaking URLs in the following text without breaking trails on the wiki links, it's been made into a horrible function.

Parameters

Title	$nt
string	$text
string	$trail
string	$prefix

Returns: string HTML-wikitext mix oh yuck

Definition at line 2730 of file Parser.php.

References Linker\splitTrail().

◆ makeLegacyAnchor()

Parser::makeLegacyAnchor ( $sectionName )

private

Definition at line 6415 of file Parser.php.

◆ makeLimitReport()

Parser::makeLimitReport ( )

protected

Set the limit report data in the current ParserOutput, and return the limit report HTML comment.

Returns: string

Definition at line 661 of file Parser.php.

References wfDebugLog(), wfHostname(), and wfMessage().

Referenced by parse().

◆ markerSkipCallback()

Parser::markerSkipCallback	(		$s,
			$callback )

Call a callback function on all regions of the given text that are not inside strip markers, and replace those regions with the return value of the callback.

For example, with input:

aaa<MARKER>bbb

This will call the callback function twice, with 'aaa' and 'bbb'. Those two strings will be replaced with the value returned by the callback in each case.

Parameters

string	$s
callable	$callback

Returns: string

Definition at line 6621 of file Parser.php.

References $s.

◆ maybeDoSubpageLink()

Parser::maybeDoSubpageLink	(		$target,
		&	$text )

Handle link to subpage if necessary.

Parameters

string	$target	The source of the link
string	&$text	The link text, modified as necessary

Returns: string The full name of the link

Access:\n private

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 2795 of file Parser.php.

References Linker\normalizeSubpageLink(), and wfDeprecated().

◆ maybeMakeExternalImage()

Parser::maybeMakeExternalImage ( $url )

private

make an image if it's allowed, either through the global option, through the exception, or through the on-wiki whitelist

Parameters

string $url

Returns: string

Definition at line 2300 of file Parser.php.

References Linker\makeExternalImage(), and wfMessage().

◆ nextLinkID()

Parser::nextLinkID ( )

Returns: int

Definition at line 1009 of file Parser.php.

◆ normalizeLinkUrl()

static Parser::normalizeLinkUrl ( $url )

static

Replace unusual escape codes in a URL with their equivalent characters.

This generally follows the syntax defined in RFC 3986, with special consideration for HTTP query strings.

Definition at line 2219 of file Parser.php.

◆ normalizeSectionName()

static Parser::normalizeSectionName ( $text )

staticprivate

Apply the same normalization as code making links to this section would.

Parameters

string $text

Returns: string

Definition at line 6474 of file Parser.php.

◆ normalizeUrlComponent()

static Parser::normalizeUrlComponent	(		$component,
			$unsafe )

staticprivate

Definition at line 2277 of file Parser.php.

References $matches.

◆ Options()

Parser::Options ( $x = null )

Accessor/mutator for the ParserOptions object.

Parameters

ParserOptions | null $x New value or null to just get the current one

Returns: ParserOptions Current ParserOptions object

Definition at line 1002 of file Parser.php.

References wfSetVar().

◆ OutputType()

Parser::OutputType ( $x = null )

Accessor/mutator for the output type.

Parameters

int | null $x New value or null to just get the current one

Returns: int

Definition at line 974 of file Parser.php.

References wfSetVar().

◆ parse()

Parser::parse	(		$text,
		Title	$title,
		ParserOptions	$options,
			$linestart = true,
			$clearState = true,
			$revid = null )

Convert wikitext to HTML Do not call this function recursively.

Parameters

string	$text	Text we want to parse
-taint	$text	escapes_htmlnoent
Title	$title
ParserOptions	$options
bool	$linestart
bool	$clearState
int \| null	$revid	ID of the revision being rendered. This is used to render REVISION* magic words. 0 means that any current revision will be used. Null means that {{REVISIONID}}/{{REVISIONUSER}} will be empty and {{REVISIONTIMESTAMP}} will use the current timestamp.

Returns: ParserOutput A ParserOutput; -taint escaped

Definition at line 554 of file Parser.php.

References $title, ParserOptions\getDisableTitleConversion(), getTargetLanguage(), internalParse(), internalParseHalfParsed(), limitationWarn(), lock(), makeLimitReport(), and startParse().

◆ parseLinkParameter()

Parser::parseLinkParameter ( $value )

Parse the value of 'link' parameter in image syntax ([[File:Foo.jpg|link=<value>]]).

Adds an entry to appropriate link tables.

Since: 1.32

Parameters

string $value

Returns

array of [ type, target ], where:

type is one of:
- null: Given value is not a valid link target, use default
- ‘'no-link’: Given value is empty, do not generate a link -'link-url': Given value is a valid external link -'link-title': Given value is a valid internal link -targetis:
- Whentypeisnullor'no-link':false
- Whentypeis'link-url': URL string corresponding to given value
- Whentypeis'link-title'`: Title object corresponding to given value

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 5858 of file Parser.php.

References wfDeprecated().

◆ parseLinkParameterPrivate()

Parser::parseLinkParameterPrivate ( $value )

private

Parse the value of 'link' parameter in image syntax ([[File:Foo.jpg|link=<value>]]).

Adds an entry to appropriate link tables.

Since: 1.32

Parameters

string $value

Returns

array of [ type, target ], where:

type is one of:
- null: Given value is not a valid link target, use default
- ‘'no-link’: Given value is empty, do not generate a link -'link-url': Given value is a valid external link -'link-title': Given value is a valid internal link -targetis:
- Whentypeisnullor'no-link':false
- Whentypeis'link-url': URL string corresponding to given value
- Whentypeis'link-title'`: Title object corresponding to given value

Definition at line 5881 of file Parser.php.

References $chars, and $type.

◆ parseWidthParam()

static Parser::parseWidthParam	(		$value,
			$parseHeight = true )

static

Parsed a width param of imagelink like 300px or 200x300px.

Parameters

string	$value
bool	$parseHeight

Returns: array

Since: 1.20

Definition at line 6740 of file Parser.php.

◆ preprocess()

Parser::preprocess	(		$text,
		Title	$title = null,
		ParserOptions	$options,
			$revid = null,
			$frame = false )

Expand templates and variables in the text, producing valid, static wikitext.

Also removes comments. Do not call this function recursively.

Parameters

string	$text
Title \| null	$title
ParserOptions	$options
int \| null	$revid
bool \| PPFrame	$frame

Returns: mixed|string

Definition at line 840 of file Parser.php.

References $title, lock(), replaceVariables(), and startParse().

◆ preprocessToDom()

Parser::preprocessToDom	(		$text,
			$flags = 0 )

Preprocess some wikitext and return the document tree.

This is the ghost of replace_variables().

Parameters

string	$text	The text to parse
int	$flags	Bitwise combination of: self::PTD_FOR_INCLUSION: Handle "<noinclude>" and "<includeonly>" as if the text is being included. Default is to assume a direct page view.

The generated DOM tree must depend only on the input text and the flags. The DOM tree must be the same in OT_HTML and OT_WIKI mode, to avoid a regression of T6899.

Any flag added to the $flags parameter here, or any other parameter liable to cause a change in the DOM tree for a given text, must be passed through the section identifier in the section edit link and thus back to extractSections().

The output of this function is currently only cached in process memory, but a persistent cache may be implemented at a later date which takes further advantage of these strict dependency requirements.

Returns: PPNode

Definition at line 3264 of file Parser.php.

Referenced by getPreloadText().

◆ preSaveTransform()

Parser::preSaveTransform	(		$text,
		Title	$title,
		User	$user,
		ParserOptions	$options,
			$clearState = true )

Transform wiki markup when saving a page by doing "\\r\\n" -> "\\n" conversion, substituting signatures, {{subst:}} templates, etc.

Parameters

string	$text	The text to transform
Title	$title	The Title object for the current article
User	$user	The User object describing the current user
ParserOptions	$options	Parsing options
bool	$clearState	Whether to clear the parser state first

Returns: string The altered wiki markup

Definition at line 4887 of file Parser.php.

References $title, ParserOptions\getPreSaveTransform(), and TextContent\normalizeLineEndings().

◆ pstPass2()

Parser::pstPass2	(		$text,
			$user )

private

Pre-save transform helper function.

Parameters

string	$text
User	$user

Returns: string

Definition at line 4922 of file Parser.php.

References $t.

◆ recursivePreprocess()

Parser::recursivePreprocess	(		$text,
			$frame = false )

Recursive parser entry point that can be called from an extension tag hook.

Parameters

string	$text	Text to be expanded
bool \| PPFrame	$frame	The frame to use for expanding any template variables

Returns: string

Since: 1.19

Definition at line 866 of file Parser.php.

References replaceVariables().

◆ recursiveTagParse()

Parser::recursiveTagParse	(		$text,
			$frame = false )

Half-parse wikitext to half-parsed HTML.

This recursive parser entry point can be called from an extension tag hook.

The output of this function IS NOT SAFE PARSED HTML; it is "half-parsed" instead, which means that lists and links have not been fully parsed yet, and strip markers are still present.

Use recursiveTagParseFully() to fully parse wikitext to output-safe HTML.

Use this function if you're a parser tag hook and you want to parse wikitext before or after applying additional transformations, and you intend to return the result as hook output, which will cause it to go through the rest of parsing process automatically.

If $frame is not provided, then template variables (e.g., {{{1}}}) within $text are not expanded

Parameters

string	$text	Text extension wants to have parsed
-taint	$text	escapes_htmlnoent
bool \| PPFrame	$frame	The frame to use for expanding any template variables

Returns: string UNSAFE half-parsed HTML; -taint escaped

Definition at line 795 of file Parser.php.

References internalParse().

Referenced by Cite\guardedReferences(), recursiveTagParseFully(), and Poem\renderPoem().

◆ recursiveTagParseFully()

Parser::recursiveTagParseFully	(		$text,
			$frame = false )

Fully parse wikitext to fully parsed HTML.

This recursive parser entry point can be called from an extension tag hook.

The output of this function is fully-parsed HTML that is safe for output. If you're a parser tag hook, you might want to use recursiveTagParse() instead.

If $frame is not provided, then template variables (e.g., {{{1}}}) within $text are not expanded

Since: 1.25

Parameters

string	$text	Text extension wants to have parsed
-taint	$text	escapes_htmlnoent
bool \| PPFrame	$frame	The frame to use for expanding any template variables

Returns: string Fully parsed HTML; -taint escaped

Definition at line 823 of file Parser.php.

References internalParseHalfParsed(), and recursiveTagParse().

Referenced by CoreTagHooks\indicator().

◆ renderImageGallery()

Parser::renderImageGallery	(		$text,
			$params )

Renders an image gallery from a text with one line per image.

text labels may be given by using |-style alternative text. E.g. Image:one.jpg|The number "1" Image:tree.jpg|A tree given as text will return the HTML of a gallery with two images, labeled 'The number "1"' and 'A tree'.

Parameters

string	$text
array	$params

Returns: string HTML

Definition at line 5409 of file Parser.php.

References $file, $line, $lines, $matches, $title, $type, and NS_FILE.

◆ replaceExternalLinks()

Parser::replaceExternalLinks ( $text )

Replace external links (REL)

Note: this is all very hackish and the order of execution matters a lot. Make sure to run tests/parser/parserTests.php if you change this code.

Access:\n private

Parameters

string $text

Exceptions

MWException

Returns: string

Definition at line 2071 of file Parser.php.

References wfDeprecated().

◆ replaceInternalLinks()

Parser::replaceInternalLinks ( $text )

Process [[ ]] wikilinks.

Parameters

string $text

Returns: string Processed text

Access:\n private

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 2360 of file Parser.php.

References wfDeprecated().

◆ replaceInternalLinks2()

Parser::replaceInternalLinks2 ( & $text )

Process [[ ]] wikilinks (RIL)

Parameters

string &$text

Exceptions

MWException

Returns: LinkHolderArray

Access:\n private

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 2386 of file Parser.php.

References wfDeprecated().

◆ replaceLinkHolders()

Parser::replaceLinkHolders	(	&	$text,
			$options = 0 )

Replace "" link placeholders with actual links, in the buffer Placeholders created in Linker::link()

Parameters

string	&$text
int	$options

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 5357 of file Parser.php.

◆ replaceLinkHoldersPrivate()

Parser::replaceLinkHoldersPrivate	(	&	$text,
			$options = 0 )

private

Replace "" link placeholders with actual links, in the buffer Placeholders created in Linker::link()

Parameters

string	&$text
int	$options

Definition at line 5368 of file Parser.php.

◆ replaceLinkHoldersText()

Parser::replaceLinkHoldersText ( $text )

Replace "" link placeholders with plain text of links (not HTML-formatted).

Parameters

string $text

Returns: string

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 5380 of file Parser.php.

References wfDeprecated().

◆ replaceLinkHoldersTextPrivate()

Parser::replaceLinkHoldersTextPrivate ( $text )

private

Replace "" link placeholders with plain text of links (not HTML-formatted).

Parameters

string $text

Returns: string

Definition at line 5392 of file Parser.php.

◆ replaceSection()

Parser::replaceSection	(	$oldText,
		$sectionId,
		$newText )

This function returns $oldtext after the content of the section specified by $section has been replaced with $text.

If the target section does not exist, $oldtext is returned unchanged.

Parameters

string	$oldText	Former text of the article
string \| int	$sectionId	Section identifier as a number or string (e.g. 0, 1 or 'T-1').
string	$newText	Replacing text

Returns: string Modified text

Definition at line 6237 of file Parser.php.

◆ replaceTransparentTags()

Parser::replaceTransparentTags ( $text )

Replace transparent tags in $text with the values given by the callbacks.

Transparent tag hooks are like regular XML-style tag hooks, except they operate late in the transformation sequence, on HTML instead of wikitext.

Parameters

string $text

Returns: string

Definition at line 6045 of file Parser.php.

References $content, and $matches.

◆ replaceVariables()

Parser::replaceVariables	(	$text,
		$frame = false,
		$argsOnly = false )

Replace magic variables, templates, and template arguments with the appropriate text.

Templates are substituted recursively, taking care to avoid infinite loops.

Note that the substitution depends on value of $mOutputType: self::OT_WIKI: only {{subst:}} templates self::OT_PREPROCESS: templates but not extension tags self::OT_HTML: all templates and extension tags

Parameters

string	$text	The text to transform
false \| PPFrame \| array	$frame	Object describing the arguments passed to the template. Arguments may also be provided as an associative array, as was the usual case before MW1.12. Providing arguments this way may be useful for extensions wishing to perform variable replacement explicitly.
bool	$argsOnly	Only do argument (triple-brace) expansion, not double-brace expansion.

Returns: string

Definition at line 3311 of file Parser.php.

Referenced by preprocess(), recursivePreprocess(), and InputBoxHooks\render().

◆ resetOutput()

Parser::resetOutput ( )

Reset the ParserOutput.

Definition at line 532 of file Parser.php.

Referenced by clearState().

◆ serializeHalfParsedText()

Parser::serializeHalfParsedText ( $text )

Save the parser state required to convert the given half-parsed text to HTML.

"Half-parsed" in this context means the output of recursiveTagParse() or internalParse(). This output has strip markers from replaceVariables (extensionSubstitution() etc.), and link placeholders from replaceLinkHolders().

Returns an array which can be serialized and stored persistently. This array can later be loaded into another parser instance with unserializeHalfParsedText(). The text can then be safely incorporated into the return value of a parser hook.

Deprecated: since 1.31

Parameters

string $text

Returns: array

Definition at line 6672 of file Parser.php.

References wfDeprecated().

◆ setDefaultSort()

Parser::setDefaultSort ( $sort )

Mutator for $mDefaultSort.

Parameters

string $sort New value

Definition at line 6371 of file Parser.php.

References $sort.

◆ setFunctionHook()

Parser::setFunctionHook	(		$id,
		callable	$callback,
			$flags = 0 )

Create a function, e.g.

{{sum:1|2|3}} The callback function should have the form: function myParserFunction( &$parser, $arg1, $arg2, $arg3 ) { ... }

Or with Parser::SFH_OBJECT_ARGS: function myParserFunction( $parser, $frame, $args ) { ... }

The callback may either return the text result of the function, or an array with the text in element 0, and a number of flags in the other elements. The names of the flags are specified in the keys. Valid flags are: found The text returned is valid, stop processing the template. This is on by default. nowiki Wiki markup in the return value should be escaped isHTML The returned text is HTML, armour it against wikitext transformation

Parameters

string	$id	The magic word ID
callable	$callback	The callback function (and object) to use
int	$flags	A combination of the following flags: Parser::SFH_NO_HASH No leading hash, i.e. {{plural:...}} instead of {{if:...}}

Parser::SFH_OBJECT_ARGS Pass the template arguments as PPNode objects instead of text. This allows for conditional expansion of the parse tree, allowing you to eliminate dead branches and thus speed up parsing. It is also possible to analyse the parse tree of the arguments, and to control the way they are expanded.

The $frame parameter is a PPFrame. This can be used to produce expanded text from the arguments, for instance: $text = isset( $args[0] ) ? $frame->expand( $args[0] ) : '';

For technical reasons, $args[0] is pre-expanded and will be a string. This may change in future versions. Please call $frame->expand() on it anyway so that your code keeps working if/when this is changed.

If you want whitespace to be trimmed from $args, you need to do it yourself, post- expansion.

Please read the documentation in includes/parser/Preprocessor.php for more information about the methods available in PPFrame and PPNode.

Exceptions

MWException

Returns: string|callable The old callback function for this name, if any

Definition at line 5283 of file Parser.php.

Referenced by MediaWiki\Extensions\ParserFunctions\Hooks\onParserFirstCallInit(), CategoryTreeHooks\setHooks(), and ScribuntoHooks\setupParserHook().

◆ setFunctionTagHook()

Parser::setFunctionTagHook	(		$tag,
		callable	$callback,
			$flags )

Create a tag function, e.g.

"<test>some stuff</test>". Unlike tag hooks, tag functions are parsed at preprocessor level. Unlike parser functions, their content is not preprocessed.

Parameters

string	$tag
callable	$callback
int	$flags

Exceptions

MWException

Returns: null

Definition at line 5334 of file Parser.php.

◆ setHook()

Parser::setHook	(		$tag,
		callable	$callback )

Create an HTML-style tag, e.g.

"<yourtag>special text</yourtag>" The callback should have the following form: function myParserHook( $text, $params, $parser, $frame ) { ... }

Transform and return $text. Use $parser for any required context, e.g. use $parser->getTitle() and $parser->getOptions() not $wgTitle or $wgOut->mParserOptions

Hooks may return extended information by returning an array, of which the first numbered element (index 0) must be the return string, and all other entries are extracted into local variables within an internal function in the Parser class.

This interface (introduced r61913) appears to be undocumented, but 'markerType' is used by some core tag hooks to override which strip array their results are placed in. Use great caution if attempting this interface, as it is not documented and injudicious use could smash private variables.

Parameters

string	$tag	The tag to use, e.g. 'hook' for "<hook>"
callable	$callback	The callback function (and object) to use for the tag

Exceptions

MWException

Returns: callable|null The old value of the mTagHooks array associated with the hook

Definition at line 5189 of file Parser.php.

Referenced by Cite\cloneState(), Poem\init(), ImageMap\onParserFirstCallInit(), SyntaxHighlight\onParserFirstCallInit(), CategoryTreeHooks\setHooks(), and Cite\setHooks().

◆ setLinkID()

Parser::setLinkID ( $id )

Parameters

int $id

Definition at line 1016 of file Parser.php.

◆ setOutputFlag()

Parser::setOutputFlag	(		$flag,
			$reason )

protected

Parameters

string	$flag
string	$reason

Definition at line 6839 of file Parser.php.

◆ setOutputType()

Parser::setOutputType ( $ot )

Set the output type.

Parameters

int $ot New value

Definition at line 957 of file Parser.php.

References OT_HTML, OT_PLAIN, OT_PREPROCESS, and OT_WIKI.

◆ setTitle()

Parser::setTitle ( Title $t = null )

Set the context title.

Parameters

Title | null $t

Definition at line 915 of file Parser.php.

References $t, and NS_SPECIAL.

Referenced by Scribunto\getParserEngine().

◆ setTransparentTagHook()

Parser::setTransparentTagHook	(		$tag,
		callable	$callback )

As setHook(), but letting the contents be parsed.

Transparent tag hooks are like regular XML-style tag hooks, except they operate late in the transformation sequence, on HTML instead of wikitext.

This is probably obsoleted by things dealing with parser frames? The only extension currently using it is geoserver.

Since: 1.10

Todo: better document or deprecate this

Parameters

string	$tag	The tag to use, e.g. 'hook' for "<hook>"
callable	$callback	The callback function (and object) to use for the tag

Exceptions

MWException

Returns: callable|null The old value of the mTagHooks array associated with the hook

Definition at line 5220 of file Parser.php.

◆ setUser()

Parser::setUser ( $user )

Set the current user.

Should only be used when doing pre-save transform.

Parameters

User | null $user User object or null (to reset)

Definition at line 906 of file Parser.php.

◆ splitWhitespace()

static Parser::splitWhitespace ( $s )

static

Return a three-element array: leading whitespace, string contents, trailing whitespace.

Parameters

string $s

Returns: array

Deprecated: since 1.34; appears to be unused.

Definition at line 3277 of file Parser.php.

References $s, and wfDeprecated().

◆ startExternalParse()

Parser::startExternalParse	(	Title	$title = null,
		ParserOptions	$options,
			$outputType,
			$clearState = true,
			$revId = null )

Set up some variables which are usually set up in parse() so that an external function can call some class members with confidence.

Parameters

Title \| null	$title
ParserOptions	$options
int	$outputType
bool	$clearState
int \| null	$revId

Definition at line 5111 of file Parser.php.

References $title.

Referenced by makeSuite().

◆ startParse()

Parser::startParse	(	Title	$title = null,
		ParserOptions	$options,
			$outputType,
			$clearState = true )

private

Parameters

Title \| null	$title
ParserOptions	$options
int	$outputType
bool	$clearState

Definition at line 5126 of file Parser.php.

References $title.

Referenced by getPreloadText(), parse(), and preprocess().

◆ statelessFetchRevision()

static Parser::statelessFetchRevision	(	Title	$title,
			$parser = false )

static

Wrapper around Revision::newFromTitle to allow passing additional parameters without passing them on to it.

Since: 1.24

Parameters

Title	$title
Parser \| bool	$parser

Returns: Revision|bool False if missing

Definition at line 3939 of file Parser.php.

References $title, DB_REPLICA, and wfGetDB().

◆ statelessFetchTemplate()

static Parser::statelessFetchTemplate	(		$title,
			$parser = false )

static

Static function to get a template Can be overridden via ParserOptions::setTemplateCallback().

Parameters

Title	$title
bool \| Parser	$parser

Returns: array

Definition at line 3991 of file Parser.php.

References $content, $title, NS_MEDIAWIKI, and wfMessage().

◆ stripAltText()

Parser::stripAltText	(		$caption,
			$holders )

protected

Parameters

string	$caption
LinkHolderArray \| bool	$holders

Returns: mixed|string

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 5912 of file Parser.php.

References wfDeprecated().

◆ stripAltTextPrivate()

Parser::stripAltTextPrivate	(		$caption,
			$holders )

private

Parameters

string	$caption
LinkHolderArray \| bool	$holders

Returns: mixed|string

Definition at line 5922 of file Parser.php.

◆ stripOuterParagraph()

static Parser::stripOuterParagraph ( $html )

static

Strip outer.

tag from the HTML source of a single paragraph.

Returns original HTML if the

tag has any attributes, if there's no wrapping

tag, or if there is more than one

tag in the input HTML.

Parameters

string $html

Returns: string

Since: 1.24

Definition at line 6797 of file Parser.php.

◆ stripSectionName()

Parser::stripSectionName ( $text )

Strips a text string of wikitext for use in a section anchor.

Accepts a text string and then removes all wikitext from the string and leaves only the resultant text (i.e. the result of [[User:WikiSysop|Sysop]] would be "Sysop" and the result of [[User:WikiSysop]] would be "User:WikiSysop") - this is intended to create valid section anchors by mimicing the output of the parser when headings are parsed.

Parameters

string $text Text string to be stripped of wikitext for use in a Section anchor

Returns: string Filtered text string

Definition at line 6502 of file Parser.php.

◆ testPreprocess()

Parser::testPreprocess	(		$text,
		Title	$title,
		ParserOptions	$options )

Parameters

string	$text
Title	$title
ParserOptions	$options

Returns: string

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 6590 of file Parser.php.

References $title, and wfDeprecated().

◆ testPst()

Parser::testPst	(		$text,
		Title	$title,
		ParserOptions	$options )

Parameters

string	$text
Title	$title
ParserOptions	$options

Returns: string

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 6568 of file Parser.php.

References $title, and wfDeprecated().

◆ testSrvus()

Parser::testSrvus	(		$text,
		Title	$title,
		ParserOptions	$options,
			$outputType = self::OT_HTML )

strip/replaceVariables/unstrip for preprocessor regression testing

Parameters

string	$text
Title	$title
ParserOptions	$options
int	$outputType

Returns: string

Deprecated: since 1.34; should not be used outside parser class.

Definition at line 6532 of file Parser.php.

References $title, and wfDeprecated().

◆ Title()

Parser::Title ( Title $x = null )

Accessor/mutator for the Title object.

Parameters

Title | null $x Title object or null to just get the current one

Returns: Title|null

Definition at line 948 of file Parser.php.

◆ transformMsg()

Parser::transformMsg	(	$text,
		$options,
		$title = null )

Wrapper for preprocess()

Parameters

string	$text	The text to preprocess
ParserOptions	$options
Title \| null	$title	Title object or null to use $wgTitle

Returns: string

Definition at line 5145 of file Parser.php.

References $title, and $wgTitle.

◆ unserializeHalfParsedText()

Parser::unserializeHalfParsedText ( $data )

Load the parser state given in the $data array, which is assumed to have been generated by serializeHalfParsedText().

The text contents is extracted from the array, and its markers are transformed into markers appropriate for the current Parser instance. This transformed text is returned, and can be safely included in the return value of a parser hook.

If the $data array has been stored persistently, the caller should first check whether it is still valid, by calling isValidHalfParsedText().

Deprecated: since 1.31

Parameters

array $data Serialized data

Exceptions

MWException

Returns: string

Definition at line 6699 of file Parser.php.

References wfDeprecated().

◆ validateSig()

Parser::validateSig ( $text )

Check that the user's signature contains no bad XML.

Parameters

string $text

Returns: string|bool An expanded string, or false if invalid.

Definition at line 5045 of file Parser.php.

Member Data Documentation

◆ $badFileLookup

BadFileLookup Parser::$badFileLookup

private

Definition at line 308 of file Parser.php.

◆ $constructorOptions

array Parser::$constructorOptions

static

Initial value:

= [
        
        'class',
        'preprocessorClass',
        
        'ArticlePath',
        'EnableScaryTranscluding',
        'ExtraInterlanguageLinkPrefixes',
        'FragmentMode',
        'LanguageCode',
        'MaxSigChars',
        'MaxTocLevel',
        'MiserMode',
        'ScriptPath',
        'Server',
        'ServerName',
        'ShowHostnames',
        'Sitename',
        'StylePath',
        'TranscludeCacheExpiry',
    ]

TODO Make this a const when HHVM support is dropped (T192166)

Since: 1.33

Definition at line 316 of file Parser.php.

◆ $contLang

Language Parser::$contLang

private

Definition at line 281 of file Parser.php.

◆ $currentRevisionCache

MapCacheLRU null Parser::$currentRevisionCache

Since: 1.24

A cache of the current revisions of titles. Keys are $title->getPrefixedDbKey()

Definition at line 261 of file Parser.php.

◆ $factory

ParserFactory Parser::$factory

private

Definition at line 284 of file Parser.php.

◆ $linkRendererFactory

LinkRendererFactory Parser::$linkRendererFactory

private

Definition at line 299 of file Parser.php.

◆ $logger

LoggerInterface Parser::$logger

private

Definition at line 305 of file Parser.php.

◆ $magicWordFactory

MagicWordFactory Parser::$magicWordFactory

private

Definition at line 278 of file Parser.php.

◆ $mAutonumber

Parser::$mAutonumber

Definition at line 195 of file Parser.php.

◆ $mConf

array Parser::$mConf

Deprecated: since 1.34, there should be no need to use this

Definition at line 181 of file Parser.php.

◆ $mDefaultSort

Parser::$mDefaultSort

Definition at line 210 of file Parser.php.

◆ $mDefaultStripList

Parser::$mDefaultStripList = []

Definition at line 155 of file Parser.php.

◆ $mDoubleUnderscores

Parser::$mDoubleUnderscores

Definition at line 211 of file Parser.php.

◆ $mExpensiveFunctionCount

Parser::$mExpensiveFunctionCount

Definition at line 212 of file Parser.php.

◆ $mExtLinkBracketedRegex

Parser::$mExtLinkBracketedRegex

Definition at line 184 of file Parser.php.

◆ $mFirstCall

bool Parser::$mFirstCall = true

Whether firstCallInit still needs to be called.

Definition at line 163 of file Parser.php.

◆ $mForceTocPosition

Parser::$mForceTocPosition

Definition at line 213 of file Parser.php.

◆ $mFunctionHooks

Parser::$mFunctionHooks = []

Definition at line 151 of file Parser.php.

◆ $mFunctionSynonyms

Parser::$mFunctionSynonyms = [ 0 => [], 1 => [] ]

Definition at line 152 of file Parser.php.

◆ $mFunctionTagHooks

Parser::$mFunctionTagHooks = []

Definition at line 153 of file Parser.php.

◆ $mGeneratedPPNodeCount

Parser::$mGeneratedPPNodeCount

Definition at line 209 of file Parser.php.

◆ $mHeadings

Parser::$mHeadings

Definition at line 211 of file Parser.php.

◆ $mHighestExpansionDepth

Parser::$mHighestExpansionDepth

Definition at line 209 of file Parser.php.

◆ $mImageParams

Parser::$mImageParams = []

Definition at line 157 of file Parser.php.

◆ $mImageParamsMagicArray

Parser::$mImageParamsMagicArray = []

Definition at line 158 of file Parser.php.

◆ $mIncludeCount

Parser::$mIncludeCount

Definition at line 202 of file Parser.php.

◆ $mIncludeSizes

Parser::$mIncludeSizes

Definition at line 209 of file Parser.php.

◆ $mInParse

bool string Parser::$mInParse = false

Recursive call protection.

This variable should be treated as if it were private.

Definition at line 267 of file Parser.php.

◆ $mInputSize

Parser::$mInputSize = false

Definition at line 246 of file Parser.php.

◆ $mLangLinkLanguages

array Parser::$mLangLinkLanguages

Array with the language name of each language link (i.e.

the interwiki prefix) in the key, value arbitrary. Used to avoid sending duplicate language links to the ParserOutput.

Definition at line 253 of file Parser.php.

◆ $mLinkHolders

LinkHolderArray Parser::$mLinkHolders

Definition at line 206 of file Parser.php.

◆ $mLinkID

Parser::$mLinkID

Definition at line 208 of file Parser.php.

◆ $mLinkRenderer

LinkRenderer Parser::$mLinkRenderer

protected

Definition at line 275 of file Parser.php.

◆ $mMarkerIndex

Parser::$mMarkerIndex = 0

Definition at line 159 of file Parser.php.

◆ $mOptions

ParserOptions Parser::$mOptions

Definition at line 228 of file Parser.php.

◆ $mOutput

ParserOutput Parser::$mOutput

Definition at line 194 of file Parser.php.

◆ $mOutputType

Parser::$mOutputType

Definition at line 238 of file Parser.php.

◆ $mPPNodeCount

Parser::$mPPNodeCount

Definition at line 209 of file Parser.php.

◆ $mPreprocessor

Preprocessor Parser::$mPreprocessor

Definition at line 188 of file Parser.php.

◆ $mProfiler

SectionProfiler Parser::$mProfiler

protected

Definition at line 270 of file Parser.php.

◆ $mRevIdForTs

Parser::$mRevIdForTs

Definition at line 245 of file Parser.php.

◆ $mRevisionId

Parser::$mRevisionId

Definition at line 241 of file Parser.php.

◆ $mRevisionObject

Parser::$mRevisionObject

Definition at line 240 of file Parser.php.

◆ $mRevisionSize

Parser::$mRevisionSize

Definition at line 244 of file Parser.php.

◆ $mRevisionTimestamp

Parser::$mRevisionTimestamp

Definition at line 242 of file Parser.php.

◆ $mRevisionUser

Parser::$mRevisionUser

Definition at line 243 of file Parser.php.

◆ $mShowToc

Parser::$mShowToc

Definition at line 213 of file Parser.php.

◆ $mStripList

Parser::$mStripList = []

Definition at line 154 of file Parser.php.

◆ $mStripState

StripState Parser::$mStripState

Definition at line 200 of file Parser.php.

◆ $mSubstWords

MagicWordArray Parser::$mSubstWords

Definition at line 175 of file Parser.php.

◆ $mTagHooks

Parser::$mTagHooks = []

Definition at line 149 of file Parser.php.

◆ $mTitle

Title null Parser::$mTitle

Since 1.34, leaving mTitle uninitialized or setting mTitle to null is deprecated.

Definition at line 237 of file Parser.php.

◆ $mTplDomCache

array Parser::$mTplDomCache

Definition at line 215 of file Parser.php.

◆ $mTplRedirCache

Parser::$mTplRedirCache

Definition at line 211 of file Parser.php.

◆ $mTransparentTagHooks

Parser::$mTransparentTagHooks = []

Definition at line 150 of file Parser.php.

◆ $mUrlProtocols

Parser::$mUrlProtocols

Definition at line 184 of file Parser.php.

◆ $mUser

User Parser::$mUser

Definition at line 220 of file Parser.php.

◆ $mVarCache

Parser::$mVarCache = []

Definition at line 156 of file Parser.php.

◆ $mVariables

MagicWordArray Parser::$mVariables

Definition at line 170 of file Parser.php.

◆ $nsInfo

NamespaceInfo Parser::$nsInfo

private

Definition at line 302 of file Parser.php.

◆ $ot

Parser::$ot

Definition at line 239 of file Parser.php.

◆ $specialPageFactory

SpecialPageFactory Parser::$specialPageFactory

private

Definition at line 287 of file Parser.php.

◆ $svcOptions

ServiceOptions Parser::$svcOptions

private

This is called $svcOptions instead of $options like elsewhere to avoid confusion with $mOptions, which is public and widely used, and also with the local variable $options used for ParserOptions throughout this file.

Definition at line 296 of file Parser.php.

◆ EXT_IMAGE_REGEX

const Parser::EXT_IMAGE_REGEX

Initial value:

= '/^(http:\/\/|https:\/\/)((?:\\[(?i:[0-9a-f:.]+)\\])?[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}]+)

\\/([A-Za-z0-9_.,~%\\-+&;#*?!=()@\\x80-\\xFF]+)\\.((?i)gif|png|jpg|jpeg)$/Sxu'

Definition at line 104 of file Parser.php.

◆ EXT_LINK_ADDR

const Parser::EXT_LINK_ADDR = '(?:[0-9.]+|\\[(?i:[0-9a-f:.]+)\\]|[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}])'

Definition at line 101 of file Parser.php.

◆ EXT_LINK_URL_CLASS

const Parser::EXT_LINK_URL_CLASS = '[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}]'

Definition at line 98 of file Parser.php.

◆ HALF_PARSED_VERSION

const Parser::HALF_PARSED_VERSION = 2

Update this version number when the output of serialiseHalfParsedText() changes in an incompatible way.

Definition at line 86 of file Parser.php.

◆ MARKER_PREFIX

const Parser::MARKER_PREFIX = "\x7f'\"`UNIQ-"

Definition at line 139 of file Parser.php.

◆ OT_HTML

const Parser::OT_HTML = 1

Definition at line 115 of file Parser.php.

◆ OT_MSG

const Parser::OT_MSG = 3

Definition at line 118 of file Parser.php.

◆ OT_PLAIN

const Parser::OT_PLAIN = 4

Definition at line 119 of file Parser.php.

◆ OT_PREPROCESS

const Parser::OT_PREPROCESS = 3

Definition at line 117 of file Parser.php.

◆ OT_WIKI

const Parser::OT_WIKI = 2

Definition at line 116 of file Parser.php.

◆ PTD_FOR_INCLUSION

const Parser::PTD_FOR_INCLUSION = 1

Definition at line 111 of file Parser.php.

◆ SFH_NO_HASH

const Parser::SFH_NO_HASH = 1

Definition at line 89 of file Parser.php.

◆ SFH_OBJECT_ARGS

const Parser::SFH_OBJECT_ARGS = 2

Definition at line 90 of file Parser.php.

◆ SPACE_NOT_NL

const Parser::SPACE_NOT_NL = '(?:\t| |&\#0*160;|&\#[Xx]0*[Aa]0;|\p{Zs})'

Definition at line 108 of file Parser.php.

◆ TOC_END

const Parser::TOC_END = '</mw:toc>'

Definition at line 143 of file Parser.php.

◆ TOC_START

const Parser::TOC_START = '<mw:toc>'

Definition at line 142 of file Parser.php.

◆ VERSION

const Parser::VERSION = '1.6.4'

Update this version number when the ParserOutput format changes in an incompatible way, so the parser cache can automatically discard old data.

Definition at line 80 of file Parser.php.

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

includes/parser/Parser.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ __clone()

◆ addTrackingCategory()

◆ areSubpagesAllowed()

◆ argSubstitution()

◆ armorLinks()

◆ armorLinksPrivate()

◆ attributeStripCallback()

◆ braceSubstitution()

◆ callParserFunction()

◆ cleanSig()

◆ cleanSigInSig()

◆ clearState()

◆ clearTagHooks()

◆ createAssocArgs()

◆ disableCache()

◆ doAllQuotes()

◆ doBlockLevels()

◆ doDoubleUnderscore()

◆ doHeadings()

◆ doMagicLinks()

◆ doQuotes()

◆ doTableStuff()

◆ enableOOUI()

◆ expandMagicVariable()

◆ extensionSubstitution()

◆ extractSections()

◆ extractTagsAndParams()

◆ fetchCurrentRevisionOfTitle()

◆ fetchFileAndTitle()

◆ fetchFileNoRegister()

◆ fetchTemplate()

◆ fetchTemplateAndTitle()

◆ finalizeHeadings()

◆ firstCallInit()

◆ formatHeadings()

◆ fuzzTestPreprocess()

◆ fuzzTestPst()

◆ fuzzTestSrvus()

◆ getContentLanguage()

◆ getConverterLanguage()

◆ getCustomDefaultSort()

◆ getDefaultPreprocessorClass()

◆ getDefaultSort()

◆ getExternalLinkAttribs()

◆ getExternalLinkRel()

◆ getFreshParser()

◆ getFunctionHooks()

◆ getFunctionLang()

◆ getFunctionSynonyms()

◆ getImageParams()

◆ getImageParamsPrivate()

◆ getLinkRenderer()

◆ getMagicWordFactory()

◆ getOptions()

◆ getOutput()

◆ getPreloadText()

◆ getPreprocessor()

◆ getRevisionId()

◆ getRevisionObject()

◆ getRevisionSize()

◆ getRevisionTimestamp()

◆ getRevisionTimestampSubstring()

◆ getRevisionUser()

◆ getSection()

◆ getSectionNameFromStrippedText()

◆ getStripList()