MediaWiki\Parser\Parser Class Reference

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

Public Member Functions
	__clone ()
	Allow extensions to clean up when the parser is cloned.
	__construct (private ServiceOptions $svcOptions, private ParserCoreTagHooks $parserCoreTagHooks, private MagicWordFactory $magicWordFactory, private Language $contLang, private UrlUtils $urlUtils, private SpecialPageFactory $specialPageFactory, private LinkRendererFactory $linkRendererFactory, private NamespaceInfo $nsInfo, private LoggerInterface $logger, private BadFileLookup $badFileLookup, private RepoGroup $repoGroup, private LanguageFactory $languageFactory, private LanguageConverterFactory $languageConverterFactory, private LanguageNameUtils $languageNameUtils, private HookContainer $hookContainer, private TidyDriverBase $tidy, private WANObjectCache $wanCache, private UserOptionsLookup $userOptionsLookup, private UserFactory $userFactory, private TitleFormatter $titleFormatter, private HttpRequestFactory $httpRequestFactory, private TrackingCategories $trackingCategories, private SignatureValidatorFactory $signatureValidatorFactory, private UserNameUtils $userNameUtils,)
	Constructing parsers directly is not allowed! Use a ParserFactory.
	__destruct ()
	Reduce memory usage to reduce the impact of circular references.
	addTrackingCategory ( $msg)
	argSubstitution (array $piece, PPFrame $frame)
	Triple brace replacement – used for template arguments.
	braceSubstitution (array $piece, PPFrame $frame)
	Return the text of a template, after recursively replacing any variables or templates within the template.
	callParserFunction (PPFrame $frame, $function, array $args=[], bool $inSolState=false)
	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.
	doQuotes ( $text)
	Helper function for handleAllQuotes()
	extensionSubstitution (array $params, PPFrame $frame)
	Return the text to be used for a given extension tag.
	fetchCurrentRevisionRecordOfTitle (LinkTarget $link)
	Fetch the current revision of a given title as a RevisionRecord.
	fetchFileAndTitle (LinkTarget $link, array $options=[])
	Fetch a file and its title and register a reference to it.
	fetchTemplateAndTitle (LinkTarget $link)
	Fetch the unparsed text of a template and register a reference to it.
	firstCallInit ()
	Used to do various kinds of initialisation on the first call of the parser.
	getBadFileLookup ()
	Get the BadFileLookup instance that this Parser is using.
	getContentLanguage ()
	Get the content language that this Parser is using.
	getExternalLinkAttribs ( $url)
	Get an associative array of additional HTML attributes appropriate for a particular external link.
	getFlatSectionInfo ( $text)
	Get an array of preprocessor section information.
	getFunctionHooks ()
	Get all registered function hook identifiers.
	getFunctionSynonyms ()
	getLinkRenderer ()
	Get a LinkRenderer instance to make links with.
	getMagicWordFactory ()
	Get the MagicWordFactory that this Parser is using.
	getMiserMode ()
	getNamespaceInfo ()
	getOptions ()
	getOutput ()
	getOutputType ()
	Accessor for the output type.
	getPage ()
	Returns the page used as context for parsing, e.g.
	getParseTime ()
	Return the parse time.
	getPreloadText ( $text, PageReference $page, 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.
	getRevisionRecordObject ()
	Get the revision record 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 ()
	getTags ()
	Accessor.
	getTargetLanguage ()
	Get the target language for the content being parsed.
	getTargetLanguageConverter ()
	Shorthand for getting a Language Converter for Target language.
	getTemplateDom (LinkTarget $title, bool $inSolState=false)
	Get the semi-parsed DOM representation of a template with a given title, and its redirect destination title.
	getTitle ()
	getUrlProtocols ()
	getUserIdentity ()
	Get a user either from the user set on Parser if it's set, or from the ParserOptions object otherwise.
	getUserSig (UserIdentity $user, $nickname=false, $fancySig=null)
	Fetch the user's signature text, if any, and normalize to validated, ready-to-insert wikitext.
	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 ()
	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 (LinkTarget $link, $action)
	Transclude an interwiki link.
	isCurrentRevisionOfTitleCached (LinkTarget $link)
	isLocked ()
	Will entry points such as parse() throw an exception due to the parser already being active?
	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.
	makeImage (LinkTarget $link, $options, $holders=false)
	Parse image options text and use it to make an image.
	makeImageHtml (LinkTarget $link, string $options)
	Parse image options text and use it to make an image.
	makeLimitReport (ParserOptions $parserOptions, ParserOutput $parserOutput)
	Set the limit report data in the current ParserOutput.
	markerSkipCallback ( $s, callable $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.
	modifyImageHtml (File $file, array $params, string &$html)
	Give hooks a chance to modify image thumbnail HTML.
	msg (string $msg,... $params)
	Helper function to correctly set the target language and title of a message based on the parser context.
	nextLinkID ()
	parse ( $text, PageReference $page, ParserOptions $options, $linestart=true, $clearState=true, $revid=null)
	Convert wikitext to HTML Do not call this function recursively.
	parseExtensionTagAsTopLevelDoc (string $text, PPFrame|false $frame=false)
	Needed by Parsoid/PHP to ensure all the hooks for extensions are run in the right order.
	parseWidthParam ( $value, $parseHeight=true, bool $localized=false)
	Parsed a width param of imagelink like 300px or 200x300px.
	preprocess ( $text, ?PageReference $page, ParserOptions $options, $revid=null, $frame=false)
	Expand templates and variables in the text, producing valid, static wikitext.
	preprocessToDom ( $text, $flags=0)
	Get the document object model for the given wikitext.
	preSaveTransform ( $text, PageReference $page, UserIdentity $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, array $params)
	Renders an image gallery from a text with one line per image.
	replaceSection ( $oldText, $sectionId, $newText)
	This function returns $oldtext after the content of the section specified by $section has been replaced with $text.
	replaceVariables ( $text, $frame=false, $argsOnly=false, array $options=[])
	Replace magic variables, templates, and template arguments with the appropriate text.
	resetOutput ()
	Reset the ParserOutput.
	setFunctionHook ( $id, callable $callback, $flags=0)
	Create a function, e.g.
	setHook ( $tag, callable $callback)
	Create an HTML-style tag, e.g.
	setLinkID ( $id)
	setOptions (ParserOptions $options)
	Mutator for the ParserOptions object.
	setOutputType ( $ot)
	Mutator for the output type.
	setPage (?PageReference $t=null)
	Set the page used as context for parsing, e.g.
	setTitle (?Title $t=null)
	Set the context title.
	setUseParsoidFragments (bool $val)
	setUser (?UserIdentity $user)
	Set the current user.
	startExternalParse (?PageReference $page, 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.
	tagNeedsNowikiStrippedInTagPF (string $lowerTagName)
	transformMsg ( $text, ParserOptions $options, ?PageReference $page=null)
	Wrapper for preprocess()
	useParsoidFragments ()
	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	defaultFetchRevisionRecord (RevisionLookup $revisionLookup, LinkTarget $link, $parser)
	Default implementation of fetchCurrentRevisionRecordOfTitle()
static	defaultFetchTemplate (RevisionLookup $revLookup, HookRunner $hookRunner, LinkCache $linkCache, ShadowPageLoader $shadowPageLoader, $link, $parser)
	Static function to get a template Can be overridden via ParserOptions::setTemplateCallback(), in which case the service arguments are not passed.
static	extractBody (string $text)
	Strip everything but the <body> from the provided string.
static	extractTagsAndParams (array $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	formatPageTitle ( $nsText, $nsSeparator, $mainText, ?Language $titleLang=null)
	Add HTML tags marking the parts of a page title, to be displayed in the first heading of the page.
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	localizeTOC (?TOCData $tocData, Language $lang, ?ILanguageConverter $converter, ?string $preferredVariant=null)
	Localize the TOC into the given target language; this includes invoking the language converter on the headings.
static	normalizeLinkUrl ( $url)
	Replace unusual escape codes in a URL with their equivalent characters.
static	replaceTableOfContentsMarker ( $text, $toc)
	Replace table of contents marker in parsed HTML.
static	statelessFetchRevisionRecord (LinkTarget $link, $parser=null)
static	statelessFetchTemplate ( $page, $parser=false)
static	stripOuterParagraph ( $html)
	Strip outer.

Public Attributes
	$mExpensiveFunctionCount
	Number of expensive parser function calls.
	$mExtArrays
	$mExtHashTables
	$mExtLoopsCounter
	$mExtVariables
array	$mHeadings
int	$mHighestExpansionDepth
	$mMarkerIndex = 0
int	$mPPNodeCount
const	CONSTRUCTOR_OPTIONS
const	EXT_LINK_URL_CLASS = '[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}]'
	Everything except bracket, space, or control characters.
const	MARKER_PREFIX = "\x7f'\"`UNIQ-"
const	OT_HTML = 1
	Output type: like Parser::parse()
const	OT_PLAIN = 4
	Output type: like Parser::extractSections() - portions of the original are returned unchanged.
const	OT_PREPROCESS = 3
	Output type: like Parser::preprocess()
const	OT_WIKI = 2
	Output type: like Parser::preSaveTransform()
const	SFH_NO_HASH = 1
const	SFH_OBJECT_ARGS = 2

Protected Member Functions
	fetchFileNoRegister (LinkTarget $link, array $options=[])
	Helper function for fetchFileAndTitle.
	getHookContainer ()
	Get a HookContainer capable of returning metadata about hooks or running extension hooks.
	getHookRunner ()
	Get a HookRunner for calling core hooks.
	lock ()
	Lock the current instance of the parser.

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

$wgTitle or $wgRequest or $wgLang. Keep them away!

Settings:

$wgNamespacesWithSubpages

Settings only within ParserOptions:

$wgAllowExternalImages $wgAllowSpecialInclusion $wgInterwikiMagic $wgMaxArticleSize

Definition at line 139 of file Parser.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Parser\Parser::__construct	(	private ServiceOptions	$svcOptions,
		private ParserCoreTagHooks	$parserCoreTagHooks,
		private MagicWordFactory	$magicWordFactory,
		private Language	$contLang,
		private UrlUtils	$urlUtils,
		private SpecialPageFactory	$specialPageFactory,
		private LinkRendererFactory	$linkRendererFactory,
		private NamespaceInfo	$nsInfo,
		private LoggerInterface	$logger,
		private BadFileLookup	$badFileLookup,
		private RepoGroup	$repoGroup,
		private LanguageFactory	$languageFactory,
		private LanguageConverterFactory	$languageConverterFactory,
		private LanguageNameUtils	$languageNameUtils,
		private HookContainer	$hookContainer,
		private TidyDriverBase	$tidy,
		private WANObjectCache	$wanCache,
		private UserOptionsLookup	$userOptionsLookup,
		private UserFactory	$userFactory,
		private TitleFormatter	$titleFormatter,
		private HttpRequestFactory	$httpRequestFactory,
		private TrackingCategories	$trackingCategories,
		private SignatureValidatorFactory	$signatureValidatorFactory,
		private UserNameUtils	$userNameUtils )

Constructing parsers directly is not allowed! Use a ParserFactory.

Access: internal

Definition at line 393 of file Parser.php.

References MediaWiki\Parser\ParserFactory\$inParserFactory, MediaWiki\Config\ServiceOptions\assertRequiredOptions(), MediaWiki\Config\ServiceOptions\get(), MediaWiki\Language\LanguageConverterFactory\isConversionDisabled(), MediaWiki\Deferred\LinksUpdate\CategoryLinksTable\makeTitle(), NS_SPECIAL, MediaWiki\MainConfigNames\PreprocessorCacheThreshold, and MediaWiki\Parser\ParserCoreTagHooks\register().

__destruct()

MediaWiki\Parser\Parser::__destruct

(

)

Reduce memory usage to reduce the impact of circular references.

Definition at line 465 of file Parser.php.

Member Function Documentation

__clone()

MediaWiki\Parser\Parser::__clone

(

)

Allow extensions to clean up when the parser is cloned.

Definition at line 480 of file Parser.php.

addTrackingCategory()

MediaWiki\Parser\Parser::addTrackingCategory

(

$msg

)

See also

TrackingCategories::addTrackingCategory()

Parameters

string

$msg

Message key

Returns

bool Whether the addition was successful

Since

1.19 method is public

Definition at line 4196 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\displaytitle().

argSubstitution()

MediaWiki\Parser\Parser::argSubstitution	(	array	$piece,
		PPFrame	$frame )

Triple brace replacement – used for template arguments.

Parameters

array	$piece
PPFrame	$frame

Returns

array{object:PPNode}|array{text:string}

Access: internal

Definition at line 3936 of file Parser.php.

References MediaWiki\Parser\PPFrame\expand(), MediaWiki\Parser\PPFrame\getArgument(), MediaWiki\Parser\PPFrame\isTemplate(), and MediaWiki\Parser\PPFrame\virtualBracketedImplode().

braceSubstitution()

MediaWiki\Parser\Parser::braceSubstitution	(	array	$piece,
		PPFrame	$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

Access: internal

Definition at line 2937 of file Parser.php.

callParserFunction()

MediaWiki\Parser\Parser::callParserFunction	(	PPFrame	$frame,
			$function,
		array	$args = [],
		bool	$inSolState = false )

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 most wikitext transformation isRawHTML: bool, $text is raw HTML, armour it against all 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
bool	$inSolState	Is the template processing starting in Start-Of-Line (SOL) position? Prepreprocessing (on behalf of Parsoid) uses this flag to set lineStart property on processor DOM tree nodes. Since the preprocessor tree doesn't rely on expanded templates, this flag is a best guess since {{expands-to-empty-string}} can blind it to SOL context. This flag is always false for legacy parser template expansions.

Returns

array

Definition at line 3352 of file Parser.php.

References MediaWiki\Parser\PPFrame\expand().

cleanSig()

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

Clean up signature text.

1) Strip 3, 4 or 5 tildes out of signatures, see cleanSigInSig 2) Substitute all transclusions

Parameters

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

Returns

string Signature text

Since

1.6

Definition at line 4859 of file Parser.php.

cleanSigInSig()

static MediaWiki\Parser\Parser::cleanSigInSig ( $text )

static

Strip 3, 4 or 5 tildes out of signatures.

Parameters

string

$text

Returns

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

Since

1.7

Definition at line 4901 of file Parser.php.

clearState()

MediaWiki\Parser\Parser::clearState

(

)

Clear Parser state.

Access: internal

Definition at line 508 of file Parser.php.

References MediaWiki\Parser\Parser\getHookContainer(), and MediaWiki\Parser\Parser\resetOutput().

clearTagHooks()

MediaWiki\Parser\Parser::clearTagHooks

(

)

Remove all tag hooks.

Since

1.12

Definition at line 5049 of file Parser.php.

defaultFetchRevisionRecord()

static MediaWiki\Parser\Parser::defaultFetchRevisionRecord ( RevisionLookup $revisionLookup, LinkTarget $link, $parser )

static

Default implementation of fetchCurrentRevisionRecordOfTitle()

Access: internal

Use ParserOptions::getCurrentRevisionRecordCallback() – services may change

Since

1.47

Parameters

RevisionLookup	$revisionLookup
LinkTarget	$link
Parser | null	$parser

Returns

RevisionRecord|false False if missing

Definition at line 3550 of file Parser.php.

References MediaWiki\Revision\RevisionLookup\getKnownLatestRevision().

defaultFetchTemplate()

static MediaWiki\Parser\Parser::defaultFetchTemplate ( RevisionLookup $revLookup, HookRunner $hookRunner, LinkCache $linkCache, ShadowPageLoader $shadowPageLoader, $link, $parser )

static

Static function to get a template Can be overridden via ParserOptions::setTemplateCallback(), in which case the service arguments are not passed.

Access: internal

Use ParserOptions::getTemplateCallback() – services may change

Parameters

RevisionLookup	$revLookup
HookRunner	$hookRunner
LinkCache	$linkCache
ShadowPageLoader	$shadowPageLoader
LinkTarget	$link
Parser | false	$parser

Returns

array An associative array with the following keys:

• revision-record: RevisionRecord|false Optional, for b/c
• text: string|false The wikitext
• finalTitle: Title The title after any redirection has been applied
• deps: An array of associative arrays, each describing a dependency, with keys:
  • title: Title
  • page_id: int
  • rev_id: int|null

Since

1.12

Definition at line 3646 of file Parser.php.

References MediaWiki\Page\LinkCache\addBadLinkObj(), MediaWiki\ShadowPage\ShadowPageLoader\get(), MediaWiki\Revision\RevisionLookup\getRevisionByTitle(), and MediaWiki\HookContainer\HookRunner\onBeforeParserFetchTemplateRevisionRecord().

doQuotes()

MediaWiki\Parser\Parser::doQuotes

(

$text

)

Helper function for handleAllQuotes()

Parameters

string

$text

Returns

string

Access: internal

Definition at line 1918 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\displaytitle().

extensionSubstitution()

MediaWiki\Parser\Parser::extensionSubstitution	(	array	$params,
		PPFrame	$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

Returns

string

Access: internal

Since

1.12

Definition at line 3993 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\tagObj().

extractBody()

static MediaWiki\Parser\Parser::extractBody ( string $text )

static

Strip everything but the <body> from the provided string.

Parameters

string

$text

Returns

string

Stability: unstable

Definition at line 6519 of file Parser.php.

extractTagsAndParams()

static MediaWiki\Parser\Parser::extractTagsAndParams ( array $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

string[]	$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 1178 of file Parser.php.

fetchCurrentRevisionRecordOfTitle()

MediaWiki\Parser\Parser::fetchCurrentRevisionRecordOfTitle

(

LinkTarget

$link

)

Fetch the current revision of a given title as a RevisionRecord.

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.

This can return null if the callback returns false

Since

1.35

Parameters

LinkTarget

$link

Returns

RevisionRecord|null

Definition at line 3503 of file Parser.php.

fetchFileAndTitle()

MediaWiki\Parser\Parser::fetchFileAndTitle	(	LinkTarget	$link,
		array	$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

LinkTarget	$link
array	$options	Array of options to RepoGroup::findFile

Returns

array{File|false,Title}

Since

1.18

Definition at line 3815 of file Parser.php.

fetchFileNoRegister()

MediaWiki\Parser\Parser::fetchFileNoRegister ( LinkTarget $link, array $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

LinkTarget	$link
array	$options	Array of options to RepoGroup::findFile

Returns

File|false

Definition at line 3842 of file Parser.php.

fetchTemplateAndTitle()

MediaWiki\Parser\Parser::fetchTemplateAndTitle

(

LinkTarget

$link

)

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

Parameters

LinkTarget

$link

Returns

array{0:string|false,1:Title}

Since

1.11

Definition at line 3590 of file Parser.php.

firstCallInit()

MediaWiki\Parser\Parser::firstCallInit

(

)

Used to do various kinds of initialisation on the first call of the parser.

Deprecated

since 1.35, this initialization is done in the constructor and manual calls to ::firstCallInit() have no effect.

Since

1.7

Definition at line 496 of file Parser.php.

formatPageTitle()

static MediaWiki\Parser\Parser::formatPageTitle ( $nsText, $nsSeparator, $mainText, ?Language $titleLang = null )

static

Add HTML tags marking the parts of a page title, to be displayed in the first heading of the page.

Access: internal

Since

1.39

Parameters

string | HtmlArmor	$nsText
string | HtmlArmor	$nsSeparator
string | HtmlArmor	$mainText
?Language	$titleLang	If present, the title will be wrapped with a setting appropriate lang and dir attributes.

Returns

string HTML

Definition at line 6497 of file Parser.php.

getBadFileLookup()

MediaWiki\Parser\Parser::getBadFileLookup

(

)

Get the BadFileLookup instance that this Parser is using.

Since

1.35

Returns

BadFileLookup

Definition at line 1155 of file Parser.php.

Referenced by MediaWiki\Linker\Linker\makeImageLink().

getContentLanguage()

MediaWiki\Parser\Parser::getContentLanguage

(

)

Get the content language that this Parser is using.

Since

1.32

Returns

Language

Definition at line 1145 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\lc(), MediaWiki\Parser\CoreParserFunctions\lcfirst(), MediaWiki\Parser\CoreParserFunctions\ns(), MediaWiki\Parser\CoreParserFunctions\pagesincategory(), MediaWiki\Parser\CoreParserFunctions\uc(), and MediaWiki\Parser\CoreParserFunctions\ucfirst().

getExternalLinkAttribs()

MediaWiki\Parser\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).

Access: internal

Parameters

string

$url

URL to extract the domain from for rel => nofollow if appropriate

Returns

array Associative array of HTML attributes

Definition at line 2206 of file Parser.php.

References $url.

getExternalLinkRel()

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

static

Get the rel attribute for a particular external link.

Since

1.21

Deprecated

since 1.47 use LinkRenderer::getExternalLinkRel()

Access: internal

Parameters

string | false	$url	Optional URL, to extract the domain from for rel => nofollow if appropriate
LinkTarget | PageReference | null	$title	Optional page, for wgNoFollowNsExceptions lookups

Returns

string|null Rel attribute for $url

Definition at line 2189 of file Parser.php.

getFlatSectionInfo()

MediaWiki\Parser\Parser::getFlatSectionInfo

(

$text

)

Get an array of preprocessor section information.

Preprocessor sections are those identified by wikitext-style syntax, not HTML-style syntax. Templates are not expanded, so these sections do not include sections created by templates or parser functions. This is the same definition of a section as used by section editing, but not the same as TOC generation.

These sections are typically smaller than those acted on by getSection() and replaceSection() since they are not nested. Section nesting could be reconstructed from the heading levels.

The return value is an array of associative array info structures. Each associative array contains the following keys, describing a section:

• index: An integer identifying the section.
• level: The heading level, e.g. 1 for

  . For the section before the the first heading, this will be 0..offset: The byte offset within the wikitext at which the section startsstartsheading: The wikitext for the header which introduces the section, including equals signs. For the section before the first heading, this will be an empty string..text: The complete text of the section. @param string $text @return array[] \par "Access: internal"

Definition at line 6015 of file Parser.php.

References MediaWiki\Parser\PPFrame\expand().

getFunctionHooks()

MediaWiki\Parser\Parser::getFunctionHooks

(

)

Get all registered function hook identifiers.

Returns

string[]

Since

1.8

Definition at line 5136 of file Parser.php.

getFunctionSynonyms()

MediaWiki\Parser\Parser::getFunctionSynonyms

(

)

Since

1.32

Returns

array{0:array<string,string>,1:array<string,string>}

Definition at line 5799 of file Parser.php.

getHookContainer()

MediaWiki\Parser\Parser::getHookContainer ( )

protected

Get a HookContainer capable of returning metadata about hooks or running extension hooks.

Since

1.35

Returns

HookContainer

Definition at line 1575 of file Parser.php.

Referenced by MediaWiki\Parser\Parser\clearState().

getHookRunner()

MediaWiki\Parser\Parser::getHookRunner ( )

protected

Get a HookRunner for calling core hooks.

Access: internal

This is for use by core only. Hook interfaces may be removed without notice.

Since

1.35

Returns

HookRunner

Definition at line 1603 of file Parser.php.

getLinkRenderer()

MediaWiki\Parser\Parser::getLinkRenderer

(

)

Get a LinkRenderer instance to make links with.

Since

1.28

Returns

LinkRenderer

Definition at line 1120 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\isbn().

getMagicWordFactory()

MediaWiki\Parser\Parser::getMagicWordFactory

(

)

Get the MagicWordFactory that this Parser is using.

Since

1.32

Returns

MagicWordFactory

Definition at line 1135 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\contentmodel(), MediaWiki\Parser\CoreParserFunctions\defaultsort(), MediaWiki\Parser\CoreParserFunctions\displaytitle(), MediaWiki\Parser\CoreParserFunctions\formatnum(), MediaWiki\Parser\CoreParserFunctions\pagesincategory(), and MediaWiki\Parser\CoreParserFunctions\urlencode().

getMiserMode()

MediaWiki\Parser\Parser::getMiserMode

(

)

Access: internal

Since

1.46

Definition at line 1591 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\revisionid().

getNamespaceInfo()

MediaWiki\Parser\Parser::getNamespaceInfo

(

)

Access: internal

Since

1.46

Definition at line 1583 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\revisionid().

getOptions()

MediaWiki\Parser\Parser::getOptions

(

)

Returns

ParserOptions|null

Since

1.6

Definition at line 1044 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\formatDate(), MediaWiki\Parser\CoreParserFunctions\gender(), MediaWiki\Parser\ParserCoreTagHooks\html(), MediaWiki\Parser\CoreParserFunctions\intFunction(), and MediaWiki\Parser\CoreParserFunctions\revisionid().

getOutput()

MediaWiki\Parser\Parser::getOutput

(

)

Returns

ParserOutput

Since

1.14

Definition at line 1036 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\defaultsort(), MediaWiki\Parser\CoreParserFunctions\displaytitle(), MediaWiki\Parser\CoreMagicVariables\expand(), MediaWiki\Parser\CoreParserFunctions\interlanguagelink(), MediaWiki\Parser\CoreParserFunctions\interwikilink(), MediaWiki\Parser\CoreParserFunctions\isbn(), MediaWiki\Parser\CoreParserFunctions\pageid(), MediaWiki\Parser\CoreParserFunctions\revisionid(), MediaWiki\Parser\CoreParserFunctions\revisionuser(), and MediaWiki\Gallery\TraditionalImageGallery\toHTML().

getOutputType()

MediaWiki\Parser\Parser::getOutputType

(

)

Accessor for the output type.

Returns

int One of the Parser::OT_... constants

Since

1.35

Definition at line 1012 of file Parser.php.

getPage()

MediaWiki\Parser\Parser::getPage

(

)

Returns the page used as context for parsing, e.g.

when resolving relative subpage links.

Since

1.37

Returns

PageReference

Definition at line 995 of file Parser.php.

References wfDeprecated().

getParseTime()

MediaWiki\Parser\Parser::getParseTime

(

)

Return the parse time.

This is the timestamp recorded in ParserOptions, except that it can also be modified by the ParserGetVariableValueTs hook.

Returns

DateTime (UTC time zone)

Since

1.46

Definition at line 565 of file Parser.php.

getPreloadText()

MediaWiki\Parser\Parser::getPreloadText	(		$text,
		PageReference	$page,
		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
PageReference	$page
ParserOptions	$options
array	$params

Returns

string

Since

1.17

Definition at line 920 of file Parser.php.

getPreprocessor()

MediaWiki\Parser\Parser::getPreprocessor

(

)

Get a preprocessor object.

Returns

Preprocessor

Since

1.12.0

Definition at line 1110 of file Parser.php.

getRevisionId()

MediaWiki\Parser\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 getCurrentRevisionRecordCallback()
• c) Null, meaning the parse is for preview mode and there is no revision

Returns

int|null

Since

1.13

Definition at line 6069 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\revisionid().

getRevisionRecordObject()

MediaWiki\Parser\Parser::getRevisionRecordObject

(

)

Get the revision record object for $this->mRevisionId.

Returns

RevisionRecord|null Either a RevisionRecord object or null

Since

1.35

Definition at line 6079 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\revisionid().

getRevisionSize()

MediaWiki\Parser\Parser::getRevisionSize

(

)

Get the size of the revision.

Returns

int|null Revision size

Since

1.22

Definition at line 6188 of file Parser.php.

getRevisionTimestamp()

MediaWiki\Parser\Parser::getRevisionTimestamp

(

)

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

Returns

string TS::MW timestamp

Since

1.9

Definition at line 6136 of file Parser.php.

getRevisionUser()

MediaWiki\Parser\Parser::getRevisionUser

(

)

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

Returns

string|null User name

Since

1.15

Definition at line 6164 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\revisionuser().

getSection()

MediaWiki\Parser\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 | false	$defaultText	Default to return if section is not found

Returns

string|false Text of the requested section, or else $defaultText if not found.

Since

1.7

Definition at line 5965 of file Parser.php.

getStripList()

MediaWiki\Parser\Parser::getStripList

(

)

Get a list of strippable XML-like elements.

Returns

string[]

Definition at line 1241 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\tagObj().

getStripState()

MediaWiki\Parser\Parser::getStripState

(

)

Returns

StripState

Since

1.34

Definition at line 1249 of file Parser.php.

Referenced by MediaWiki\Parser\Parsoid\Config\DataAccess\preprocessWikitext(), and MediaWiki\Parser\CoreParserFunctions\tagObj().

getTags()

MediaWiki\Parser\Parser::getTags

(

)

Accessor.

Returns

string[]

Since

1.6

Definition at line 5791 of file Parser.php.

getTargetLanguage()

MediaWiki\Parser\Parser::getTargetLanguage

(

)

Get the target language for the content being parsed.

This is usually the language that the content is in.

Since

1.19

Returns

Language

Definition at line 1081 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\bcp47(), MediaWiki\Parser\CoreParserFunctions\bidi(), MediaWiki\Parser\CoreParserFunctions\contentmodel(), MediaWiki\Parser\CoreParserFunctions\dir(), MediaWiki\Parser\CoreParserFunctions\formatDate(), MediaWiki\Parser\CoreParserFunctions\formatnum(), MediaWiki\Parser\CoreParserFunctions\gender(), MediaWiki\Parser\CoreParserFunctions\grammar(), MediaWiki\Parser\CoreParserFunctions\language(), MediaWiki\Parser\CoreParserFunctions\numberingroup(), MediaWiki\Parser\CoreParserFunctions\numberofactiveusers(), MediaWiki\Parser\CoreParserFunctions\numberofadmins(), MediaWiki\Parser\CoreParserFunctions\numberofarticles(), MediaWiki\Parser\CoreParserFunctions\numberofedits(), MediaWiki\Parser\CoreParserFunctions\numberoffiles(), MediaWiki\Parser\CoreParserFunctions\numberofpages(), MediaWiki\Parser\CoreParserFunctions\numberofusers(), MediaWiki\Parser\CoreParserFunctions\pagesincategory(), MediaWiki\Parser\CoreParserFunctions\pagesinnamespace(), MediaWiki\Parser\CoreParserFunctions\pagesize(), and MediaWiki\Parser\CoreParserFunctions\plural().

getTargetLanguageConverter()

MediaWiki\Parser\Parser::getTargetLanguageConverter

(

)

Shorthand for getting a Language Converter for Target language.

Since

public since 1.38

Returns

ILanguageConverter

Definition at line 1553 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\defaultsort(), and MediaWiki\Parser\CoreParserFunctions\displaytitle().

getTemplateDom()

MediaWiki\Parser\Parser::getTemplateDom	(	LinkTarget	$title,
		bool	$inSolState = false )

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

Cached.

The second element of the returned array may be a Title object, or may be the passed $title parameter, so if you need a Title, pass it a Title rather than a TitleValue.

Parameters

LinkTarget	$title
bool	$inSolState	Is the template processing starting in Start-Of-Line (SOL) position? Prepreprocessing (on behalf of Parsoid) uses this flag to set lineStart property on processor DOM tree nodes. Since the preprocessor tree doesn't rely on expanded templates, this flag is a best guess since {{expands-to-empty-string}} can blind it to SOL context. This flag is always false for legacy parser template expansions.

Returns

array{0:PPNode|false,1:LinkTarget} [Template DOM, final template title]

Since

1.12

Definition at line 3447 of file Parser.php.

getTitle()

MediaWiki\Parser\Parser::getTitle

(

)

Since

1.6

Deprecated

since 1.37, use getPage instead.

Returns

Title

Definition at line 962 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\cascadingsources(), MediaWiki\Parser\CoreParserFunctions\displaytitle(), MediaWiki\Linker\Linker\makeImageLink(), MediaWiki\Parser\CoreParserFunctions\pageid(), MediaWiki\Parser\CoreParserFunctions\protectionexpiry(), MediaWiki\Parser\CoreParserFunctions\protectionlevel(), MediaWiki\Parser\CoreParserFunctions\revisionid(), and MediaWiki\Parser\CoreParserFunctions\revisionuser().

getUrlProtocols()

MediaWiki\Parser\Parser::getUrlProtocols

(

)

Since

1.32

Returns

string

Definition at line 5807 of file Parser.php.

getUserIdentity()

MediaWiki\Parser\Parser::getUserIdentity

(

)

Get a user either from the user set on Parser if it's set, or from the ParserOptions object otherwise.

Since

1.36

Returns

UserIdentity

Definition at line 1100 of file Parser.php.

getUserSig()

MediaWiki\Parser\Parser::getUserSig	(	UserIdentity	$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

UserIdentity	$user
string | false	$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

Since

1.6

Definition at line 4777 of file Parser.php.

guessLegacySectionNameFromWikiText()

MediaWiki\Parser\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 '#')

Since

1.17

Deprecated

since 1.45

Definition at line 6250 of file Parser.php.

guessSectionNameFromStrippedText()

static MediaWiki\Parser\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 '#')

Since

1.31

Definition at line 6264 of file Parser.php.

guessSectionNameFromWikiText()

MediaWiki\Parser\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 '#')

Since

1.12

Definition at line 6232 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\anchorencode().

incrementExpensiveFunctionCount()

MediaWiki\Parser\Parser::incrementExpensiveFunctionCount

(

)

Returns

bool False if the limit has been exceeded

Since

1.13

Definition at line 4111 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\cascadingsources(), MediaWiki\Parser\CoreParserFunctions\contentmodel(), MediaWiki\Parser\CoreParserFunctions\pageid(), MediaWiki\Parser\CoreParserFunctions\pagesincategory(), MediaWiki\Parser\CoreParserFunctions\protectionexpiry(), and MediaWiki\Parser\CoreParserFunctions\protectionlevel().

insertStripItem()

MediaWiki\Parser\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 1262 of file Parser.php.

internalParse()

MediaWiki\Parser\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: internal

Parameters

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

Returns

string

Definition at line 1485 of file Parser.php.

interwikiTransclude()

MediaWiki\Parser\Parser::interwikiTransclude	(	LinkTarget	$link,
			$action )

Transclude an interwiki link.

Parameters

LinkTarget	$link
string	$action	Usually one of (raw, render)

Returns

string

Access: internal

Definition at line 3865 of file Parser.php.

References wfMessage().

isCurrentRevisionOfTitleCached()

MediaWiki\Parser\Parser::isCurrentRevisionOfTitleCached

(

LinkTarget

$link

)

Parameters

LinkTarget

$link

Returns

bool

Since

1.34

Access: internal

Definition at line 3532 of file Parser.php.

isLocked()

MediaWiki\Parser\Parser::isLocked

(

)

Will entry points such as parse() throw an exception due to the parser already being active?

Since

1.39

Returns

bool

Definition at line 6462 of file Parser.php.

killMarkers()

MediaWiki\Parser\Parser::killMarkers

(

$text

)

Remove any strip markers found in the given text.

Parameters

string

$text

Returns

string

Since

1.19

Definition at line 6370 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\anchorencode(), MediaWiki\Parser\CoreParserFunctions\displaytitle(), MediaWiki\Parser\CoreParserFunctions\grammar(), MediaWiki\Parser\CoreParserFunctions\pad(), MediaWiki\Parser\CoreParserFunctions\tagObj(), and MediaWiki\Parser\CoreParserFunctions\urlencode().

limitationWarn()

MediaWiki\Parser\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)

Access: internal

Definition at line 2912 of file Parser.php.

localizeTOC()

static MediaWiki\Parser\Parser::localizeTOC ( ?TOCData $tocData, Language $lang, ?ILanguageConverter $converter, ?string $preferredVariant = null )

static

Localize the TOC into the given target language; this includes invoking the language converter on the headings.

Parameters

?TOCData	$tocData	The Table of Contents
Language	$lang	The target language
?ILanguageConverter	$converter	The target language converter, or null if language conversion is to be suppressed.
?string	$preferredVariant	The target variant for language conversion.

Access: internal

Definition at line 4613 of file Parser.php.

References MediaWiki\Language\ILanguageConverter\convertTo(), MediaWiki\Language\Language\formatNum(), and MediaWiki\Language\ILanguageConverter\getPreferredVariant().

lock()

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

Definition at line 6424 of file Parser.php.

makeImage()

MediaWiki\Parser\Parser::makeImage	(	LinkTarget	$link,
			$options,
			$holders = false )

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

Parameters

LinkTarget	$link
string	$options
LinkHolderArray | false	$holders	If $holders is false, link holders are replaced in the alt text but may still be present elsewhere in the returned HTML. Use ::makeImageHtml if you want to ensure no link holders remain in the returned HTML.

Returns

string HTML

Since

1.5

Deprecated

since 1.46; use ::makeImageHtml() instead

Definition at line 5422 of file Parser.php.

makeImageHtml()

MediaWiki\Parser\Parser::makeImageHtml	(	LinkTarget	$link,
		string	$options )

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

Parameters

LinkTarget	$link
string	$options

Returns

string HTML

Since

1.46

Definition at line 5402 of file Parser.php.

makeLimitReport()

MediaWiki\Parser\Parser::makeLimitReport	(	ParserOptions	$parserOptions,
		ParserOutput	$parserOutput )

Set the limit report data in the current ParserOutput.

Access: internal

Definition at line 696 of file Parser.php.

References MediaWiki\MainConfigNames\EnableParserLimitReporting, MediaWiki\Parser\ParserOutput\getCacheExpiry(), MediaWiki\Parser\CacheTime\getCacheExpirySource(), MediaWiki\Parser\CacheTime\getCacheTime(), MediaWiki\Parser\ParserOptions\getExpensiveParserFunctionLimit(), MediaWiki\Parser\ParserOptions\getMaxIncludeSize(), MediaWiki\Parser\ParserOptions\getMaxPPExpandDepth(), MediaWiki\Parser\ParserOptions\getMaxPPNodeCount(), MediaWiki\Parser\ParserOutput\getTimeProfile(), MediaWiki\Parser\ParserOutput\hasReducedExpiry(), MediaWiki\Parser\ParserOptions\isMessage(), MediaWiki\MainConfigNames\MaxArticleSize, MediaWiki\Parser\ParserOutput\setLimitReportData(), MediaWiki\MainConfigNames\ShowHostnames, and wfHostname().

Referenced by MediaWiki\Parser\Parsoid\Config\DataAccess\makeLimitReport().

markerSkipCallback()

MediaWiki\Parser\Parser::markerSkipCallback	(		$s,
		callable	$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

Access: internal

Since

1.12

Definition at line 6339 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\formatnum(), MediaWiki\Parser\CoreParserFunctions\lc(), and MediaWiki\Parser\CoreParserFunctions\uc().

modifyImageHtml()

MediaWiki\Parser\Parser::modifyImageHtml	(	File	$file,
		array	$params,
		string &	$html )

Give hooks a chance to modify image thumbnail HTML.

Parameters

File	$file
array	$params
string	&$html

Definition at line 5728 of file Parser.php.

msg()

MediaWiki\Parser\Parser::msg	(	string	$msg,
			$params )

Helper function to correctly set the target language and title of a message based on the parser context.

Most uses of system messages inside extensions or parser functions should use this method (instead of directly using wfMessage) to ensure that the cache is not polluted.

Parameters

string	$msg	The localization message key
	MessageParam|MessageSpecifier|string|int|float|list<MessageParam|MessageSpecifier|string|int|float>	...$params See Message::params()

Returns

Message

Since

1.40

See also

https://phabricator.wikimedia.org/T202481

Definition at line 4217 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\defaultsort(), MediaWiki\Parser\CoreParserFunctions\displaytitle(), MediaWiki\Parser\ParserCoreTagHooks\html(), and MediaWiki\Parser\ParserCoreTagHooks\indicator().

nextLinkID()

MediaWiki\Parser\Parser::nextLinkID

(

)

Returns

int

Since

1.14

Definition at line 1061 of file Parser.php.

normalizeLinkUrl()

static MediaWiki\Parser\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.

Access: internal

Parameters

string

$url

Returns

string

Definition at line 2232 of file Parser.php.

parse()

MediaWiki\Parser\Parser::parse	(		$text,
		PageReference	$page,
		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
PageReference	$page
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

Since

1.10 method is public

Definition at line 596 of file Parser.php.

References MediaWiki\Parser\ParserOptions\getDisableTitleConversion(), MediaWiki\Parser\ParserOptions\getExpensiveParserFunctionLimit(), and MediaWiki\Parser\Sanitizer\removeSomeTags().

parseExtensionTagAsTopLevelDoc()

MediaWiki\Parser\Parser::parseExtensionTagAsTopLevelDoc	(	string	$text,
		PPFrame|false	$frame = false )

Needed by Parsoid/PHP to ensure all the hooks for extensions are run in the right order.

The primary differences between this and recursiveTagParseFully are: (a) absence of $frame (b) passing true to internalParseHalfParse so all hooks are run (c) running 'ParserAfterParse' hook at the same point in the parsing pipeline when parse() does it. This kinda mimics Parsoid/JS behavior where exttags are processed by the M/w API.

This is a temporary convenience method and will go away as we proceed further with Parsoid <-> Parser.php integration.

Access: internal

Deprecated

Parameters

string	$text	Wikitext source of the extension
PPFrame | false	$frame	The frame to use to expand this tag

Returns

string

Definition at line 854 of file Parser.php.

parseWidthParam()

MediaWiki\Parser\Parser::parseWidthParam	(		$value,
			$parseHeight = true,
		bool	$localized = false )

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

Parameters

string	$value
bool	$parseHeight
bool	$localized	Defaults to false; set to true if the $value has already been matched against img_width to localize the px suffix.

Returns

array{width?:int,height?:int}

Since

1.20

Access: internal

Definition at line 6387 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\filepath().

preprocess()

MediaWiki\Parser\Parser::preprocess	(		$text,
		?PageReference	$page,
		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
?PageReference	$page
ParserOptions	$options
int | null	$revid
PPFrame | false	$frame

Returns

mixed|string

Since

1.8

Definition at line 873 of file Parser.php.

preprocessToDom()

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

Get the document object model for the given wikitext.

See also

Preprocessor::preprocessToObj()

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

Parameters

string	$text	Wikitext
int	$flags	Bit field of Preprocessor::DOM_* constants

Returns

PPNode

Since

1.23 method is public

Definition at line 2816 of file Parser.php.

preSaveTransform()

MediaWiki\Parser\Parser::preSaveTransform	(		$text,
		PageReference	$page,
		UserIdentity	$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
PageReference	$page	the current article
UserIdentity	$user	the current user
ParserOptions	$options	Parsing options
bool	$clearState	Whether to clear the parser state first

Returns

string The altered wiki markup

Since

1.3

Definition at line 4656 of file Parser.php.

recursivePreprocess()

MediaWiki\Parser\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
PPFrame | false	$frame	The frame to use for expanding any template variables

Returns

string

Since

1.19

Definition at line 900 of file Parser.php.

recursiveTagParse()

MediaWiki\Parser\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
PPFrame | false	$frame	The frame to use for expanding any template variables

Returns

string UNSAFE half-parsed HTML

Since

1.8

Definition at line 804 of file Parser.php.

Referenced by MediaWiki\Parser\ParserCoreTagHooks\langconvert(), and MediaWiki\Parser\ParserCoreTagHooks\pre().

recursiveTagParseFully()

MediaWiki\Parser\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
PPFrame | false	$frame	The frame to use for expanding any template variables

Returns

string Fully parsed HTML

Definition at line 828 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\interwikilink().

renderImageGallery()

MediaWiki\Parser\Parser::renderImageGallery	(		$text,
		array	$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

Access: internal

Definition at line 5175 of file Parser.php.

replaceSection()

MediaWiki\Parser\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 | false	$newText	Replacing text

Returns

string|false Modified text

Since

1.7

Definition at line 5982 of file Parser.php.

replaceTableOfContentsMarker()

static MediaWiki\Parser\Parser::replaceTableOfContentsMarker ( $text, $toc )

static

Replace table of contents marker in parsed HTML.

Used to remove or replace the marker. This method should be used instead of direct access to Parser::TOC_PLACEHOLDER, since in the future the placeholder might have additional attributes attached which should be ignored when the replacement is made.

Since

1.38

Stability: stable

Parameters

string	$text	Parsed HTML
string	$toc	HTML table of contents string, or else an empty string to remove the marker.

Returns

string Result HTML

Definition at line 4922 of file Parser.php.

replaceVariables()

MediaWiki\Parser\Parser::replaceVariables	(		$text,
			$frame = false,
			$argsOnly = false,
		array	$options = [] )

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.
array	$options	Various options used by Parsoid: 'parsoidTopLevelCall' Is this coming from Parsoid for top-level templates? This is used to set start-of-line flag to true for template expansions since that is how Parsoid models templates.

Returns

string

Since

1.24 method is public

Definition at line 2846 of file Parser.php.

resetOutput()

MediaWiki\Parser\Parser::resetOutput

(

)

Reset the ParserOutput.

Since

1.34

Definition at line 553 of file Parser.php.

Referenced by MediaWiki\Parser\Parser\clearState(), and MediaWiki\Parser\Parsoid\Config\DataAccess\preprocessWikitext().

setFunctionHook()

MediaWiki\Parser\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 most wikitext transformation, but perform language conversion and some other postprocessing isRawHTML The returned text is raw HTML, include it verbatim in the output.

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.

Returns

?callable The old callback function for this name, if any

Since

1.6

Definition at line 5102 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\register().

setHook()

MediaWiki\Parser\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, array $params, Parser $parser, PPFrame $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. The following other keys are used:

• 'markerType': used by some core tag hooks to override which strip array their results are placed in, 'general' or 'nowiki'.

Parameters

string	$tag	The tag to use, e.g. 'hook' for "<hook>"
callable	$callback	The callback to use for the tag

Returns

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

Since

1.3

Definition at line 5031 of file Parser.php.

setLinkID()

MediaWiki\Parser\Parser::setLinkID

(

$id

)

Parameters

int

$id

Since

1.8

Definition at line 1069 of file Parser.php.

setOptions()

MediaWiki\Parser\Parser::setOptions

(

ParserOptions

$options

)

Mutator for the ParserOptions object.

Parameters

ParserOptions

$options

The new parser options

Since

1.35

Definition at line 1053 of file Parser.php.

setOutputType()

MediaWiki\Parser\Parser::setOutputType

(

$ot

)

Mutator for the output type.

Parameters

int

$ot

One of the Parser::OT_… constants

Since

1.8

Definition at line 1021 of file Parser.php.

setPage()

MediaWiki\Parser\Parser::setPage

(

?PageReference

$t = null

)

Set the page used as context for parsing, e.g.

when resolving relative subpage links.

Since

1.37

Parameters

?PageReference

$t

Definition at line 972 of file Parser.php.

References NS_SPECIAL.

setTitle()

MediaWiki\Parser\Parser::setTitle

(

?Title

$t = null

)

Set the context title.

Deprecated

since 1.37, use setPage() instead.

Parameters

Title | null

$t

Since

1.12

Definition at line 953 of file Parser.php.

setUseParsoidFragments()

MediaWiki\Parser\Parser::setUseParsoidFragments

(

bool

$val

)

Access: internal

Definition at line 2876 of file Parser.php.

setUser()

MediaWiki\Parser\Parser::setUser

(

?UserIdentity

$user

)

Set the current user.

Should only be used when doing pre-save transform.

Parameters

UserIdentity | null

$user

user identity or null (to reset)

Since

1.17

Definition at line 942 of file Parser.php.

startExternalParse()

MediaWiki\Parser\Parser::startExternalParse	(	?PageReference	$page,
		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

?PageReference	$page
ParserOptions	$options
int	$outputType	One of the Parser::OT_… constants
bool	$clearState
int | null	$revId

Since

1.3

Definition at line 4962 of file Parser.php.

statelessFetchRevisionRecord()

static MediaWiki\Parser\Parser::statelessFetchRevisionRecord ( LinkTarget $link, $parser = null )

static

Deprecated

since 1.47 Use ParserOptions::getCurrentRevisionRecordCallback()

Since

1.34

Parameters

LinkTarget	$link
Parser | null	$parser

Returns

RevisionRecord|false False if missing

Definition at line 3575 of file Parser.php.

References wfDeprecated().

statelessFetchTemplate()

static MediaWiki\Parser\Parser::statelessFetchTemplate ( $page, $parser = false )

static

Deprecated

since 1.47 use ParserOptions::getTemplateCallback()

Parameters

LinkTarget	$page
Parser | false	$parser

Returns

array

Definition at line 3795 of file Parser.php.

stripOuterParagraph()

static MediaWiki\Parser\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 6476 of file Parser.php.

stripSectionName()

MediaWiki\Parser\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 mimicking 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

Since

1.12

Definition at line 6301 of file Parser.php.

tagNeedsNowikiStrippedInTagPF()

MediaWiki\Parser\Parser::tagNeedsNowikiStrippedInTagPF

(

string

$lowerTagName

)

Definition at line 3973 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\tagObj().

transformMsg()

MediaWiki\Parser\Parser::transformMsg	(		$text,
		ParserOptions	$options,
		?PageReference	$page = null )

Wrapper for preprocess()

Parameters

string	$text	The text to preprocess
ParserOptions	$options
?PageReference	$page	The context page

Returns

string

Since

1.3

Definition at line 4997 of file Parser.php.

useParsoidFragments()

MediaWiki\Parser\Parser::useParsoidFragments

(

)

Access: internal

Definition at line 2881 of file Parser.php.

validateSig()

MediaWiki\Parser\Parser::validateSig

(

$text

)

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

Parameters

string

$text

Returns

string|false An expanded string, or false if invalid.

Since

1.6

Definition at line 4844 of file Parser.php.

Member Data Documentation

$mExpensiveFunctionCount

MediaWiki\Parser\Parser::$mExpensiveFunctionCount

Number of expensive parser function calls.

Deprecated

since 1.35

Definition at line 281 of file Parser.php.

$mExtArrays

MediaWiki\Parser\Parser::$mExtArrays

Deprecated

since 1.42: T203532

Definition at line 302 of file Parser.php.

$mExtHashTables

MediaWiki\Parser\Parser::$mExtHashTables

Deprecated

since 1.42: T359887

Definition at line 304 of file Parser.php.

$mExtLoopsCounter

MediaWiki\Parser\Parser::$mExtLoopsCounter

Deprecated

since 1.42: T203563

Definition at line 306 of file Parser.php.

$mExtVariables

MediaWiki\Parser\Parser::$mExtVariables

Deprecated

since 1.42: T203531

Definition at line 300 of file Parser.php.

$mHeadings

array MediaWiki\Parser\Parser::$mHeadings

Access: internal

Definition at line 274 of file Parser.php.

$mHighestExpansionDepth

int MediaWiki\Parser\Parser::$mHighestExpansionDepth

Access: internal

Definition at line 271 of file Parser.php.

$mMarkerIndex

MediaWiki\Parser\Parser::$mMarkerIndex = 0

Deprecated

since 1.35

Definition at line 241 of file Parser.php.

$mPPNodeCount

int MediaWiki\Parser\Parser::$mPPNodeCount

Access: internal

Definition at line 266 of file Parser.php.

CONSTRUCTOR_OPTIONS

const MediaWiki\Parser\Parser::CONSTRUCTOR_OPTIONS

Initial value:

= [
        
        
        MainConfigNames::AllowDisplayTitle,
        MainConfigNames::AllowSlowParserFunctions,
        MainConfigNames::ArticlePath,
        MainConfigNames::EnableScaryTranscluding,
        MainConfigNames::ExtraInterlanguageLinkPrefixes,
        MainConfigNames::FragmentMode,
        MainConfigNames::Localtimezone,
        MainConfigNames::MaxArticleSize,
        MainConfigNames::MaxSigChars,
        MainConfigNames::MaxTocLevel,
        MainConfigNames::MiserMode,
        MainConfigNames::RawHtml,
        MainConfigNames::ScriptPath,
        MainConfigNames::Server,
        MainConfigNames::ServerName,
        MainConfigNames::ShowHostnames,
        MainConfigNames::SignatureValidation,
        MainConfigNames::Sitename,
        MainConfigNames::StylePath,
        MainConfigNames::TranscludeCacheExpiry,
        MainConfigNames::PreprocessorCacheThreshold,
        MainConfigNames::EnableParserLimitReporting,
        MainConfigNames::ParserEnableUserLanguage,
    ]

Access: internal

For use by ServiceWiring

Definition at line 361 of file Parser.php.

Referenced by MediaWiki\Parser\ParserFactory\__construct().

EXT_LINK_URL_CLASS

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

Everything except bracket, space, or control characters.

\p{Zs} is unicode 'separator, space' category. It covers the space 0x20 as well as U+3000 is IDEOGRAPHIC SPACE for T21052. \x{FFFD} is the Unicode replacement character, which the HTML5 spec uses to replace invalid HTML characters.

Definition at line 154 of file Parser.php.

MARKER_PREFIX

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

Definition at line 206 of file Parser.php.

Referenced by MediaWiki\Parser\StripState\__construct(), and MediaWiki\Parser\PPFrame_Hash\expand().

OT_HTML

const MediaWiki\Parser\Parser::OT_HTML = 1

Output type: like Parser::parse()

Definition at line 177 of file Parser.php.

Referenced by MediaWiki\Parser\PPFrame_Hash\expand(), and MediaWiki\Parser\Parsoid\Config\DataAccess\makeLimitReport().

OT_PLAIN

const MediaWiki\Parser\Parser::OT_PLAIN = 4

Output type: like Parser::extractSections() - portions of the original are returned unchanged.

Definition at line 186 of file Parser.php.

OT_PREPROCESS

const MediaWiki\Parser\Parser::OT_PREPROCESS = 3

Output type: like Parser::preprocess()

Definition at line 181 of file Parser.php.

Referenced by MediaWiki\Parser\PPFrame_Hash\expand().

OT_WIKI

const MediaWiki\Parser\Parser::OT_WIKI = 2

Output type: like Parser::preSaveTransform()

Definition at line 179 of file Parser.php.

Referenced by MediaWiki\Parser\PPFrame_Hash\expand().

SFH_NO_HASH

const MediaWiki\Parser\Parser::SFH_NO_HASH = 1

Definition at line 143 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\register().

SFH_OBJECT_ARGS

const MediaWiki\Parser\Parser::SFH_OBJECT_ARGS = 2

Definition at line 144 of file Parser.php.

Referenced by MediaWiki\Parser\CoreParserFunctions\register().

---

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

• includes/Parser/Parser.php