MediaWiki REL1_30
CoreTagHooks.php
Go to the documentation of this file.
1<?php
28class CoreTagHooks {
33 public static function register( $parser ) {
34 global $wgRawHtml;
35 $parser->setHook( 'pre', [ __CLASS__, 'pre' ] );
36 $parser->setHook( 'nowiki', [ __CLASS__, 'nowiki' ] );
37 $parser->setHook( 'gallery', [ __CLASS__, 'gallery' ] );
38 $parser->setHook( 'indicator', [ __CLASS__, 'indicator' ] );
39 if ( $wgRawHtml ) {
40 $parser->setHook( 'html', [ __CLASS__, 'html' ] );
41 }
42 }
43
54 public static function pre( $text, $attribs, $parser ) {
55 // Backwards-compatibility hack
56 $content = StringUtils::delimiterReplace( '<nowiki>', '</nowiki>', '$1', $text, 'i' );
57
58 $attribs = Sanitizer::validateTagAttributes( $attribs, 'pre' );
59 // We need to let both '"' and '&' through,
60 // for strip markers and entities respectively.
61 $content = str_replace(
62 [ '>', '<' ],
63 [ '&gt;', '&lt;' ],
64 $content
65 );
66 return Html::rawElement( 'pre', $attribs, $content );
67 }
68
84 public static function html( $content, $attributes, $parser ) {
85 global $wgRawHtml;
86 if ( $wgRawHtml ) {
87 if ( $parser->getOptions()->getAllowUnsafeRawHtml() ) {
88 return [ $content, 'markerType' => 'nowiki' ];
89 } else {
90 // In a system message where raw html is
91 // not allowed (but it is allowed in other
92 // contexts).
93 return Html::rawElement(
94 'span',
95 [ 'class' => 'error' ],
96 // Using ->text() not ->parse() as
97 // a paranoia measure against a loop.
98 wfMessage( 'rawhtml-notallowed' )->escaped()
99 );
100 }
101 } else {
102 throw new MWException( '<html> extension tag encountered unexpectedly' );
103 }
104 }
105
118 public static function nowiki( $content, $attributes, $parser ) {
119 $content = strtr( $content, [
120 // lang converter
121 '-{' => '-&#123;',
122 '}-' => '&#125;-',
123 // html tags
124 '<' => '&lt;',
125 '>' => '&gt;'
126 // Note: Both '"' and '&' are not converted.
127 // This allows strip markers and entities through.
128 ] );
129 return [ $content, 'markerType' => 'nowiki' ];
130 }
131
147 public static function gallery( $content, $attributes, $parser ) {
148 return $parser->renderImageGallery( $content, $attributes );
149 }
150
162 public static function indicator( $content, array $attributes, Parser $parser, PPFrame $frame ) {
163 if ( !isset( $attributes['name'] ) || trim( $attributes['name'] ) === '' ) {
164 return '<span class="error">' .
165 wfMessage( 'invalid-indicator-name' )->inContentLanguage()->parse() .
166 '</span>';
167 }
168
169 $parser->getOutput()->setIndicator(
170 trim( $attributes['name'] ),
171 Parser::stripOuterParagraph( $parser->recursiveTagParseFully( $content, $frame ) )
172 );
173
174 return '';
175 }
176}
$wgRawHtml
$wgRawHtml
Allow raw, unchecked HTML in "<html>...</html>" sections.
Definition DefaultSettings.php:4347
CoreTagHooks
Various tag hooks, registered in Parser::firstCallInit()
Definition CoreTagHooks.php:28
CoreTagHooks\pre
static pre( $text, $attribs, $parser)
Core parser tag hook function for 'pre'.
Definition CoreTagHooks.php:54
CoreTagHooks\indicator
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...
Definition CoreTagHooks.php:162
CoreTagHooks\gallery
static gallery( $content, $attributes, $parser)
Core parser tag hook function for 'gallery'.
Definition CoreTagHooks.php:147
CoreTagHooks\nowiki
static nowiki( $content, $attributes, $parser)
Core parser tag hook function for 'nowiki'.
Definition CoreTagHooks.php:118
CoreTagHooks\html
static html( $content, $attributes, $parser)
Core parser tag hook function for 'html', used only when $wgRawHtml is enabled.
Definition CoreTagHooks.php:84
MWException
MediaWiki exception.
Definition MWException.php:26
Parser
PHP Parser - Processes wiki markup (which uses a more user-friendly syntax, such as "[[link]]" for ma...
Definition Parser.php:70
StringUtils\delimiterReplace
static delimiterReplace( $startDelim, $endDelim, $replace, $subject, $flags='')
Perform an operation equivalent to preg_replace() with flags.
Definition StringUtils.php:257
$parser
do that in ParserLimitReportFormat instead $parser
Definition hooks.txt:2572
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
$attribs
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition hooks.txt:1984