Manual:Parser.php

Description
This file contains the class  , which contains the method , which converts Wikitext to HTML. It performs, among other things, the following actions:


 * 1) Call helper function , which in turns calls
 * 2)  , which replaces magic variables, templates, and template arguments with the appropriate text.
 * 3) It calls , which preprocesses some wikitext and returns the document tree.
 * 4) Next it creates a  object and calls its  method to do the actual template magic.
 * 5)  , which cleans up HTML, removes dangerous tags and attributes, and removes HTML comments.
 * 6)  , which handles and renders the wikitext for tables.
 * 7)  , which removes valid double-underscore items, like  , and records them in array.
 * 8)  , which parses  and renders section headers.
 * 9)  , which processes internal links  and stores them in   (a object),
 * 10)  , which replaces single quotes with HTML markup (  ,  , etc).
 * 11)  , which replaces and renders external links.
 * 12)  , which replaces special strings like "ISBN xxx" and "RFC xxx" with magic external links.
 * 13)  , which:
 * 14) * auto numbers headings if that options is enabled,
 * 15) * adds an [edit] link to sections for users who have enabled the option and can edit the page,
 * 16) * adds a Table of contents on the top for users who have enabled the option, and
 * 17) * auto-anchors headings.
 * 18) Next,  calls , which renders lists from lines starting with ':', '*', '#', etc.
 * 19)   is called, which calls  on  to replace link placeholders with actual links, in the buffer Placeholders created in Skin::makeLinkObj
 * 20) Next, the text is language converted (when applicable) using the  method of the appropriate Language object.
 * 21)   is called, which replaces transparent tags with values which are provided by the callback functions in  . Transparent tag hooks are like regular XML-style tag hooks, except they operate late in the transformation sequence, on HTML instead of wikitext.
 * 22)   is called, which ensures that any entities and character references are legal for XML and XHTML specifically.
 * 23) If HTML tidy is enabled,  is called to do the tidying.
 * 24) Finally the rendered HTML result of the parse process is stored in the  object , which is returned to the caller of.

How to get a new parser
Since MediaWiki 1.36 you can't construct a Parser class directly. You should use instead, and then call its   method.

The constructor of the ParserFactory takes several arguments. To create a ParserFactory with default options, use.

One-liner for getting a new Parser instance:

Accessors

 * Accessor for $mDefaultSort . Unlike getDefaultSort, it will return false if none is set.
 * Accessor for $mDefaultSort . Will use the empty string if none is set.
 * Get the ParserOptions object.
 * Get the ParserOutput object.
 * Get a preprocessor object.
 * Get the ID of the revision we are parsing.
 * Get the timestamp associated with the current revision, adjusted for the default server-local timestamp.
 * Get the name of the user that edited the last revision.
 * Accessor.
 * Get the target language for the content being parsed.
 * Accessor for the Title object.
 * Get a User object either from $this->mUser, if set, or from the ParserOptions object otherwise.

Set

 * Create a function, e.g. . The callback function should have the form:.
 * Create a tag function, e.g. . Unlike tag hooks, tag functions are parsed at preprocessor level. Unlike parser functions, their content is not preprocessed.
 * Create an HTML-style tag, e.g. . The callback should have the following form: