Go to the documentation of this file.
53 $services = MediaWikiServices::getInstance();
111 wfWarn( __METHOD__ .
': Requires $target to be a LinkTarget object.', 2 );
112 return "<!-- ERROR -->$html";
115 if ( is_string(
$query ) ) {
117 wfDeprecated( __METHOD__ .
' with parameter $query as string (should be array)',
'1.20' );
121 $services = MediaWikiServices::getInstance();
125 if ( !isset(
$options[
'stubThreshold'] ) ) {
126 $defaultLinkRenderer =
$services->getLinkRenderer();
127 $options[
'stubThreshold'] = $defaultLinkRenderer->getStubThreshold();
130 ->createFromLegacyOptions(
$options );
135 if (
$html !==
null ) {
140 if ( in_array(
'known',
$options,
true ) ) {
142 } elseif ( in_array(
'broken',
$options,
true ) ) {
144 } elseif ( in_array(
'noclasses',
$options,
true ) ) {
187 $ret =
"<a class=\"mw-selflink selflink\">{$prefix}{$html}</a>{$trail}";
193 $html = htmlspecialchars( $nt->getPrefixedText() );
196 return "<a class=\"mw-selflink selflink\">{$prefix}{$html}{$inside}</a>{$trail}";
221 return $context->msg(
'invalidtitle-unknownnamespace', $namespace,
$title )->text();
252 $basename = strrchr( $url,
'/' );
253 if (
false === $basename ) {
256 $basename = substr( $basename, 1 );
278 wfDebug(
"Hook LinkerMakeExternalImage changed the output of external image "
279 .
"with url {$url} and alt text {$alt} to {$img}\n",
true );
326 $query =
"", $widthOption =
null
335 if ( $file && !$file->allowInlineDisplay() ) {
336 wfDebug( __METHOD__ .
': ' .
$title->getPrefixedDBkey() .
" does not allow inline display\n" );
342 if ( !isset( $frameParams[
'align'] ) ) {
343 $frameParams[
'align'] =
'';
345 if ( !isset( $frameParams[
'alt'] ) ) {
346 $frameParams[
'alt'] =
'';
348 if ( !isset( $frameParams[
'title'] ) ) {
349 $frameParams[
'title'] =
'';
351 if ( !isset( $frameParams[
'class'] ) ) {
352 $frameParams[
'class'] =
'';
355 $prefix = $postfix =
'';
357 if (
'center' == $frameParams[
'align'] ) {
358 $prefix =
'<div class="center">';
360 $frameParams[
'align'] =
'none';
363 if ( isset(
$handlerParams[
'height'] ) && $file->isVectorized() ) {
372 if ( isset( $frameParams[
'thumbnail'] )
373 || isset( $frameParams[
'manualthumb'] )
374 || isset( $frameParams[
'framed'] )
375 || isset( $frameParams[
'frameless'] )
380 if ( $widthOption ===
null || !isset(
$wgThumbLimits[$widthOption] ) ) {
385 if ( isset( $frameParams[
'upright'] ) && $frameParams[
'upright'] == 0 ) {
392 $prefWidth = isset( $frameParams[
'upright'] ) ?
393 round(
$wgThumbLimits[$widthOption] * $frameParams[
'upright'], -1 ) :
399 $prefWidth <
$handlerParams[
'width'] || $file->isVectorized() ) ) {
405 if ( isset( $frameParams[
'thumbnail'] ) || isset( $frameParams[
'manualthumb'] )
406 || isset( $frameParams[
'framed'] )
408 # Create a thumbnail. Alignment depends on the writing direction of
409 # the page content language (right-aligned for LTR languages,
410 # left-aligned for RTL languages)
411 # If a thumbnail width has not been provided, it is set
412 # to the default user option as specified in Language*.php
413 if ( $frameParams[
'align'] ==
'' ) {
414 $frameParams[
'align'] =
$parser->getTargetLanguage()->alignEnd();
421 if ( $file && isset( $frameParams[
'frameless'] ) ) {
422 $srcWidth = $file->getWidth( $page );
423 # For "frameless" option: do not present an image bigger than the
424 # source (for bitmap-style images). This is the same behavior as the
425 # "thumb" option does it already.
426 if ( $srcWidth && !$file->mustRender() &&
$handlerParams[
'width'] > $srcWidth ) {
432 # Create a resized image, without the additional thumbnail features
443 'alt' => $frameParams[
'alt'],
444 'title' => $frameParams[
'title'],
445 'valign' => isset( $frameParams[
'valign'] ) ? $frameParams[
'valign'] :
false,
446 'img-class' => $frameParams[
'class'] ];
447 if ( isset( $frameParams[
'border'] ) ) {
448 $params[
'img-class'] .= (
$params[
'img-class'] !==
'' ?
' ' :
'' ) .
'thumbborder';
454 if ( $frameParams[
'align'] !=
'' ) {
455 $s =
"<div class=\"float{$frameParams['align']}\">{$s}</div>";
457 return str_replace(
"\n",
' ', $prefix .
$s . $postfix );
470 if ( isset( $frameParams[
'link-url'] ) && $frameParams[
'link-url'] !==
'' ) {
471 $mtoParams[
'custom-url-link'] = $frameParams[
'link-url'];
472 if ( isset( $frameParams[
'link-target'] ) ) {
473 $mtoParams[
'custom-target-link'] = $frameParams[
'link-target'];
476 $extLinkAttrs =
$parser->getExternalLinkAttribs( $frameParams[
'link-url'] );
477 foreach ( $extLinkAttrs
as $name => $val ) {
479 $mtoParams[
'parser-extlink-' .
$name] = $val;
482 } elseif ( isset( $frameParams[
'link-title'] ) && $frameParams[
'link-title'] !==
'' ) {
484 self::normaliseSpecialPage( $frameParams[
'link-title'] )
486 } elseif ( !empty( $frameParams[
'no-link'] ) ) {
489 $mtoParams[
'desc-link'] =
true;
490 $mtoParams[
'desc-query'] =
$query;
508 $align =
'right',
$params = [], $framed =
false, $manualthumb =
""
516 $frameParams[
'framed'] =
true;
518 if ( $manualthumb ) {
519 $frameParams[
'manualthumb'] = $manualthumb;
536 $exists = $file && $file->exists();
539 if ( !isset( $frameParams[
'align'] ) ) {
540 $frameParams[
'align'] =
'right';
542 if ( !isset( $frameParams[
'alt'] ) ) {
543 $frameParams[
'alt'] =
'';
545 if ( !isset( $frameParams[
'title'] ) ) {
546 $frameParams[
'title'] =
'';
548 if ( !isset( $frameParams[
'caption'] ) ) {
549 $frameParams[
'caption'] =
'';
554 $handlerParams[
'width'] = isset( $frameParams[
'upright'] ) ? 130 : 180;
558 $manualthumb =
false;
563 if ( isset( $frameParams[
'manualthumb'] ) ) {
564 # Use manually specified thumbnail
566 if ( $manual_title ) {
575 } elseif ( isset( $frameParams[
'framed'] ) ) {
580 # Do not present an image bigger than the source, for bitmap-style images
581 # This is a hack to maintain compatibility with arbitrary pre-1.10 behavior
582 $srcWidth = $file->getWidth( $page );
583 if ( $srcWidth && !$file->mustRender() &&
$handlerParams[
'width'] > $srcWidth ) {
590 $outerWidth = $thumb->getWidth() + 2;
596 # ThumbnailImage::toHtml() already adds page= onto the end of DjVu URLs
597 # So we don't need to pass it here in $query. However, the URL for the
598 # zoom icon still needs it, so we make a unique query for it. See T16771
604 && !isset( $frameParams[
'link-title'] )
605 && !isset( $frameParams[
'link-url'] )
606 && !isset( $frameParams[
'no-link'] ) ) {
607 $frameParams[
'link-url'] = $url;
610 $s =
"<div class=\"thumb t{$frameParams['align']}\">"
611 .
"<div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
616 } elseif ( !$thumb ) {
617 $s .=
wfMessage(
'thumbnail_error',
'' )->escaped();
620 if ( !$noscale && !$manualthumb ) {
624 'alt' => $frameParams[
'alt'],
625 'title' => $frameParams[
'title'],
626 'img-class' => ( isset( $frameParams[
'class'] ) && $frameParams[
'class'] !==
''
627 ? $frameParams[
'class'] .
' '
628 :
'' ) .
'thumbimage'
632 if ( isset( $frameParams[
'framed'] ) ) {
638 'class' =>
'internal',
643 $s .=
' <div class="thumbcaption">' . $zoomIcon . $frameParams[
'caption'] .
"</div></div></div>";
644 return str_replace(
"\n",
' ',
$s );
659 $hp15[
'width'] = round( $hp[
'width'] * 1.5 );
661 $hp20[
'width'] = $hp[
'width'] * 2;
662 if ( isset( $hp[
'height'] ) ) {
663 $hp15[
'height'] = round( $hp[
'height'] * 1.5 );
664 $hp20[
'height'] = $hp[
'height'] * 2;
667 $thumb15 = $file->transform( $hp15 );
668 $thumb20 = $file->transform( $hp20 );
669 if ( $thumb15 && !$thumb15->isError() && $thumb15->getUrl() !== $thumb->getUrl() ) {
670 $thumb->responsiveUrls[
'1.5'] = $thumb15->getUrl();
672 if ( $thumb20 && !$thumb20->isError() && $thumb20->getUrl() !== $thumb->getUrl() ) {
673 $thumb->responsiveUrls[
'2'] = $thumb20->getUrl();
691 $query =
'', $unused1 =
'', $unused2 =
'',
$time =
false
694 wfWarn( __METHOD__ .
': Requires $title to be a Title object.' );
695 return "<!-- ERROR -->" . htmlspecialchars( $label );
699 if ( $label ==
'' ) {
700 $label =
$title->getPrefixedText();
702 $encLabel = htmlspecialchars( $label );
716 [
'class' =>
'mw-redirect' ],
718 [
'known',
'noclasses' ]
724 return '<a href="' . htmlspecialchars( $href ) .
'" class="new" title="' .
725 htmlspecialchars(
$title->getPrefixedText(), ENT_QUOTES ) .
'">' .
742 $q =
'wpDestFile=' . $destFile->getPartialURL();
753 return $upload->getLocalURL( $q );
784 if ( $file && $file->exists() ) {
785 $url = $file->getUrl();
806 wfDebug(
"Hook LinkerMakeMediaLinkFile changed the output of link "
807 .
"with url {$url} and text {$html} to {$ret}\n",
true );
826 $key = strtolower(
$name );
849 $class .=
" $linktype";
852 $class .=
" {$attribs['class']}";
857 $text = htmlspecialchars( $text );
863 $newRel = Parser::getExternalLinkRel( $url,
$title );
866 } elseif ( $newRel !==
'' ) {
868 $newRels = explode(
' ', $newRel );
869 $oldRels = explode(
' ',
$attribs[
'rel'] );
870 $combined = array_unique( array_merge( $newRels, $oldRels ) );
871 $attribs[
'rel'] = implode(
' ', $combined );
877 wfDebug(
"Hook LinkerMakeExternalLink changed the output of link "
878 .
"with url {$url} and text {$text} to {$link}\n",
true );
893 public static function userLink( $userId, $userName, $altUserName =
false ) {
894 $classes =
'mw-userlink';
895 if ( $userId == 0 ) {
897 if ( $altUserName ===
false ) {
900 $classes .=
' mw-anonuserlink';
908 '<bdi>' . htmlspecialchars( $altUserName !==
false ? $altUserName : $userName ) .
'</bdi>',
909 [
'class' => $classes ]
927 $userId, $userText, $redContribsWhenNoEdits =
false,
$flags = 0, $edits =
null
932 $addEmailLink =
$flags & self::TOOL_LINKS_EMAIL && $userId;
941 $attribs[
'class'] =
'mw-usertoollinks-contribs';
942 if ( $redContribsWhenNoEdits ) {
943 if ( intval( $edits ) === 0 && $edits !== 0 ) {
945 $edits =
$user->getEditCount();
947 if ( $edits === 0 ) {
955 if ( $blockable &&
$wgUser->isAllowed(
'block' ) ) {
959 if ( $addEmailLink &&
$wgUser->canSendEmail() ) {
963 Hooks::run(
'UserToolLinksEdit', [ $userId, $userText, &$items ] );
966 return wfMessage(
'word-separator' )->escaped()
967 .
'<span class="mw-usertoollinks">'
968 .
wfMessage(
'parentheses' )->rawParams(
$wgLang->pipeList( $items ) )->escaped()
995 $moreLinkAttribs[
'class'] =
'mw-usertoollinks-talk';
997 wfMessage(
'talkpagelinktext' )->escaped(),
999 return $userTalkLink;
1010 $moreLinkAttribs[
'class'] =
'mw-usertoollinks-block';
1024 $moreLinkAttribs[
'class'] =
'mw-usertoollinks-mail';
1048 return '<span class="history-deleted">' .
$link .
'</span>';
1072 return ' <span class="history-deleted">' .
$link .
'</span>';
1100 $comment,
$title =
null, $local =
false, $wikiId =
null
1102 # Sanitize text a bit:
1103 $comment = str_replace(
"\n",
" ", $comment );
1104 # Allow HTML entities (for T15815)
1105 $comment = Sanitizer::escapeHtmlAllowEntities( $comment );
1107 # Render autocomments and make links:
1132 $comment,
$title =
null, $local =
false, $wikiId =
null
1140 $comment = preg_replace_callback(
1146 '!(?:(?<=(.)))?/\*\s*(.*?)\s*\*/(?:(?=(.)))?!',
1147 function ( $match )
use (
$title, $local, $wikiId, &$append ) {
1151 $match += [
'',
'',
'',
'' ];
1153 $pre = $match[1] !==
'';
1155 $post = $match[3] !==
'';
1159 'FormatAutocomments',
1163 if ( $comment ===
null ) {
1167 # Remove links that a user may have manually put in the autosummary
1168 # This could be improved by copying as much of Parser::stripSectionName as desired.
1178 $title->getDBkey(), Sanitizer::decodeCharReferences(
$section ) );
1180 if ( $sectionTitle ) {
1187 # written summary $presep autocomment (summary )
1188 $pre =
wfMessage(
'autocomment-prefix' )->inContentLanguage()->escaped();
1191 # autocomment $postsep written summary ( summary)
1192 $auto .=
wfMessage(
'colon-separator' )->inContentLanguage()->escaped();
1194 $auto =
'<span class="autocomment">' .
$auto .
'</span>';
1196 .
'<span dir="auto">' .
$auto;
1197 $append .=
'</span>';
1203 return $comment . $append;
1225 $comment,
$title =
null, $local =
false, $wikiId =
null
1227 return preg_replace_callback(
1230 :? # ignore optional leading colon
1231 ([^\]|]+) # 1. link target; page names cannot include ] or |
1234 # Stop matching at ]] without relying on backtracking.
1238 ([^[]*) # 3. link trail (the text up until the next link)
1240 function ( $match )
use (
$title, $local, $wikiId ) {
1246 $comment = $match[0];
1248 # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
1249 if ( strpos( $match[1],
'%' ) !==
false ) {
1251 rawurldecode( $match[1] ),
1252 [
'<' =>
'<',
'>' =>
'>' ]
1256 # Handle link renaming [[foo|text]] will show link as "text"
1257 if ( $match[2] !=
"" ) {
1264 if ( preg_match(
'/^' . $medians .
'(.*)$/i', $match[1], $submatch ) ) {
1265 # Media link; trail not supported.
1266 $linkRegexp =
'/\[\[(.*?)\]\]/';
1272 # Other kind of link
1273 # Make sure its target is non-empty
1274 if ( isset( $match[1][0] ) && $match[1][0] ==
':' ) {
1275 $match[1] = substr( $match[1], 1 );
1277 if ( $match[1] !==
false && $match[1] !==
'' ) {
1278 if ( preg_match(
$wgContLang->linkTrail(), $match[3], $submatch ) ) {
1279 $trail = $submatch[1];
1283 $linkRegexp =
'/\[\[(.*?)\]\]' . preg_quote( $trail,
'/' ) .
'/';
1291 if ( $target->getText() ==
'' && !$target->isExternal()
1294 $target =
$title->createFragmentTarget( $target->getFragment() );
1303 $comment = preg_replace(
1333 if ( $wikiId !==
null && !$linkTarget->
isExternal() ) {
1362 # :Foobar -- override special treatment of prefix (images, language links)
1363 # /Foobar -- convert to CurrentPage/Foobar
1364 # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial and final / from text
1365 # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
1366 # ../Foobar -- convert to CurrentPage/Foobar,
1367 # (from CurrentPage/CurrentSubPage)
1368 # ../Foobar/ -- convert to CurrentPage/Foobar, use 'Foobar' as text
1369 # (from CurrentPage/CurrentSubPage)
1373 # Some namespaces don't allow subpages,
1374 # so only perform processing if subpages are allowed
1376 $hash = strpos( $target,
'#' );
1377 if ( $hash !==
false ) {
1378 $suffix = substr( $target, $hash );
1379 $target = substr( $target, 0, $hash );
1384 $target = trim( $target );
1385 # Look at the first character
1386 if ( $target !=
'' && $target[0] ===
'/' ) {
1387 # / at end means we don't want the slash to be shown
1389 $trailingSlashes = preg_match_all(
'%(/+)$%', $target, $m );
1390 if ( $trailingSlashes ) {
1391 $noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
1393 $noslash = substr( $target, 1 );
1396 $ret = $contextTitle->getPrefixedText() .
'/' . trim( $noslash ) . $suffix;
1397 if ( $text ===
'' ) {
1398 $text = $target . $suffix;
1399 } #
this might be changed
for ugliness
reasons
1401 # check for .. subpage backlinks
1403 $nodotdot = $target;
1404 while ( strncmp( $nodotdot,
"../", 3 ) == 0 ) {
1406 $nodotdot = substr( $nodotdot, 3 );
1408 if ( $dotdotcount > 0 ) {
1409 $exploded = explode(
'/', $contextTitle->getPrefixedText() );
1410 if (
count( $exploded ) > $dotdotcount ) { #
not allowed to go
below top level
page
1411 $ret = implode(
'/', array_slice( $exploded, 0, -$dotdotcount ) );
1412 # / at the end means don't show full path
1413 if ( substr( $nodotdot, -1, 1 ) ===
'/' ) {
1414 $nodotdot = rtrim( $nodotdot,
'/' );
1415 if ( $text ===
'' ) {
1416 $text = $nodotdot . $suffix;
1419 $nodotdot = trim( $nodotdot );
1420 if ( $nodotdot !=
'' ) {
1421 $ret .=
'/' . $nodotdot;
1446 $comment,
$title =
null, $local =
false, $wikiId =
null
1451 if ( $comment ==
'' || $comment ==
'*' ) {
1455 $formatted =
wfMessage(
'parentheses' )->rawParams( $formatted )->escaped();
1456 return " <span class=\"comment\">$formatted</span>";
1475 $block =
" <span class=\"comment\">" .
wfMessage(
'rev-deleted-comment' )->escaped() .
"</span>";
1478 $rev->getTitle(), $local );
1480 $block =
" <span class=\"comment\">" .
wfMessage(
'rev-deleted-comment' )->escaped() .
"</span>";
1483 return " <span class=\"history-deleted\">$block</span>";
1495 $stxt =
wfMessage(
'historyempty' )->escaped();
1497 $stxt =
wfMessage(
'nbytes' )->numParams( $size )->escaped();
1498 $stxt =
wfMessage(
'parentheses' )->rawParams( $stxt )->escaped();
1500 return "<span class=\"history-size\">$stxt</span>";
1521 return "</li>\n" . str_repeat(
"</ul>\n</li>\n", $level > 0 ? $level : 0 );
1535 public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex =
false ) {
1536 $classes =
"toclevel-$level";
1537 if ( $sectionIndex !==
false ) {
1538 $classes .=
" tocsection-$sectionIndex";
1545 [
'href' =>
"#$anchor" ],
1546 Html::element(
'span', [
'class' =>
'tocnumber' ], $tocnumber )
1575 return '<div id="toc" class="toc">'
1576 .
'<div class="toctitle"><h2>' .
$title .
"</h2></div>\n"
1578 .
"</ul>\n</div>\n";
1593 if (
$section[
'toclevel'] > $lastLevel ) {
1595 } elseif (
$section[
'toclevel'] < $lastLevel ) {
1597 $lastLevel -
$section[
'toclevel'] );
1628 $link, $fallbackAnchor =
false
1630 $anchorEscaped = htmlspecialchars( $anchor );
1632 if ( $fallbackAnchor !==
false && $fallbackAnchor !== $anchor ) {
1633 $fallbackAnchor = htmlspecialchars( $fallbackAnchor );
1634 $fallback =
"<span id=\"$fallbackAnchor\"></span>";
1636 $ret =
"<h$level$attribs"
1637 .
"$fallback<span class=\"mw-headline\" id=\"$anchorEscaped\">$html</span>"
1654 if ( $trail !==
'' ) {
1656 if ( preg_match( $regex, $trail, $m ) ) {
1661 return [ $inside, $trail ];
1699 if ( in_array(
'verify',
$options,
true ) ) {
1701 if ( $editCount ===
false ) {
1708 if ( !in_array(
'noBrackets',
$options,
true ) ) {
1709 $inner =
$context->msg(
'brackets' )->rawParams( $inner )->escaped();
1712 return '<span class="mw-rollback-link">' . $inner .
'</span>';
1742 [
'rev_user_text',
'rev_deleted' ],
1744 [
'rev_page' =>
$rev->getTitle()->getArticleID() ],
1747 'USE INDEX' => [
'revision' =>
'page_timestamp' ],
1748 'ORDER BY' =>
'rev_timestamp DESC',
1755 foreach (
$res as $row ) {
1796 $disableRollbackEditCountSpecialPage = [
'Recentchanges',
'Watchlist' ];
1804 'action' =>
'rollback',
1805 'from' =>
$rev->getUserText(),
1806 'token' =>
$context->getUser()->getEditToken(
'rollback' ),
1809 'data-mw' =>
'interface',
1810 'title' =>
$context->msg(
'tooltip-rollback' )->text(),
1812 $options = [
'known',
'noclasses' ];
1814 if (
$context->getRequest()->getBool(
'bot' ) ) {
1816 $query[
'hidediff'] =
'1';
1819 $disableRollbackEditCount =
false;
1821 foreach ( $disableRollbackEditCountSpecialPage
as $specialPage ) {
1823 $disableRollbackEditCount =
true;
1829 if ( !$disableRollbackEditCount
1833 if ( !is_numeric( $editCount ) ) {
1841 $html =
$context->msg(
'rollbacklinkcount' )->numParams( $editCount )->parse();
1881 if ( $more instanceof Message ) {
1882 $more = $more->toString();
1887 MediaWikiServices::getInstance()->getLinkRenderer()
1889 return $formatter->format( $templates,
$type, $more );
1902 if (
count( $hiddencats ) > 0 ) {
1903 # Construct the HTML
1904 $outText =
'<div class="mw-hiddenCategoriesExplanation">';
1905 $outText .=
wfMessage(
'hiddencategories' )->numParams(
count( $hiddencats ) )->parseAsBlock();
1906 $outText .=
"</div><ul>\n";
1908 foreach ( $hiddencats
as $titleObj ) {
1909 # If it's hidden, it must exist - no need to check with a LinkBatch
1911 .
self::link( $titleObj,
null, [], [],
'known' )
1914 $outText .=
'</ul>';
1933 return htmlspecialchars(
$wgLang->formatSize( $size ) );
1952 $message =
wfMessage(
"tooltip-$name", $msgParams );
1953 if ( !$message->exists() ) {
1956 $tooltip = $message->text();
1957 # Compatibility: formerly some tooltips had [alt-.] hardcoded
1958 $tooltip = preg_replace(
"/ ?\[alt-.\]$/",
'', $tooltip );
1959 # Message equal to '-' means suppress it.
1960 if ( $tooltip ==
'-' ) {
1967 if ( $accesskey !==
false ) {
1969 if ( $tooltip ===
false || $tooltip ===
'' ) {
1970 $tooltip =
wfMessage(
'brackets', $accesskey )->text();
1972 $tooltip .=
wfMessage(
'word-separator' )->text();
1973 $tooltip .=
wfMessage(
'brackets', $accesskey )->text();
1995 if ( isset( self::$accesskeycache[
$name] ) ) {
1996 return self::$accesskeycache[
$name];
1999 $message =
wfMessage(
"accesskey-$name" );
2001 if ( !$message->exists() ) {
2004 $accesskey = $message->plain();
2005 if ( $accesskey ===
'' || $accesskey ===
'-' ) {
2006 # @todo FIXME: Per standard MW behavior, a value of '-' means to suppress the
2007 # attribute, but this is broken for accesskey: that might be a useful
2013 self::$accesskeycache[
$name] = $accesskey;
2014 return self::$accesskeycache[
$name];
2031 $canHide =
$user->isAllowed(
'deleterevision' );
2032 if ( !$canHide && !(
$rev->getVisibility() &&
$user->isAllowed(
'deletedhistory' ) ) ) {
2039 if (
$rev->getId() ) {
2043 'type' =>
'revision',
2044 'target' =>
$title->getPrefixedDBkey(),
2045 'ids' =>
$rev->getId()
2051 'type' =>
'archive',
2052 'target' =>
$title->getPrefixedDBkey(),
2053 'ids' =>
$rev->getTimestamp()
2073 $msgKey = $delete ?
'rev-delundel' :
'rev-showdeleted';
2075 $tag = $restricted ?
'strong' :
'span';
2079 [
'class' =>
'mw-revdelundel-link' ],
2094 $msgKey = $delete ?
'rev-delundel' :
'rev-showdeleted';
2096 $htmlParentheses =
wfMessage(
'parentheses' )->rawParams(
$html )->escaped();
2097 return Xml::tags(
'span', [
'class' =>
'mw-revdelundel-link' ], $htmlParentheses );
2116 if (
$attribs[
'title'] ===
false ) {
2119 if (
$attribs[
'accesskey'] ===
false ) {
2134 if ( $tooltip ===
false ) {
static getDefaultOption( $opt)
Get a given default option value.
static getImageLinkMTOParams( $frameParams, $query='', $parser=null)
Get the link parameters for MediaTransformOutput::toHtml() from given frame parameters supplied by th...
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
static newFromId( $id)
Static factory method for creation from a given user ID.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Marks HTML that shouldn't be escaped.
$wgThumbLimits
Adjust thumbnails on image pages according to a user setting.
static formatLinksInComment( $comment, $title=null, $local=false, $wikiId=null)
Formats wiki links and media links in text; all other wiki formatting is ignored.
Some internal bits split of from Skin.php.
const TOOL_LINKS_NOBLOCK
Flags for userToolLinks()
static userTalkLink( $userId, $userText)
static singleton()
Get a RepoGroup instance.
static expandAttributes( $attribs)
Given an array of ('attributename' => 'value'), it generates the code to set the XML attributes : att...
processing should stop and the error should be shown to the user * false
static userToolLinksRedContribs( $userId, $userText, $edits=null)
Alias for userToolLinks( $userId, $userText, true );.
static emailLink( $userId, $userText)
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
$wgResponsiveImages
Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
static revUserLink( $rev, $isPublic=false)
Generate a user link if the current user is allowed to view it.
static tags( $element, $attribs=null, $contents)
Same as Xml::element(), but does not escape contents.
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for except in special pages derived from QueryPage It s a common pitfall for new developers to submit code containing SQL queries which examine huge numbers of rows Remember that COUNT * is(N), counting rows in atable is like counting beans in a bucket.------------------------------------------------------------------------ Replication------------------------------------------------------------------------The largest installation of MediaWiki, Wikimedia, uses a large set ofslave MySQL servers replicating writes made to a master MySQL server. Itis important to understand the issues associated with this setup if youwant to write code destined for Wikipedia.It 's often the case that the best algorithm to use for a given taskdepends on whether or not replication is in use. Due to our unabashedWikipedia-centrism, we often just use the replication-friendly version, but if you like, you can use wfGetLB() ->getServerCount() > 1 tocheck to see if replication is in use.===Lag===Lag primarily occurs when large write queries are sent to the master.Writes on the master are executed in parallel, but they are executed inserial when they are replicated to the slaves. The master writes thequery to the binlog when the transaction is committed. The slaves pollthe binlog and start executing the query as soon as it appears. They canservice reads while they are performing a write query, but will not readanything more from the binlog and thus will perform no more writes. Thismeans that if the write query runs for a long time, the slaves will lagbehind the master for the time it takes for the write query to complete.Lag can be exacerbated by high read load. MediaWiki 's load balancer willstop sending reads to a slave when it is lagged by more than 30 seconds.If the load ratios are set incorrectly, or if there is too much loadgenerally, this may lead to a slave permanently hovering around 30seconds lag.If all slaves are lagged by more than 30 seconds, MediaWiki will stopwriting to the database. All edits and other write operations will berefused, with an error returned to the user. This gives the slaves achance to catch up. Before we had this mechanism, the slaves wouldregularly lag by several minutes, making review of recent editsdifficult.In addition to this, MediaWiki attempts to ensure that the user seesevents occurring on the wiki in chronological order. A few seconds of lagcan be tolerated, as long as the user sees a consistent picture fromsubsequent requests. This is done by saving the master binlog positionin the session, and then at the start of each request, waiting for theslave to catch up to that position before doing any reads from it. Ifthis wait times out, reads are allowed anyway, but the request isconsidered to be in "lagged slave mode". Lagged slave mode can bechecked by calling wfGetLB() ->getLaggedSlaveMode(). The onlypractical consequence at present is a warning displayed in the pagefooter.===Lag avoidance===To avoid excessive lag, queries which write large numbers of rows shouldbe split up, generally to write one row at a time. Multi-row INSERT ...SELECT queries are the worst offenders should be avoided altogether.Instead do the select first and then the insert.===Working with lag===Despite our best efforts, it 's not practical to guarantee a low-lagenvironment. Lag will usually be less than one second, but mayoccasionally be up to 30 seconds. For scalability, it 's very importantto keep load on the master low, so simply sending all your queries tothe master is not the answer. So when you have a genuine need forup-to-date data, the following approach is advised:1) Do a quick query to the master for a sequence number or timestamp 2) Run the full query on the slave and check if it matches the data you gotfrom the master 3) If it doesn 't, run the full query on the masterTo avoid swamping the master every time the slaves lag, use of thisapproach should be kept to a minimum. In most cases you should just readfrom the slave and let the user deal with the delay.------------------------------------------------------------------------ Lock contention------------------------------------------------------------------------Due to the high write rate on Wikipedia(and some other wikis), MediaWiki developers need to be very careful to structure their writesto avoid long-lasting locks. By default, MediaWiki opens a transactionat the first query, and commits it before the output is sent. Locks willbe held from the time when the query is done until the commit. So youcan reduce lock time by doing as much processing as possible before youdo your write queries.Often this approach is not good enough, and it becomes necessary toenclose small groups of queries in their own transaction. Use thefollowing syntax:$dbw=wfGetDB(DB_MASTER
if(!isset( $args[0])) $lang
static makeSelfLinkObj( $nt, $html='', $query='', $trail='', $prefix='')
Make appropriate markup for a link to the current article.
static generateTOC( $tree, $lang=false)
Generate a table of contents from a section tree.
static getUploadUrl( $destFile, $query='')
Get the URL to upload a certain file.
static tocIndent()
Add another level to the Table of Contents.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped $pre
$wgSVGMaxSize
Don't scale a SVG larger than this.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could change
static getLinkColour(LinkTarget $t, $threshold)
Return the CSS colour of a known link.
static getForeignURL( $wikiID, $page, $fragmentId=null)
Convenience to get a url to a page on a foreign wiki.
static fnamePart( $url)
Returns the filename part of an url.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
static specialLink( $name, $key='')
Make a link to a special page given its name and, optionally, a message key from the link text.
static escapeRegexReplacement( $string)
Escape a string to make it suitable for inclusion in a preg_replace() replacement parameter.
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
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 after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
static processResponsiveImages( $file, $thumb, $hp)
Process responsive images: add 1.5x and 2x subimages to the thumbnail, where applicable.
Allows to change the fields on the form that will be generated $name
if(! $wgRequest->checkUrlExtension()) if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') if(! $wgEnableAPI) $wgTitle
static getInvalidTitleDescription(IContextSource $context, $namespace, $title)
Get a message saying that an invalid title was encountered.
static tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex=false)
parameter level defines if we are on an indentation level
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
static formatHiddenCategories( $hiddencats)
Returns HTML for the "hidden categories on this page" list.
controlled by $wgMainCacheType controlled by $wgParserCacheType controlled by $wgMessageCacheType If you set CACHE_NONE to one of the three control default value for MediaWiki still create a but requests to it are no ops and we always fall through to the database If the cache daemon can t be it should also disable itself fairly smoothly By $wgMemc is used but when it is $parserMemc or $messageMemc this is mentioned below
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
null means default & $customAttribs
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
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 & $html
namespace and then decline to actually register it file or subcat img or subcat $title
static makeMediaLinkObj( $title, $html='', $time=false)
Create a direct link to a given uploaded file.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
static generateRollback( $rev, IContextSource $context=null, $options=[ 'verify'])
Generate a rollback link for a given revision.
static makeThumbLink2(Title $title, $file, $frameParams=[], $handlerParams=[], $time=false, $query="")
static getTitleValueFor( $name, $subpage=false, $fragment='')
Get a localised TitleValue object for a specified special page name.
static newFromLinkTarget(LinkTarget $linkTarget)
Create a new Title from a LinkTarget.
static formatAutocomments( $comment, $title=null, $local=false, $wikiId=null)
Converts autogenerated comments in edit summaries into section links.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database etc For and for historical reasons
static revUserTools( $rev, $isPublic=false)
Generate a user tool link cluster if the current user is allowed to view it.
static tocList( $toc, $lang=false)
Wraps the TOC in a table and provides the hide/collapse javascript.
static getRollbackEditCount( $rev, $verify)
This function will return the number of revisions which a rollback would revert and,...
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
static makeHeadline( $level, $attribs, $anchor, $html, $link, $fallbackAnchor=false)
Create a headline for content.
static tocLineEnd()
End a Table Of Contents line.
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
static hasSubpages( $index)
Does the namespace allow subpages?
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
static revDeleteLinkDisabled( $delete=true)
Creates a dead (show/hide) link for deleting revisions/log entries.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
do that in ParserLimitReportFormat instead $parser
static makeExternalLink( $url, $text, $escape=true, $linktype='', $attribs=[], $title=null)
Make an external link.
see documentation in includes Linker php for Linker::makeImageLink & $time
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
when a variable name is used in a it is silently declared as a new masking the global
static makeCommentLink(LinkTarget $linkTarget, $text, $wikiId=null, $options=[])
Generates a link to the given Title.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped true if there is text before this autocomment $auto
static splitTrail( $trail)
Split a link trail, return the "inside" portion and the remainder of the trail as a two-element array...
static prettifyIP( $ip)
Prettify an IP for display to end users.
$wgShowRollbackEditCount
The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
static revComment(Revision $rev, $local=false, $isPublic=false)
Wrap and format the given revision's comment block, if the current user is allowed to view it.
static blockLink( $userId, $userText)
static normaliseSpecialPage(LinkTarget $target)
Handles formatting for the "templates used on this page" lists.
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null)
Generate standard user tool links (talk, contributions, block link, etc.)
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[])
Returns the attributes for the tooltip and access key.
static getRevDeleteLink(User $user, Revision $rev, Title $title)
Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the setti...
static formatSize( $size)
static link( $target, $html=null, $customAttribs=[], $query=[], $options=[])
This function returns an HTML link to the given target.
static formatRevisionSize( $size)
static resolveAlias( $alias)
Given a special page name with a possible subpage, return an array where the first element is the spe...
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 & $ret
static makeImageLink(Parser $parser, Title $title, $file, $frameParams=[], $handlerParams=[], $time=false, $query="", $widthOption=null)
Given parameters derived from [[Image:Foo|options...]], generate the HTML that that syntax inserts in...
static formatTemplates( $templates, $preview=false, $section=false, $more=null)
static exists( $index)
Returns whether the specified namespace exists.
static getMain()
Static methods.
$wgUploadNavigationUrl
Point the upload navigation link to an external URL Useful if you want to use a shared repository by ...
static titleAttrib( $name, $options=null, array $msgParams=[])
Given the id of an interface element, constructs the appropriate title attribute from the system mess...
wfFindFile( $title, $options=[])
Find a file.
Interface for objects which can provide a MediaWiki context on request.
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
see documentation in includes Linker php for Linker::makeImageLink & $handlerParams
static tooltip( $name, $options=null)
Returns raw bits of HTML, use titleAttrib()
Represents a title within MediaWiki.
$wgMiserMode
Disable database-intensive features.
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 & $options
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
$wgThumbUpright
Adjust width of upright images when parameter 'upright' is used This allows a nicer look for upright ...
static tocUnindent( $level)
Finish one or more sublevels on the Table of Contents.
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
static makeMediaLinkFile(Title $title, $file, $html='')
Create a direct link to a given uploaded file.
static revDeleteLink( $query=[], $restricted=false, $delete=true)
Creates a (show/hide) link for deleting revisions/log entries.
$wgEnableUploads
Uploads have to be specially set up to be secure.
static commentBlock( $comment, $title=null, $local=false, $wikiId=null)
Wrap a comment in standard punctuation and formatting if it's non-empty, otherwise return empty strin...
usually copyright or history_copyright This message must be in HTML not wikitext & $link
static normalizeSubpageLink( $contextTitle, $target, &$text)
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 "<
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
$wgUploadMissingFileUrl
Point the upload link for missing files to an external URL, as with $wgUploadNavigationUrl.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
static accesskey( $name)
Given the id of an interface element, constructs the appropriate accesskey attribute from the system ...
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
static makeThumbLinkObj(Title $title, $file, $label='', $alt, $align='right', $params=[], $framed=false, $manualthumb="")
Make HTML for a thumbnail including image, border and caption.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
static buildRollbackLink( $rev, IContextSource $context=null, $editCount=false)
Build a raw rollback link, useful for collections of "tool" links.
static makeExternalImage( $url, $alt='')
Return the code for images which were added via external links, via Parser::maybeMakeExternalImage().
static getCanonicalName( $index)
Returns the canonical (English) name for a given index.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
static makeBrokenImageLinkObj( $title, $label='', $query='', $unused1='', $unused2='', $time=false)
Make a "broken" link to an image.
$wgDisableAnonTalk
Disable links to talk pages of anonymous users (IPs) in listings on special pages like page history,...
the array() calling protocol came about after MediaWiki 1.4rc1.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang