Go to the documentation of this file.
65 foreach ( self::getSkinNames()
as $skinKey => $skinName ) {
84 unset( $allowedSkins[$skip] );
105 $skinNames = array_change_key_case( $skinNames, CASE_LOWER );
106 $key = strtolower( $key );
110 if ( $key ==
'' || $key ==
'default' ) {
116 if ( isset( $skinNames[$key] ) ) {
131 if ( isset( $skinNames[$key] ) ) {
133 } elseif ( isset( $skinNames[$defaultSkin] ) ) {
136 return $fallbackSkin;
185 'mediawiki.page.startup',
190 'mediawiki.page.ready',
201 if ( $config->get(
'ResponsiveImages' ) ) {
202 $modules[
'core'][] =
'mediawiki.hidpi';
206 if ( strpos(
$out->getHTML(),
'sortable' ) !==
false ) {
207 $modules[
'content'][] =
'jquery.tablesorter';
211 if ( strpos(
$out->getHTML(),
'mw-collapsible' ) !==
false ) {
212 $modules[
'content'][] =
'jquery.makeCollapsible';
215 if (
$out->isTOCEnabled() ) {
216 $modules[
'content'][] =
'mediawiki.toc';
222 &&
$user->isAllowedAll(
'writeapi',
'viewmywatchlist',
'editmywatchlist' )
225 $modules[
'watch'][] =
'mediawiki.page.watch.ajax';
228 $modules[
'search'][] =
'mediawiki.searchSuggest';
231 if (
$user->getBoolOption(
'editsectiononrightclick' ) ) {
232 $modules[
'user'][] =
'mediawiki.action.view.rightClickEdit';
236 if (
$out->isArticle() &&
$user->getOption(
'editondblclick' ) ) {
237 $modules[
'user'][] =
'mediawiki.action.view.dblClickEdit';
250 if (
$user->isLoggedIn() ) {
257 if (
$title->canExist() ) {
258 if (
$title->isTalkPage() ) {
280 $lb->setCaller( __METHOD__ );
291 return $this->
getOutput()->getRevisionId();
301 return $revID == 0 || $revID == $this->
getTitle()->getLatestRevID();
310 $this->mRelevantTitle =
$t;
324 if ( isset( $this->mRelevantTitle ) ) {
336 $this->mRelevantUser = $u;
348 if ( isset( $this->mRelevantUser ) ) {
353 $rootUser =
$title->getRootText();
360 $user->load( User::READ_NORMAL );
362 if (
$user->isLoggedIn() ) {
363 $this->mRelevantUser =
$user;
384 return ResourceLoader::makeInlineScript(
385 ResourceLoader::makeConfigSetScript( $data )
403 'usemsgcache' =>
'yes',
404 'ctype' =>
'text/css',
425 $numeric =
'ns-' .
$title->getNamespace();
427 if (
$title->isSpecialPage() ) {
428 $type =
'ns-special';
431 if ( $canonicalName ) {
432 $type .=
' ' . Sanitizer::escapeClass(
"mw-special-$canonicalName" );
434 $type .=
' mw-invalidspecialpage';
436 } elseif (
$title->isTalkPage() ) {
439 $type =
'ns-subject';
442 $name = Sanitizer::escapeClass(
'page-' .
$title->getPrefixedText() );
443 $root = Sanitizer::escapeClass(
'rootpage-' .
$title->getRootTitle()->getPrefixedText() );
445 return "$numeric $type $name $root";
455 'lang' =>
$lang->getHtmlCode(),
456 'dir' =>
$lang->getDir(),
457 'class' =>
'client-nojs',
497 $allCats =
$out->getCategoryLinks();
499 if ( !
count( $allCats ) ) {
507 $colon = $this->
msg(
'colon-separator' )->escaped();
509 if ( !empty( $allCats[
'normal'] ) ) {
510 $t = $embed . implode(
"{$pop}{$embed}", $allCats[
'normal'] ) . $pop;
512 $msg = $this->
msg(
'pagecategories' )->numParams(
count( $allCats[
'normal'] ) )->escaped();
513 $linkPage =
wfMessage(
'pagecategorieslink' )->inContentLanguage()->text();
516 $s .=
'<div id="mw-normal-catlinks" class="mw-normal-catlinks">' .
517 $link . $colon .
'<ul>' .
$t .
'</ul>' .
'</div>';
521 if ( isset( $allCats[
'hidden'] ) ) {
522 if ( $this->
getUser()->getBoolOption(
'showhiddencats' ) ) {
523 $class =
' mw-hidden-cats-user-shown';
525 $class =
' mw-hidden-cats-ns-shown';
527 $class =
' mw-hidden-cats-hidden';
530 $s .=
"<div id=\"mw-hidden-catlinks\" class=\"mw-hidden-catlinks$class\">" .
531 $this->
msg(
'hidden-categories' )->numParams(
count( $allCats[
'hidden'] ) )->escaped() .
532 $colon .
'<ul>' . $embed . implode(
"{$pop}{$embed}", $allCats[
'hidden'] ) . $pop .
'</ul>' .
536 # optional 'dmoz-like' category browser. Will be shown under the list
537 # of categories an article belong to
539 $s .=
'<br /><hr />';
541 # get a big array of the parents tree
542 $parenttree = $this->
getTitle()->getParentCategoryTree();
543 # Skin object passed by reference cause it can not be
544 # accessed under the method subfunction drawCategoryBrowser
546 # Clean out bogus first entry and sort them
547 unset( $tempout[0] );
549 # Output one per line
550 $s .= implode(
"<br />\n", $tempout );
564 foreach ( $tree
as $element => $parent ) {
565 if ( empty( $parent ) ) {
566 # element start a new list
569 # grab the others elements
573 # add our current element to the list
575 $return .=
Linker::link( $eltitle, htmlspecialchars( $eltitle->getText() ) );
589 $allCats =
$out->getCategoryLinks();
590 $showHidden = $this->
getUser()->getBoolOption(
'showhiddencats' ) ||
593 $classes = [
'catlinks' ];
594 if ( empty( $allCats[
'normal'] ) && !( !empty( $allCats[
'hidden'] ) && $showHidden ) ) {
595 $classes[] =
'catlinks-allhidden';
600 [
'id' =>
'catlinks',
'class' => $classes,
'data-mw' =>
'interface' ],
622 if (
Hooks::run(
'SkinAfterContent', [ &$data, $this ] ) ) {
625 if ( trim( $data ) !=
'' ) {
629 $data =
"<div id='mw-data-after-content'>\n" .
634 wfDebug(
"Hook SkinAfterContent changed output processing.\n" );
658 $bottomScriptText = $this->
getOutput()->getBottomScripts();
659 Hooks::run(
'SkinAfterBottomScripts', [ $this, &$bottomScriptText ] );
661 return $bottomScriptText;
673 $canonicalUrl = $this->
getTitle()->getCanonicalURL(
'oldid=' . $oldid );
674 $url = htmlspecialchars(
wfExpandIRI( $canonicalUrl ) );
680 return $this->
msg(
'retrievedfrom' )
681 ->rawParams(
'<a dir="ltr" href="' . $url .
'">' . $url .
'</a>' )
689 $action = $this->
getRequest()->getVal(
'action',
'view' );
691 if ( $this->
getTitle()->userCan(
'deletedhistory', $this->
getUser() ) &&
692 ( !$this->
getTitle()->exists() || $action ==
'history' ) ) {
693 $n = $this->
getTitle()->isDeleted();
696 if ( $this->
getTitle()->quickUserCan(
'undelete', $this->
getUser() ) ) {
697 $msg =
'thisisdeleted';
699 $msg =
'viewdeleted';
702 return $this->
msg( $msg )->rawParams(
705 $this->
msg(
'restorelink' )->numParams( $n )->escaped() )
718 if (
$out ===
null ) {
724 if ( !
Hooks::run(
'SkinSubPageSubtitle', [ &$subpages, $this,
$out ] ) ) {
729 $ptext =
$title->getPrefixedText();
730 if ( strpos( $ptext,
'/' ) !==
false ) {
731 $links = explode(
'/', $ptext );
739 $growinglink .=
$link;
743 if ( is_object( $linkObj ) && $linkObj->isKnown() ) {
746 htmlspecialchars( $display )
752 $subpages .=
$lang->getDirMarkEntity() . $this->
msg(
'pipe-separator' )->escaped();
754 $subpages .=
'< ';
757 $subpages .= $getlink;
775 return $searchPage->getLocalURL();
792 if (
$type ==
'detect' ) {
794 && !$this->
msg(
'history_copyright' )->inContentLanguage()->isDisabled()
802 if (
$type ==
'history' ) {
803 $msg =
'history_copyright';
825 'SkinCopyrightFooter',
829 return $this->
msg( $msg )->rawParams(
$link )->text();
847 $out .=
'<a href="' . $url .
'">';
851 $out .=
"<img src=\"$icon\" alt=\"$text\" width=\"88\" height=\"31\" />";
868 $url1 = htmlspecialchars(
869 "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
871 $url1_5 = htmlspecialchars(
872 "$wgResourceBasePath/resources/assets/poweredby_mediawiki_132x47.png"
874 $url2 = htmlspecialchars(
875 "$wgResourceBasePath/resources/assets/poweredby_mediawiki_176x62.png"
877 $text =
'<a href="//www.mediawiki.org/"><img src="' . $url1
878 .
'" srcset="' . $url1_5 .
' 1.5x, ' . $url2 .
' 2x" '
879 .
'height="31" width="88" alt="Powered by MediaWiki" /></a>';
880 Hooks::run(
'SkinGetPoweredBy', [ &$text, $this ] );
890 $timestamp = $this->
getOutput()->getRevisionTimestamp();
892 # No cached timestamp, load it from the database
893 if ( $timestamp ===
null ) {
900 $s =
' ' . $this->
msg(
'lastmodifiedat', $d,
$t )->parse();
905 if ( MediaWikiServices::getInstance()->getDBLoadBalancer()->getLaggedReplicaMode() ) {
906 $s .=
' <strong>' . $this->
msg(
'laggedslavemode' )->parse() .
'</strong>';
917 if ( $align !=
'' ) {
918 $a =
" style='float: {$align};'";
923 $mp = $this->
msg(
'mainpage' )->escaped();
925 $url = ( is_object( $mptitle ) ? htmlspecialchars( $mptitle->getLocalURL() ) :
'' );
928 $s =
"<a href='{$url}'><img{$a} src='{$logourl}' alt='[{$mp}]' /></a>";
942 if ( is_string( $icon ) ) {
945 $url = isset( $icon[
"url"] ) ? $icon[
"url"] :
null;
946 unset( $icon[
"url"] );
947 if ( isset( $icon[
"src"] ) && $withImage ===
'withImage' ) {
951 $html = htmlspecialchars( $icon[
"alt"] );
970 $this->
msg(
'mainpage' )->escaped()
990 $this->
msg( $desc )->escaped()
1001 if ( $this->
msg( $desc )->inContentLanguage()->isDisabled() ) {
1018 return $this->
footerLink(
'privacy',
'privacypage' );
1026 return $this->
footerLink(
'aboutsite',
'aboutpage' );
1034 return $this->
footerLink(
'disclaimers',
'disclaimerpage' );
1059 if ( $id instanceof
User ) {
1065 # The sending user must have a confirmed email address and the receiving
1066 # user must accept emails from the sender.
1067 return $this->
getUser()->canSendEmail()
1085 if ( $this->stylename ===
null ) {
1087 throw new MWException(
"$class::\$stylename must be set to use getSkinStylePath()" );
1090 return "$wgStylePath/{$this->stylename}/$name?$wgStyleVersion";
1103 return $title->getLinkURL( $urlaction );
1119 if ( is_null( $proto ) ) {
1120 return $title->getLocalURL( $urlaction );
1122 return $title->getFullURL( $urlaction,
false, $proto );
1134 return $title->getLocalURL( $urlaction );
1145 return $title->getLocalURL( $urlaction );
1157 return $title->getLocalURL( $urlaction );
1185 return $title->getLocalURL( $urlaction );
1199 'href' =>
$title->getLocalURL( $urlaction ),
1200 'exists' =>
$title->isKnown(),
1215 'href' =>
$title->getLocalURL( $urlaction ),
1227 if ( !is_object(
$title ) ) {
1229 if ( !is_object(
$title ) ) {
1259 $callback =
function ( $old =
null, &$ttl = null ) {
1262 Hooks::run(
'SkinBuildSidebar', [ $this, &$bar ] );
1271 $wanCache = MediaWikiServices::getInstance()->getMainWANObjectCache();
1274 ? $wanCache->getWithSetCallback(
1275 $wanCache->makeKey(
'sidebar', $this->getLanguage()->getCode() ),
1282 $msgCache->getCheckKey( $this->getLanguage()->getCode() )
1290 Hooks::run(
'SidebarBeforeOutput', [ $this, &$sidebar ] );
1316 $lines = explode(
"\n", $text );
1319 $messageTitle = $this->
getConfig()->get(
'EnableSidebarCache' )
1323 if ( strpos(
$line,
'*' ) !== 0 ) {
1328 if ( strpos(
$line,
'**' ) !== 0 ) {
1329 $heading = trim(
$line,
'* ' );
1330 if ( !array_key_exists( $heading, $bar ) ) {
1331 $bar[$heading] = [];
1336 if ( strpos(
$line,
'|' ) !==
false ) {
1338 $line = array_map(
'trim', explode(
'|',
$line, 2 ) );
1347 $msgLink = $this->
msg( $line[0] )->title( $messageTitle )->inContentLanguage();
1348 if ( $msgLink->exists() ) {
1349 $link = $msgLink->text();
1350 if (
$link ==
'-' ) {
1356 $msgText = $this->
msg( $line[1] )->title( $messageTitle );
1357 if ( $msgText->exists() ) {
1358 $text = $msgText->text();
1369 $extraAttribs[
'rel'] =
'nofollow';
1381 $href =
$title->getLinkURL();
1383 $href =
'INVALID-TITLE';
1387 $bar[$heading][] = array_merge( [
1390 'id' => Sanitizer::escapeIdForAttribute(
'n-' . strtr(
$line[1],
' ',
'-' ) ),
1408 $newMessagesAlert =
'';
1417 if ( $newMessagesAlert ) {
1418 return $newMessagesAlert;
1422 $uTalkTitle =
$user->getTalkPage();
1425 if ( $lastSeenRev !==
null ) {
1428 if ( $latestRev !==
null ) {
1430 $plural = $latestRev->getParentId() !== $lastSeenRev->getId();
1431 $nofAuthors = $uTalkTitle->countAuthorsBetween(
1432 $lastSeenRev, $latestRev, 10,
'include_new' );
1438 $plural = $plural ? 999 : 1;
1444 $this->
msg(
'newmessageslinkplural' )->params( $plural )->escaped(),
1446 [
'redirect' =>
'no' ]
1451 $this->
msg(
'newmessagesdifflinkplural' )->params( $plural )->escaped(),
1453 $lastSeenRev !==
null
1454 ? [
'oldid' => $lastSeenRev->getId(),
'diff' =>
'cur' ]
1455 : [
'diff' =>
'cur' ]
1458 if ( $nofAuthors >= 1 && $nofAuthors <= 10 ) {
1459 $newMessagesAlert = $this->
msg(
1460 'youhavenewmessagesfromusers',
1462 $newMessagesDiffLink
1463 )->numParams( $nofAuthors, $plural );
1466 $newMessagesAlert = $this->
msg(
1467 $nofAuthors > 10 ?
'youhavenewmessagesmanyusers' :
'youhavenewmessages',
1469 $newMessagesDiffLink
1470 )->numParams( $plural );
1472 $newMessagesAlert = $newMessagesAlert->text();
1474 $out->setCdnMaxage( 0 );
1476 $sep = $this->
msg(
'newtalkseparator' )->escaped();
1482 [
'href' => $newtalk[
'link'] ], $newtalk[
'wiki']
1485 $parts = implode( $sep, $msgs );
1486 $newMessagesAlert = $this->
msg(
'youhavenewmessagesmulti' )->rawParams( $parts )->escaped();
1487 $out->setCdnMaxage( 0 );
1490 return $newMessagesAlert;
1505 if (
$name ===
'default' ) {
1509 if ( empty( $notice ) ) {
1513 $msg = $this->
msg(
$name )->inContentLanguage();
1514 if ( $msg->isBlank() ) {
1516 } elseif ( $msg->isDisabled() ) {
1519 $notice = $msg->plain();
1522 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
1523 $parsed =
$cache->getWithSetCallback(
1529 function ()
use ( $notice ) {
1530 return $this->
getOutput()->parse( $notice );
1537 'id' =>
'localNotice',
1553 if (
Hooks::run(
'SiteNoticeBefore', [ &$siteNotice, $this ] ) ) {
1554 if ( is_object( $this->
getUser() ) && $this->
getUser()->isLoggedIn() ) {
1558 if ( $anonNotice ===
false ) {
1561 $siteNotice = $anonNotice;
1564 if ( $siteNotice ===
false ) {
1569 Hooks::run(
'SiteNoticeAfter', [ &$siteNotice, $this ] );
1593 if ( !is_null( $tooltip ) ) {
1595 ->inLanguage(
$lang )->text();
1600 'text' =>
wfMessage(
'editsection' )->inLanguage(
$lang )->escaped(),
1601 'targetTitle' => $nt,
1603 'query' => [
'action' =>
'edit',
'section' =>
$section ],
1604 'options' => [
'noclasses',
'known' ]
1610 $result =
'<span class="mw-editsection"><span class="mw-editsection-bracket">[</span>';
1613 foreach ( $links
as $k => $linkDetails ) {
1615 $linkDetails[
'targetTitle'],
1616 $linkDetails[
'text'],
1617 $linkDetails[
'attribs'],
1618 $linkDetails[
'query'],
1619 $linkDetails[
'options']
1624 '<span class="mw-editsection-divider">'
1630 $result .=
'<span class="mw-editsection-bracket">]</span></span>';
1633 'DoEditSectionLink',
shouldPreloadLogo()
Whether the logo should be preloaded with an HTTP link header or not.
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
editUrlOptions()
Return URL options for the 'edit page' link.
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.
static makeUrlDetails( $name, $urlaction='')
these return an array with the 'href' and boolean 'exists'
getSiteNotice()
Get the site notice.
const TTL_UNCACHEABLE
Idiom for getWithSetCallback() callbacks to avoid calling set()
footerLinkTitle( $desc, $page)
Class representing a list of titles The execute() method checks them all for existence and adds them ...
doEditSectionLink(Title $nt, $section, $tooltip=null, $lang=false)
Create a section edit link.
$wgRightsText
If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the link.
getPoweredBy()
Gets the powered by MediaWiki icon.
if(!isset( $args[0])) $lang
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
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
static newMainPage()
Create a new Title for the Main Page.
lastModified()
Get the timestamp of the latest revision, formatted in user language.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
$wgNoFollowDomainExceptions
If this is set to an array of domains, external links to these domain names (or any subdomains) will ...
static checkTitle(&$title, $name)
make sure we have some title to operate on
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 getHTMLDebugLog()
Generate debug log in HTML for displaying at the bottom of the main content area.
static makeSpecialUrl( $name, $urlaction='', $proto=null)
Make a URL for a Special Page using the given query and protocol.
aboutLink()
Gets the link to the wiki's about page.
static getDynamicStylesheetQuery()
Get the query to generate a dynamic stylesheet.
static makeSpecialUrlSubpage( $name, $subpage, $urlaction='')
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
addToBodyAttributes( $out, &$bodyAttrs)
This will be called by OutputPage::headElement when it is creating the "<body>" tag,...
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
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,...
Allows to change the fields on the form that will be generated $name
$wgSidebarCacheExpiry
Expiry time for the sidebar cache, in seconds.
wfExpandIRI( $url)
Take a URL, make sure it's expanded to fully qualified, and replace any encoded non-ASCII Unicode cha...
$wgLogo
The URL path of the wiki logo.
static makeI18nUrl( $name, $urlaction='')
getHtmlElementAttributes()
Return values for <html> element.
$wgStylePath
The URL path of the skins directory.
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
bottomScripts()
This gets called shortly before the "</body>" tag.
mainPageLink()
Gets the link to the wiki's main page.
static getSkinNames()
Fetch the set of available skins.
afterContentHook()
This runs a hook to allow extensions placing their stuff after content and article metadata (e....
static getSafeTitleFor( $name, $subpage=false)
Get a localised Title object for a page name with a possibly unvalidated subpage.
getCachedNotice( $name)
Get a cached notice.
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target.
$wgRightsPage
Override for copyright metadata.
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
buildSidebar()
Build an array that represents the sidebar(s), the navigation bar among them.
privacyLink()
Gets the link to the wiki's privacy policy page.
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
$wgFooterIcons
Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code You can ad...
static getSkinNameMessages()
Fetch the skinname messages for available skins.
static normalizeKey( $key)
Normalize a skin preference value to a form that can be loaded.
footerLink( $desc, $page)
Returns an HTML link for use in the footer.
generateDebugHTML()
Generate debug data HTML for displaying at the bottom of the main content area.
static getTimestampFromId( $title, $id, $flags=0)
Get rev_timestamp from rev_id, without loading the rest of the row.
$wgFallbackSkin
Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
string $stylename
Stylesheets set to use.
setRelevantUser( $u)
Set the "relevant" user.
$wgEnableSidebarCache
If on, the sidebar navigation links are cached for users with the current language set.
$wgStyleVersion
Bump this number when changing the global style sheets and JavaScript.
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable 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
addToSidebar(&$bar, $message)
Add content from a sidebar system message Currently only used for MediaWiki:Sidebar (but may be used ...
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
static isIP( $name)
Does the string match an anonymous IP address?
isRevisionCurrent()
Whether the revision displayed is the latest revision of the page.
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
static hasSubpages( $index)
Does the namespace allow subpages?
drawCategoryBrowser( $tree)
Render the array as a series of links.
static makeNSUrl( $name, $urlaction='', $namespace=NS_MAIN)
this can be passed the NS number as defined in Language.php
preloadExistence()
Preload the existence of three commonly-requested pages in a single query.
static makeExternalLink( $url, $text, $escape=true, $linktype='', $attribs=[], $title=null)
Make an external link.
$wgUseCategoryBrowser
Use experimental, DMOZ-like category browser.
$wgDefaultSkin
Default skin, for new users and anonymous visitors.
when a variable name is used in a it is silently declared as a new masking the global
disclaimerLink()
Gets the link to the wiki's general disclaimers page.
$wgExternalLinkTarget
Set a default target for external links, e.g.
getLogo()
URL to the logo.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
This class should be covered by a general architecture document which does not exist as of January 20...
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
outputPage(OutputPage $out=null)
Outputs the HTML generated by other functions.
static singleton()
Get the signleton instance of this class.
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
getRelevantTitle()
Return the "relevant" title.
getSkinStylePath( $name)
Return a fully resolved style path url to images or styles stored in the current skins's folder.
getPageClasses( $title)
TODO: document.
$wgNoFollowLinks
If true, external URL links in wiki text will be given the rel="nofollow" attribute as a hint to sear...
getDefaultModules()
Defines the ResourceLoader modules that should be added to the skin It is recommended that skins wish...
static validateTarget( $target, User $sender=null)
Validate target User.
static link( $target, $html=null, $customAttribs=[], $query=[], $options=[])
This function returns an HTML link to the given target.
printSource()
Text with the permalink to the source page, usually shown on the footer of a printed page.
$wgRightsIcon
Override for copyright metadata.
static resolveAlias( $alias)
Given a special page name with a possible subpage, return an array where the first element is the spe...
static makeVariablesScript( $data)
$wgResourceBasePath
The default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
getNewtalks()
Gets new talk page messages for the current user and returns an appropriate alert message (or an empt...
Represents a title within MediaWiki.
static makeUrl( $name, $urlaction='')
wfMatchesDomainList( $url, $domains)
Check whether a given URL has a domain that occurs in a given set of domains.
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
$wgEnableWriteAPI
Allow the API to be used to perform write operations (page edits, rollback, etc.) when an authorised ...
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
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
getCopyright( $type='detect')
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
$wgSiteNotice
Site notice shown at the top of each page.
getRelevantUser()
Return the "relevant" user.
subPageSubtitle( $out=null)
$wgRenderHashAppend
Append a configured value to the parser cache and the sitenotice key so that they can be kept separat...
usually copyright or history_copyright This message must be in HTML not wikitext & $link
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 true
static makeKnownUrlDetails( $name, $urlaction='')
Make URL details where the article exists (or at least it's convenient to think so)
$wgSkipSkins
Specify the names of skins that should not be presented in the list of available skins in user prefer...
setupSkinUserCss(OutputPage $out)
Add skin specific stylesheets Calling this method with an $out of anything but the same OutputPage in...
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 "<
static makeMainPageUrl( $urlaction='')
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
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 getAllowedSkins()
Fetch the list of user-selectable skins in regards to $wgSkipSkins.
The main skin class which provides methods and properties for all other skins.
$wgEnableAPI
Enable the MediaWiki API for convenient access to machine-readable data via api.php.
initPage(OutputPage $out)
setRelevantTitle( $t)
Set the "relevant" title.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
the value of this variable comes from LanguageConverter indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect $newtalks
$wgUseAjax
Enable AJAX framework.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
getRevisionId()
Get the current revision ID.
addToSidebarPlain(&$bar, $text)
Add content from plain text.
static getDefaultInstance()
__construct( $skinname=null)
$wgSquidMaxage
Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI).
static makeInternalOrExternalUrl( $name)
If url string starts with http, consider as external URL, else internal.
$wgRightsUrl
Set this to specify an external URL containing details about the content license used on your wiki.
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
makeFooterIcon( $icon, $withImage='withImage')
Renders a $wgFooterIcons icon according to the method's arguments.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out