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 (ServiceOptions $svcOptions, MagicWordFactory $magicWordFactory, Language $contLang, ParserFactory $factory, UrlUtils $urlUtils, SpecialPageFactory $spFactory, LinkRendererFactory $linkRendererFactory, NamespaceInfo $nsInfo, LoggerInterface $logger, BadFileLookup $badFileLookup, LanguageConverterFactory $languageConverterFactory, HookContainer $hookContainer, TidyDriverBase $tidy, WANObjectCache $wanCache, UserOptionsLookup $userOptionsLookup, UserFactory $userFactory, TitleFormatter $titleFormatter, HttpRequestFactory $httpRequestFactory, TrackingCategories $trackingCategories, SignatureValidatorFactory $signatureValidatorFactory, 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.

	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 (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=[])
	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.

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

	doQuotes ( $text)
	Helper function for handleAllQuotes()

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

	extensionSubstitution (array $params, PPFrame $frame, bool $processNowiki=false)
	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.

	getCustomDefaultSort ()
	Accessor for the 'defaultsort' page property.

	getDefaultSort ()
	Accessor for the 'defaultsort' page property.

	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.

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

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

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

	getOptions ()

	getOutput ()

	getOutputType ()
	Accessor for the output type.

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

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

	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,... $args)
	Helper function to correctly set the target language and title of a message based on the parser context.

	nextLinkID ()

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

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

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

	parseExtensionTagAsTopLevelDoc ( $text)
	Needed by Parsoid/PHP to ensure all the hooks for extensions are run in the right order.

	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.

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

	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)
	Replace magic variables, templates, and template arguments with the appropriate text.

	resetOutput ()
	Reset the ParserOutput.

	setDefaultSort ( $sort)
	Mutator for the 'defaultsort' page property.

	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.

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

	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	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)
	Add HTML tags marking the parts of a page title, to be displayed in the first heading of the page.

static	getExternalLinkRel ( $url=false, LinkTarget $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	replaceTableOfContentsMarker ( $text, $toc)
	Replace table of contents marker in parsed HTML.

static	statelessFetchRevisionRecord (LinkTarget $link, $parser=null)
	Wrapper around RevisionLookup::getKnownCurrentRevision.

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

static	stripOuterParagraph ( $html)
	Strip outer.

Public Attributes
	$mExpensiveFunctionCount
	Number of expensive parser function calls.

array	$mHeadings

	$mHighestExpansionDepth

	$mMarkerIndex = 0

ParserOptions null	$mOptions

	$mPPNodeCount

Title	$mTitle
	Title context, used for self-link rendering and similar things.

	$ot
	Shortcut alias, see Parser::setOutputType()

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.

	makeLimitReport ()
	Set the limit report data in the current ParserOutput.

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 115 of file Parser.php.

Constructor & Destructor Documentation

◆ __construct()

Parser::__construct	(	ServiceOptions	$svcOptions,
		MagicWordFactory	$magicWordFactory,
		Language	$contLang,
		ParserFactory	$factory,
		UrlUtils	$urlUtils,
		SpecialPageFactory	$spFactory,
		LinkRendererFactory	$linkRendererFactory,
		NamespaceInfo	$nsInfo,
		LoggerInterface	$logger,
		BadFileLookup	$badFileLookup,
		LanguageConverterFactory	$languageConverterFactory,
		HookContainer	$hookContainer,
		TidyDriverBase	$tidy,
		WANObjectCache	$wanCache,
		UserOptionsLookup	$userOptionsLookup,
		UserFactory	$userFactory,
		TitleFormatter	$titleFormatter,
		HttpRequestFactory	$httpRequestFactory,
		TrackingCategories	$trackingCategories,
		SignatureValidatorFactory	$signatureValidatorFactory,
		UserNameUtils	$userNameUtils )

Constructing parsers directly is not allowed! Use a ParserFactory.

Access: internal

Parameters

ServiceOptions	$svcOptions
MagicWordFactory	$magicWordFactory
Language	$contLang	Content language
ParserFactory	$factory
UrlUtils	$urlUtils
SpecialPageFactory	$spFactory
LinkRendererFactory	$linkRendererFactory
NamespaceInfo	$nsInfo
LoggerInterface	$logger
BadFileLookup	$badFileLookup
LanguageConverterFactory	$languageConverterFactory
HookContainer	$hookContainer
TidyDriverBase	$tidy
WANObjectCache	$wanCache
UserOptionsLookup	$userOptionsLookup
UserFactory	$userFactory
TitleFormatter	$titleFormatter
HttpRequestFactory	$httpRequestFactory
TrackingCategories	$trackingCategories
SignatureValidatorFactory	$signatureValidatorFactory
UserNameUtils	$userNameUtils

Definition at line 402 of file Parser.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), MediaWiki\Config\ServiceOptions\get(), MediaWiki\Languages\LanguageConverterFactory\isConversionDisabled(), NS_SPECIAL, CoreTagHooks\register(), CoreTagHooks\REGISTER_OPTIONS, and MediaWiki\Utils\UrlUtils\validProtocols().

◆ __destruct()

Parser::__destruct ( )

Reduce memory usage to reduce the impact of circular references.

Definition at line 493 of file Parser.php.

Member Function Documentation

◆ __clone()

Parser::__clone ( )

Allow extensions to clean up when the parser is cloned.

Definition at line 508 of file Parser.php.

◆ addTrackingCategory()

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 4087 of file Parser.php.

Referenced by CoreParserFunctions\displaytitle().

◆ argSubstitution()

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

Triple brace replacement – used for template arguments.

Access: internal

Parameters

array	$piece
PPFrame	$frame

Returns: array

Access: internal

Definition at line 3847 of file Parser.php.

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

◆ 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
PPFrame \| false	$frame

Returns: string

Deprecated: since 1.35, internal callback should not have been public

Definition at line 5623 of file Parser.php.

References wfDeprecated().

◆ braceSubstitution()

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 2953 of file Parser.php.

References Preprocessor\DOM_FOR_INCLUSION, PPFrame\expand(), getTitle(), PPFrame\loopCheck(), PPFrame\newChild(), NS_TEMPLATE, Message\plaintextParam(), RequestContext\setTitle(), PPFrame\virtualBracketedImplode(), wfDeprecatedMsg(), wfEscapeWikiText(), and wfMessage().

◆ callParserFunction()

Parser::callParserFunction	(	PPFrame	$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

Returns: array

Definition at line 3335 of file Parser.php.

References PPFrame\expand().

◆ 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

Since: 1.6

Definition at line 4704 of file Parser.php.

References getUser().

◆ 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

Since: 1.7

Definition at line 4746 of file Parser.php.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\cleanSignature().

◆ clearState()

Parser::clearState ( )

Clear Parser state.

Access: internal

Definition at line 550 of file Parser.php.

References getHookContainer(), and resetOutput().

◆ clearTagHooks()

Parser::clearTagHooks ( )

Remove all tag hooks.

Since: 1.12

Definition at line 4870 of file Parser.php.

◆ 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: internal

Returns: string The lists rendered as HTML

Deprecated: since 1.35, will not be supported in future parsers

Definition at line 2771 of file Parser.php.

References BlockLevelPass\doBlockLevels(), and wfDeprecated().

◆ doQuotes()

Parser::doQuotes ( $text )

Helper function for handleAllQuotes()

Parameters

string $text

Returns: string

Access: internal

Definition at line 1936 of file Parser.php.

Referenced by CoreParserFunctions\displaytitle().

◆ 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

Deprecated: since 1.35, use $parser->getOutput()->setEnableOOUI() instead.

Definition at line 6408 of file Parser.php.

References wfDeprecated().

◆ extensionSubstitution()

Parser::extensionSubstitution	(	array	$params,
		PPFrame	$frame,
		bool	$processNowiki = false )

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
bool	$processNowiki	Process nowiki tags by running the nowiki tag handler Normally, nowikis are only processed for the HTML output type. With this arg set to true, they are processed (and converted to a nowiki strip marker) for all output types.

Returns: string

Access: internal

Since: 1.12

Definition at line 3912 of file Parser.php.

References $content, and PPFrame\expand().

Referenced by CoreParserFunctions\tagObj().

◆ extractTagsAndParams()

static 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 1222 of file Parser.php.

References $content, and $matches.

◆ fetchCurrentRevisionRecordOfTitle()

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 3470 of file Parser.php.

◆ fetchFileAndTitle()

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 or false, Title of file )

Since: 1.18

Definition at line 3725 of file Parser.php.

References $file, MediaWiki\Linker\LinkTarget\getDBkey(), and MediaWiki\Linker\LinkTarget\isSameLinkAs().

◆ fetchFileNoRegister()

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 3752 of file Parser.php.

References $file.

◆ fetchTemplateAndTitle()

Parser::fetchTemplateAndTitle ( LinkTarget $link )

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

Parameters

LinkTarget $link

Returns: array ( string or false, Title )

Since: 1.11

Definition at line 3539 of file Parser.php.

References getTitle().

◆ firstCallInit()

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 538 of file Parser.php.

◆ formatPageTitle()

static Parser::formatPageTitle	(	$nsText,
		$nsSeparator,
		$mainText )

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

Returns: string HTML

Definition at line 6371 of file Parser.php.

Referenced by MediaWiki\Output\OutputPage\getUnprefixedDisplayTitle(), parse(), and Article\view().

◆ getBadFileLookup()

Parser::getBadFileLookup ( )

Get the BadFileLookup instance that this Parser is using.

Since: 1.35

Returns: BadFileLookup

Definition at line 1199 of file Parser.php.

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

◆ getContentLanguage()

Parser::getContentLanguage ( )

Get the content language that this Parser is using.

Since: 1.32

Returns: Language

Definition at line 1189 of file Parser.php.

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

◆ getCustomDefaultSort()

Parser::getCustomDefaultSort ( )

Accessor for the 'defaultsort' page property.

Unlike getDefaultSort(), will return false if none is set

Returns: string|false

Since: 1.14

Deprecated: since 1.38, use $parser->getOutput()->getPageProperty('defaultsort') ?? false

Definition at line 6094 of file Parser.php.

References wfDeprecated().

◆ getDefaultSort()

Parser::getDefaultSort ( )

Accessor for the 'defaultsort' page property.

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

Since: 1.9

Deprecated: since 1.38, use $parser->getOutput()->getPageProperty('defaultsort') ?? ''

Definition at line 6080 of file Parser.php.

References wfDeprecated().

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

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 2226 of file Parser.php.

References getTitle().

◆ getExternalLinkRel()

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

static

Get the rel attribute for a particular external link.

Since: 1.21

Access: internal

Parameters

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

Returns: string|null Rel attribute for $url

Definition at line 2201 of file Parser.php.

References wfMatchesDomainList().

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

◆ getFlatSectionInfo()

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 5867 of file Parser.php.

References getUser().

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

Deprecated: since 1.39, use ParserFactory::getInstance(), Hard-deprecated since 1.41.

Since: 1.24

Returns: Parser A parser object that is not parsing anything

Definition at line 6392 of file Parser.php.

References wfDeprecated().

◆ getFunctionHooks()

Parser::getFunctionHooks ( )

Get all registered function hook identifiers.

Returns: array

Since: 1.8

Definition at line 4955 of file Parser.php.

◆ getFunctionLang()

Parser::getFunctionLang ( )

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

Returns: Language

Since: 1.7

Deprecated: since 1.40; use getTargetLanguage() instead.

Definition at line 1112 of file Parser.php.

References wfDeprecated().

◆ getFunctionSynonyms()

Parser::getFunctionSynonyms ( )

Since: 1.32

Returns: array

Definition at line 5644 of file Parser.php.

◆ getHookContainer()

Parser::getHookContainer ( )

protected

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

Since: 1.35

Returns: HookContainer

Definition at line 1622 of file Parser.php.

Referenced by clearState().

◆ getHookRunner()

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 1634 of file Parser.php.

◆ getLinkRenderer()

Parser::getLinkRenderer ( )

Get a LinkRenderer instance to make links with.

Since: 1.28

Returns: LinkRenderer

Definition at line 1164 of file Parser.php.

◆ getMagicWordFactory()

Parser::getMagicWordFactory ( )

Get the MagicWordFactory that this Parser is using.

Since: 1.32

Returns: MagicWordFactory

Definition at line 1179 of file Parser.php.

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

◆ getOptions()

Parser::getOptions ( )

Returns: ParserOptions|null

Since: 1.6

Definition at line 1065 of file Parser.php.

Referenced by CoreParserFunctions\formatDate(), CoreParserFunctions\gender(), CoreTagHooks\html(), CoreParserFunctions\intFunction(), and CoreParserFunctions\revisionid().

◆ getOutput()

Parser::getOutput ( )

Returns: ParserOutput

Since: 1.14

Definition at line 1051 of file Parser.php.

References wfDeprecated().

Referenced by CoreParserFunctions\defaultsort(), CoreParserFunctions\displaytitle(), CoreMagicVariables\expand(), CoreParserFunctions\pageid(), CoreParserFunctions\revisionid(), CoreParserFunctions\revisionuser(), and TraditionalImageGallery\toHTML().

◆ getOutputType()

Parser::getOutputType ( )

Accessor for the output type.

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

Since: 1.35

Definition at line 1015 of file Parser.php.

◆ getPage()

Parser::getPage ( )

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

when resolving relative subpage links.

Since: 1.37

Returns: ?PageReference Null if no page is set (deprecated since 1.34)

Definition at line 997 of file Parser.php.

References wfDeprecated().

◆ getPreloadText()

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 922 of file Parser.php.

References Preprocessor\DOM_FOR_INCLUSION, getPreprocessor(), lock(), and preprocessToDom().

◆ getPreprocessor()

Parser::getPreprocessor ( )

Get a preprocessor object.

Returns: Preprocessor

Since: 1.12.0

Definition at line 1154 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 getCurrentRevisionRecordCallback()
c) Null, meaning the parse is for preview mode and there is no revision

Returns: int|null

Since: 1.13

Definition at line 5921 of file Parser.php.

Referenced by CoreParserFunctions\revisionid().

◆ getRevisionRecordObject()

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 5931 of file Parser.php.

Referenced by CoreParserFunctions\revisionid().

◆ getRevisionSize()

Parser::getRevisionSize ( )

Get the size of the revision.

Returns: int|null Revision size

Since: 1.22

Definition at line 6038 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

Since: 1.9

Definition at line 5986 of file Parser.php.

◆ getRevisionUser()

Parser::getRevisionUser ( )

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

Returns: string|null User name

Since: 1.15

Definition at line 6014 of file Parser.php.

Referenced by CoreParserFunctions\revisionuser().

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

Returns: string Text of the requested section

Since: 1.7

Definition at line 5817 of file Parser.php.

◆ getStripList()

Parser::getStripList ( )

Get a list of strippable XML-like elements.

Returns: array

Definition at line 1285 of file Parser.php.

Referenced by CoreParserFunctions\tagObj().

◆ getStripState()

Parser::getStripState ( )

Returns: StripState

Since: 1.34

Definition at line 1293 of file Parser.php.

◆ getTags()

Parser::getTags ( )

Accessor.

Returns: array

Since: 1.6

Definition at line 5636 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

Returns: Language

Definition at line 1125 of file Parser.php.

References getTitle().

◆ getTargetLanguageConverter()

Parser::getTargetLanguageConverter ( )

Shorthand for getting a Language Converter for Target language.

Since: public since 1.38

Returns: ILanguageConverter

Definition at line 1598 of file Parser.php.

Referenced by CoreParserFunctions\defaultsort(), CoreParserFunctions\displaytitle(), and parse().

◆ getTemplateDom()

Parser::getTemplateDom ( LinkTarget $title )

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

Cached.

Parameters

LinkTarget $title

Returns: array

Since: 1.12

Definition at line 3425 of file Parser.php.

References Preprocessor\DOM_FOR_INCLUSION, MediaWiki\Linker\LinkTarget\getDBkey(), and MediaWiki\Linker\LinkTarget\getNamespace().

◆ getTitle()

Parser::getTitle ( )

Since: 1.6

Deprecated: since 1.37, use getPage instead.

Returns: Title

Definition at line 964 of file Parser.php.

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

◆ getUrlProtocols()

Parser::getUrlProtocols ( )

Since: 1.32

Returns: string

Definition at line 5652 of file Parser.php.

◆ getUserIdentity()

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 1144 of file Parser.php.

◆ getUserSig()

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 4620 of file Parser.php.

References MediaWiki\User\UserIdentity\getName(), MediaWiki\User\UserIdentity\isRegistered(), wfEscapeWikiText(), and wfMessage().

◆ 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 '#')

Since: 1.17

Definition at line 6148 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 '#')

Since: 1.31

Definition at line 6161 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 '#')

Since: 1.12

Definition at line 6131 of file Parser.php.

Referenced by CoreParserFunctions\anchorencode().

◆ incrementExpensiveFunctionCount()

Parser::incrementExpensiveFunctionCount ( )

Returns: bool False if the limit has been exceeded

Since: 1.13

Definition at line 4018 of file Parser.php.

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

◆ 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 1306 of file Parser.php.

◆ 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: internal

Parameters

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

Returns: string

Definition at line 1529 of file Parser.php.

References Preprocessor\DOM_FOR_INCLUSION.

Referenced by parse(), and recursiveTagParse().

◆ interwikiTransclude()

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 3775 of file Parser.php.

References wfMessage().

◆ isCurrentRevisionOfTitleCached()

Parser::isCurrentRevisionOfTitleCached ( LinkTarget $link )

Parameters

LinkTarget $link

Returns: bool

Since: 1.34

Access: internal

Definition at line 3500 of file Parser.php.

◆ isLocked()

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 6338 of file Parser.php.

◆ killMarkers()

Parser::killMarkers ( $text )

Remove any strip markers found in the given text.

Parameters

string $text

Returns: string

Since: 1.19

Definition at line 6270 of file Parser.php.

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

◆ 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)

Access: internal

Definition at line 2928 of file Parser.php.

References Message\numParam().

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 6313 of file Parser.php.

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

◆ makeImage()

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

Returns: string HTML

Since: 1.5

Definition at line 5249 of file Parser.php.

References $file, and MediaWiki\Linker\LinkTarget\getText().

◆ makeLimitReport()

Parser::makeLimitReport ( )

protected

Set the limit report data in the current ParserOutput.

Definition at line 719 of file Parser.php.

References wfHostname().

Referenced by parse().

◆ markerSkipCallback()

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 6239 of file Parser.php.

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

◆ modifyImageHtml()

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 5552 of file Parser.php.

References $file.

◆ msg()

Parser::msg	(	string	$msg,
			$args )

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
	mixed	...$args Optional arguments for the message

Returns: Message

Since: 1.40

See also: https://phabricator.wikimedia.org/T202481

Definition at line 4106 of file Parser.php.

Referenced by CoreParserFunctions\defaultsort(), CoreParserFunctions\displaytitle(), CoreTagHooks\html(), and CoreTagHooks\indicator().

◆ nextLinkID()

Parser::nextLinkID ( )

Returns: int

Since: 1.14

Definition at line 1094 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.

Access: internal

Parameters

string $url

Returns: string

Definition at line 2259 of file Parser.php.

Referenced by MediaWiki\Specials\SpecialLinkSearch\execute(), and ApiQueryExternalLinks\execute().

◆ 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

Deprecated: since 1.35, use getOptions() / setOptions()

Definition at line 1085 of file Parser.php.

References wfDeprecated(), and 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

Deprecated: since 1.35, use getOutputType()/setOutputType()

Definition at line 1042 of file Parser.php.

References wfDeprecated(), and wfSetVar().

◆ parse()

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
-taint	$text	escapes_htmlnoent
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; -taint escaped

Since: 1.10 method is public

Definition at line 619 of file Parser.php.

References formatPageTitle(), ParserOptions\getDisableTitleConversion(), getTargetLanguageConverter(), internalParse(), limitationWarn(), lock(), and makeLimitReport().

Referenced by MessageCache\parse().

◆ parseExtensionTagAsTopLevelDoc()

Parser::parseExtensionTagAsTopLevelDoc ( $text )

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

Returns: string; -taint escaped

Definition at line 856 of file Parser.php.

References recursiveTagParse().

◆ 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

Access: internal

Definition at line 6284 of file Parser.php.

Referenced by CoreParserFunctions\filepath(), ImageGalleryBase\setHeights(), and ImageGalleryBase\setWidths().

◆ preprocess()

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 875 of file Parser.php.

References lock(), and replaceVariables().

◆ preprocessToDom()

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 2852 of file Parser.php.

Referenced by getPreloadText().

◆ preSaveTransform()

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 4499 of file Parser.php.

References ParserOptions\getPreSaveTransform().

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

Returns: string

Since: 1.19

Definition at line 902 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
PPFrame \| false	$frame	The frame to use for expanding any template variables

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

Since: 1.8

Definition at line 807 of file Parser.php.

References internalParse().

Referenced by CoreTagHooks\langconvert(), parseExtensionTagAsTopLevelDoc(), and recursiveTagParseFully().

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

Returns: string Fully parsed HTML; -taint escaped

Definition at line 831 of file Parser.php.

References recursiveTagParse().

◆ renderImageGallery()

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 5005 of file Parser.php.

References $file, $lines, $matches, getTitle(), and NS_FILE.

◆ replaceLinkHolders()

Parser::replaceLinkHolders ( & $text )

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

Parameters

string &$text

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

Definition at line 4966 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 \| false	$newText	Replacing text

Returns: string Modified text

Since: 1.7

Definition at line 5834 of file Parser.php.

◆ replaceTableOfContentsMarker()

static 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 4767 of file Parser.php.

Referenced by ParserOutput\getText().

◆ 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

Since: 1.24 method is public

Definition at line 2877 of file Parser.php.

Referenced by preprocess(), and recursivePreprocess().

◆ resetOutput()

Parser::resetOutput ( )

Reset the ParserOutput.

Since: 1.34

Definition at line 596 of file Parser.php.

Referenced by clearState().

◆ setDefaultSort()

Parser::setDefaultSort ( $sort )

Mutator for the 'defaultsort' page property.

Parameters

string $sort New value

Since: 1.0

Deprecated: since 1.38, use $parser->getOutput()->setPageProperty('defaultsort', $sort)

Definition at line 6062 of file Parser.php.

References wfDeprecated().

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

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

Since: 1.6

Definition at line 4918 of file Parser.php.

Referenced by CoreParserFunctions\register().

◆ 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, 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 4852 of file Parser.php.

Referenced by CoreTagHooks\register().

◆ setLinkID()

Parser::setLinkID ( $id )

Parameters

int $id

Since: 1.8

Definition at line 1102 of file Parser.php.

◆ setOptions()

Parser::setOptions ( ParserOptions $options )

Mutator for the ParserOptions object.

Parameters

ParserOptions $options The new parser options

Since: 1.35

Definition at line 1074 of file Parser.php.

◆ setOutputType()

Parser::setOutputType ( $ot )

Mutator for the output type.

Parameters

int $ot One of the Parser::OT_… constants

Since: 1.8

Definition at line 1024 of file Parser.php.

◆ setPage()

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 974 of file Parser.php.

References NS_SPECIAL.

Referenced by setTitle().

◆ setTitle()

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 955 of file Parser.php.

References setPage().

◆ setUser()

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 944 of file Parser.php.

◆ startExternalParse()

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 4783 of file Parser.php.

◆ statelessFetchRevisionRecord()

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

static

Wrapper around RevisionLookup::getKnownCurrentRevision.

Since: 1.34

Parameters

LinkTarget	$link
Parser \| null	$parser

Returns: RevisionRecord|false False if missing

Definition at line 3516 of file Parser.php.

◆ statelessFetchTemplate()

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

static

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

Parameters

LinkTarget	$page
Parser \| false	$parser

Returns: array

Since: 1.12

Definition at line 3581 of file Parser.php.

References $content, NS_MEDIAWIKI, and wfMessage().

◆ 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 6352 of file Parser.php.

Referenced by ApiParamInfo\formatHelpMessages(), Installer\parse(), MediaWiki\Output\OutputPage\parseInlineAsInterface(), and MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().

◆ 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 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 6201 of file Parser.php.

◆ tagNeedsNowikiStrippedInTagPF()

Parser::tagNeedsNowikiStrippedInTagPF ( string $lowerTagName )

Parameters

string $lowerTagName

Returns: bool

Definition at line 3888 of file Parser.php.

Referenced by CoreParserFunctions\tagObj().

◆ transformMsg()

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 4818 of file Parser.php.

Referenced by MessageCache\transform().

◆ validateSig()

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 4689 of file Parser.php.

Member Data Documentation

◆ $mExpensiveFunctionCount

Parser::$mExpensiveFunctionCount

Number of expensive parser function calls.

Deprecated: since 1.35

Definition at line 255 of file Parser.php.

◆ $mHeadings

array Parser::$mHeadings

Access: internal

Definition at line 248 of file Parser.php.

◆ $mHighestExpansionDepth

Parser::$mHighestExpansionDepth

Deprecated: since 1.35

Definition at line 245 of file Parser.php.

◆ $mMarkerIndex

Parser::$mMarkerIndex = 0

Deprecated: since 1.35

Definition at line 224 of file Parser.php.

◆ $mOptions

ParserOptions null Parser::$mOptions

Deprecated: since 1.35, use Parser::getOptions()

Definition at line 268 of file Parser.php.

◆ $mPPNodeCount

Parser::$mPPNodeCount

Deprecated: since 1.35

Definition at line 243 of file Parser.php.

◆ $mTitle

Title Parser::$mTitle

Title context, used for self-link rendering and similar things.

Deprecated: since 1.35, use Parser::getPage()

Definition at line 275 of file Parser.php.

◆ $ot

Parser::$ot

Shortcut alias, see Parser::setOutputType()

Deprecated: since 1.35

Definition at line 282 of file Parser.php.

◆ CONSTRUCTOR_OPTIONS

const Parser::CONSTRUCTOR_OPTIONS

Initial value:

= [
        
        
        MainConfigNames::AllowDisplayTitle,
        MainConfigNames::AllowSlowParserFunctions,
        MainConfigNames::ArticlePath,
        MainConfigNames::EnableScaryTranscluding,
        MainConfigNames::ExtraInterlanguageLinkPrefixes,
        MainConfigNames::FragmentMode,
        MainConfigNames::Localtimezone,
        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::ParserEnableLegacyMediaDOM,
        MainConfigNames::EnableParserLimitReporting,
    ]

Access: internal: For use by ServiceWiring

Definition at line 349 of file Parser.php.

Referenced by ParserFactory\__construct().

◆ EXT_LINK_URL_CLASS

const 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 129 of file Parser.php.

◆ MARKER_PREFIX

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

Definition at line 181 of file Parser.php.

Referenced by StripState\__construct(), LanguageConverter\autoConvert(), and PPFrame_Hash\expand().

◆ OT_HTML

const Parser::OT_HTML = 1

Output type: like Parser::parse()

Definition at line 152 of file Parser.php.

◆ OT_PLAIN

const Parser::OT_PLAIN = 4

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

Definition at line 161 of file Parser.php.

◆ OT_PREPROCESS

const Parser::OT_PREPROCESS = 3

Output type: like Parser::preprocess()

Definition at line 156 of file Parser.php.

Referenced by MediaWiki\Specials\SpecialExpandTemplates\execute(), ApiExpandTemplates\execute(), and ApiParse\execute().

◆ OT_WIKI

const Parser::OT_WIKI = 2

Output type: like Parser::preSaveTransform()

Definition at line 154 of file Parser.php.

◆ SFH_NO_HASH

const Parser::SFH_NO_HASH = 1

Definition at line 118 of file Parser.php.

Referenced by CoreParserFunctions\register().

◆ SFH_OBJECT_ARGS

const Parser::SFH_OBJECT_ARGS = 2

Definition at line 119 of file Parser.php.

Referenced by CoreParserFunctions\register().

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

includes/parser/Parser.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ __clone()

◆ addTrackingCategory()

◆ argSubstitution()

◆ attributeStripCallback()

◆ braceSubstitution()

◆ callParserFunction()

◆ cleanSig()

◆ cleanSigInSig()

◆ clearState()

◆ clearTagHooks()

◆ doBlockLevels()

◆ doQuotes()

◆ enableOOUI()

◆ extensionSubstitution()

◆ extractTagsAndParams()

◆ fetchCurrentRevisionRecordOfTitle()

◆ fetchFileAndTitle()

◆ fetchFileNoRegister()

◆ fetchTemplateAndTitle()

◆ firstCallInit()

◆ formatPageTitle()

◆ getBadFileLookup()

◆ getContentLanguage()

◆ getCustomDefaultSort()

◆ getDefaultSort()

◆ getExternalLinkAttribs()

◆ getExternalLinkRel()

◆ getFlatSectionInfo()

◆ getFreshParser()

◆ getFunctionHooks()

◆ getFunctionLang()

◆ getFunctionSynonyms()

◆ getHookContainer()

◆ getHookRunner()

◆ getLinkRenderer()

◆ getMagicWordFactory()

◆ getOptions()

◆ getOutput()

◆ getOutputType()

◆ getPage()

◆ getPreloadText()

◆ getPreprocessor()

◆ getRevisionId()

◆ getRevisionRecordObject()

◆ getRevisionSize()

◆ getRevisionTimestamp()

◆ getRevisionUser()

◆ getSection()

◆ getStripList()

◆ getStripState()

◆ getTags()

◆ getTargetLanguage()

◆ getTargetLanguageConverter()

◆ getTemplateDom()

◆ getTitle()

◆ getUrlProtocols()

◆ getUserIdentity()

◆ getUserSig()

◆ guessLegacySectionNameFromWikiText()

◆ guessSectionNameFromStrippedText()

◆ guessSectionNameFromWikiText()

◆ incrementExpensiveFunctionCount()

◆ insertStripItem()

◆ internalParse()

◆ interwikiTransclude()

◆ isCurrentRevisionOfTitleCached()

◆ isLocked()

◆ killMarkers()

◆ limitationWarn()

◆ lock()

◆ makeImage()