MediaWiki master
Static Public Member Functions | Public Attributes | List of all members
CoreTagHooks Class Reference
Parser

Various tag hooks, registered in every Parser. More...

Static Public Member Functions

static gallery (?string $content, array $attributes, Parser $parser)
 Core parser tag hook function for 'gallery'.
 
static html (?string $content, array $attributes, Parser $parser)
 Core parser tag hook function for 'html', used only when $wgRawHtml is enabled.
 
static indicator (?string $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.
 
static langconvert (?string $content, array $attributes, Parser $parser, PPFrame $frame)
 Returns content converted into the requested language variant, using LanguageConverter.
 
static nowiki (?string $content, array $attributes, Parser $parser)
 Core parser tag hook function for 'nowiki'.
 
static pre (?string $content, array $attribs, Parser $parser)
 Core parser tag hook function for 'pre'.
 
static register (Parser $parser, ServiceOptions $options)
 

Public Attributes

const REGISTER_OPTIONS
 

Detailed Description

Various tag hooks, registered in every Parser.

Definition at line 35 of file CoreTagHooks.php.

Member Function Documentation

◆ gallery()

static CoreTagHooks::gallery ( ?string $content,
array $attributes,
Parser $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
Access: internal

Definition at line 177 of file CoreTagHooks.php.

◆ html()

static CoreTagHooks::html ( ?string $content,
array $attributes,
Parser $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.

Parameters
?string$content
array$attributes
Parser$parser
Returns
array|string Output of tag hook
Access: internal

Definition at line 108 of file CoreTagHooks.php.

References MediaWiki\Parser\Parser\getOptions(), and MediaWiki\Parser\Parser\msg().

◆ indicator()

static CoreTagHooks::indicator ( ?string $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
Access: internal

Definition at line 193 of file CoreTagHooks.php.

References MediaWiki\Parser\Parser\msg().

◆ langconvert()

static CoreTagHooks::langconvert ( ?string $content,
array $attributes,
Parser $parser,
PPFrame $frame )
static

Returns content converted into the requested language variant, using LanguageConverter.

Parameters
?string$content
array$attributes
Parser$parser
PPFrame$frame
Returns
string
Since
1.36
Access: internal

Definition at line 219 of file CoreTagHooks.php.

References MediaWiki\Parser\Parser\recursiveTagParse().

◆ nowiki()

static CoreTagHooks::nowiki ( ?string $content,
array $attributes,
Parser $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.

Parameters
?string$content
array$attributes
Parser$parser
Returns
array
Access: internal

Definition at line 147 of file CoreTagHooks.php.

◆ pre()

static CoreTagHooks::pre ( ?string $content,
array $attribs,
Parser $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.

Parameters
?string$content
array$attribs
Parser$parser
Returns
string HTML
Access: internal

Definition at line 76 of file CoreTagHooks.php.

◆ register()

static CoreTagHooks::register ( Parser $parser,
ServiceOptions $options )
static
Parameters
Parser$parser
ServiceOptions$options
Returns
void
Access: internal

Definition at line 52 of file CoreTagHooks.php.

References MediaWiki\Parser\Parser\setHook().

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

Member Data Documentation

◆ REGISTER_OPTIONS

const CoreTagHooks::REGISTER_OPTIONS
Initial value:
= [
MainConfigNames::RawHtml,
]
Access: internal

Definition at line 40 of file CoreTagHooks.php.

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

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