Manual:Parser.php

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


 * 1) Call helper function Parser::internalParse, which in turns calls
 * 2) Parser::replaceVariables</tt></>, which replaces magic variables, templates, and template arguments with the appropriate text.
 * 3) It calls <tvar|todom>Parser::preprocessToDom</tt></>, which preprocesses some wikitext and returns the document tree.
 * 4) Next it creates a <tvar|dom>PPFrame DOM</tt></> object and calls its <tvar|expand>expand</tt></> method to do the actual template magic.
 * 5) <tvar|sanitizer>Sanitizer::removeHTMLtags</tt></>, which cleans up HTML, removes dangerous tags and attributes, and removes HTML comments.
 * 6) <tvar|stuff>Parser::doTableStuff</tt></>, which handles and renders the wikitext for tables.
 * 7) <tvar|underscore>Parser::doDoubleUnderscore</tt></>, which removes valid switches>Special:MyLanguage/Help:Magic_words#Behavior_switches</>|double-underscore items, like <tvar|notoc>  </>, and records them in array <tvar|underscores> </>.
 * 8) <tvar|headings>Parser::doHeadings</tt></>, which parses  and renders section headers.
 * 9) <tvar|internal>Parser::replaceInternalLinks</tt></>, which processes internal links  and stores them in   (a LinkHolderArray</tt> object),
 * 10) Parser::doAllQuotes</tt>, which replaces single quotes with HTML markup ( <i>, <b>, etc).
 * 11) Parser::replaceExternalLinks</tt>, which replaces and renders external links.
 * 12) Parser::doMagicLinks</tt>, which replaces special strings like "ISBN xxx" and "RFC xxx" with magic external links.
 * 13) Parser::formatHeadings</tt>, 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, parse</tt> calls Parser::doBlockLevels</tt>, which renders lists from lines starting with ':', '*', '#', etc.
 * 19) Parser::replaceLinkHolders</tt> is called, which calls <tt>LinkHolderArray::replace</tt> 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 <tt>convert</tt> method of the appropriate <tt>Language</tt> object.
 * 21) <tt>Parser::replaceTransparentTags</tt> is called, which replaces transparent tags with values which are provided by the callback functions in <tt>$Parser->mTransparentTagHooks</tt>. Transparent tag hooks are like regular XML-style tag hooks, except they operate late in the transformation sequence, on HTML instead of wikitext.
 * 22) <tt>Sanitizer::normalizeCharReferences</tt> is called, which ensures that any entities and character references are legal for XML and XHTML specifically.
 * 23) If HTML tidy is enabled, <tt>MWTidy::tidy</tt> is called to do the tidying.
 * 24) Finally the rendered HTML result of the parse process is stored in the <tt>ParserOutput</tt> object, which is returned to the caller of <tt>Parser::parse</tt>.

Accessors

 * Accessor for $mDefaultSort Unlike getDefaultSort, 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:

External link

 * The MediaWiki parser, uncovered