CoreTagHooks Class Reference

Various tag hooks, registered in Parser::firstCallInit() More...

Static Public Member Functions
static	gallery ( $content, $attributes, $parser)
	Core parser tag hook function for 'gallery'. More...
static	html ( $content, $attributes, $parser)
	Core parser tag hook function for 'html', used only when $wgRawHtml is enabled. More...
static	indicator ( $content, array $attributes, Parser $parser, PPFrame $frame)
	XML-style tag for page status indicators: icons (or short text snippets) usually displayed in the top-right corner of the page, outside of the main content. More...
static	nowiki ( $content, $attributes, $parser)
	Core parser tag hook function for 'nowiki'. More...
static	pre ( $text, $attribs, $parser)
	Core parser tag hook function for 'pre'. More...
static	register ( $parser)

Detailed Description

Various tag hooks, registered in Parser::firstCallInit()

Definition at line 28 of file CoreTagHooks.php.

Member Function Documentation

gallery()

static CoreTagHooks::gallery (   $content,   $attributes,   $parser  )

static

Core parser tag hook function for 'gallery'.

Renders a thumbnail list of the given images, with optional captions. Full syntax documented on the wiki:

https://www.mediawiki.org/wiki/Help:Images#Gallery_syntax

Todo:

break Parser::renderImageGallery out here too.

Parameters

string	$content
array	$attributes
Parser	$parser

Returns

string HTML

Definition at line 156 of file CoreTagHooks.php.

References $content, and $parser.

html()

static CoreTagHooks::html (   $content,   $attributes,   $parser  )

static

Core parser tag hook function for 'html', used only when $wgRawHtml is enabled.

This is potentially unsafe and should be used only in very careful circumstances, as the contents are emitted as raw HTML.

Uses undocumented extended tag hook return values, introduced in r61913.

@suppress SecurityCheck-XSS

Parameters

string	$content
array	$attributes
Parser	$parser

Exceptions

MWException

Returns

array|string Output of tag hook

Definition at line 89 of file CoreTagHooks.php.

References $content, $parser, $wgRawHtml, and wfMessage().

indicator()

static CoreTagHooks::indicator (   $content, array  $attributes, Parser  $parser, PPFrame  $frame  )

static

XML-style tag for page status indicators: icons (or short text snippets) usually displayed in the top-right corner of the page, outside of the main content.

Parameters

string	$content
array	$attributes
Parser	$parser
PPFrame	$frame

Returns

string

Since

1.25

Definition at line 171 of file CoreTagHooks.php.

References $content, $parser, and wfMessage().

nowiki()

static CoreTagHooks::nowiki (   $content,   $attributes,   $parser  )

static

Core parser tag hook function for 'nowiki'.

Text within this section gets interpreted as a string of text with HTML-compatible character references, and wiki markup within it will not be expanded.

Uses undocumented extended tag hook return values, introduced in r61913.

Uses custom html escaping which phan-taint-check won't recognize hence we suppress the error. @suppress SecurityCheck-XSS

Parameters

string	$content
array	$attributes
Parser	$parser

Returns

array

Definition at line 127 of file CoreTagHooks.php.

References $content.

pre()

static CoreTagHooks::pre (   $text,   $attribs,   $parser  )

static

Core parser tag hook function for 'pre'.

Text is treated roughly as 'nowiki' wrapped in an HTML 'pre' tag; valid HTML attributes are passed on.

Uses custom html escaping which phan-taint-check won't recognize hence we suppress the error. @suppress SecurityCheck-XSS

Parameters

string	$text
array	$attribs
Parser	$parser

Returns

string HTML

Definition at line 58 of file CoreTagHooks.php.

References $attribs, $content, and StringUtils\delimiterReplace().

register()

static CoreTagHooks::register (   $parser )

static

Parameters

Parser

$parser

Returns

void

Definition at line 33 of file CoreTagHooks.php.

References $parser, and $wgRawHtml.

---

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

• includes/parser/CoreTagHooks.php