Go to the documentation of this file.
28 use Wikimedia\Timestamp\TimestampException;
60 'login' =>
'ApiLogin',
61 'clientlogin' =>
'ApiClientLogin',
62 'logout' =>
'ApiLogout',
63 'createaccount' =>
'ApiAMCreateAccount',
64 'linkaccount' =>
'ApiLinkAccount',
65 'unlinkaccount' =>
'ApiRemoveAuthenticationData',
66 'changeauthenticationdata' =>
'ApiChangeAuthenticationData',
67 'removeauthenticationdata' =>
'ApiRemoveAuthenticationData',
68 'resetpassword' =>
'ApiResetPassword',
69 'query' =>
'ApiQuery',
70 'expandtemplates' =>
'ApiExpandTemplates',
71 'parse' =>
'ApiParse',
72 'stashedit' =>
'ApiStashEdit',
73 'opensearch' =>
'ApiOpenSearch',
74 'feedcontributions' =>
'ApiFeedContributions',
75 'feedrecentchanges' =>
'ApiFeedRecentChanges',
76 'feedwatchlist' =>
'ApiFeedWatchlist',
78 'paraminfo' =>
'ApiParamInfo',
80 'compare' =>
'ApiComparePages',
81 'tokens' =>
'ApiTokens',
82 'checktoken' =>
'ApiCheckToken',
83 'cspreport' =>
'ApiCSPReport',
84 'validatepassword' =>
'ApiValidatePassword',
87 'purge' =>
'ApiPurge',
88 'setnotificationtimestamp' =>
'ApiSetNotificationTimestamp',
89 'rollback' =>
'ApiRollback',
90 'delete' =>
'ApiDelete',
91 'undelete' =>
'ApiUndelete',
92 'protect' =>
'ApiProtect',
93 'block' =>
'ApiBlock',
94 'unblock' =>
'ApiUnblock',
96 'edit' =>
'ApiEditPage',
97 'upload' =>
'ApiUpload',
98 'filerevert' =>
'ApiFileRevert',
99 'emailuser' =>
'ApiEmailUser',
100 'watch' =>
'ApiWatch',
101 'patrol' =>
'ApiPatrol',
102 'import' =>
'ApiImport',
103 'clearhasmsg' =>
'ApiClearHasMsg',
104 'userrights' =>
'ApiUserrights',
105 'options' =>
'ApiOptions',
106 'imagerotate' =>
'ApiImageRotate',
107 'revisiondelete' =>
'ApiRevisionDelete',
108 'managetags' =>
'ApiManageTags',
110 'mergehistory' =>
'ApiMergeHistory',
111 'setpagelanguage' =>
'ApiSetPageLanguage',
118 'json' =>
'ApiFormatJson',
119 'jsonfm' =>
'ApiFormatJson',
120 'php' =>
'ApiFormatPhp',
121 'phpfm' =>
'ApiFormatPhp',
122 'xml' =>
'ApiFormatXml',
123 'xmlfm' =>
'ApiFormatXml',
124 'rawfm' =>
'ApiFormatJson',
125 'none' =>
'ApiFormatNone',
137 'msg' =>
'right-writeapi',
141 'msg' =>
'api-help-right-apihighlimits',
196 parent::__construct( $this, $this->mInternalMode ?
'main_int' :
'main' );
200 if ( !$this->mInternalMode ) {
203 $originHeader =
$request->getHeader(
'Origin' );
204 if ( $originHeader ===
false ) {
207 $originHeader = trim( $originHeader );
208 $origins = preg_split(
'/\s+/', $originHeader );
210 $sessionCookies = array_intersect(
211 array_keys( $_COOKIE ),
212 MediaWiki\Session\SessionManager::singleton()->getVaryCookies()
214 if ( $origins && $sessionCookies && (
215 count( $origins ) !== 1 || !self::matchOrigin(
217 $config->get(
'CrossSiteAJAXdomains' ),
218 $config->get(
'CrossSiteAJAXdomainExceptions' )
221 LoggerFactory::getInstance(
'cors' )->warning(
222 'Non-whitelisted CORS request with session cookies', [
223 'origin' => $originHeader,
224 'cookies' => $sessionCookies,
236 wfDebug(
"API: stripping user credentials when the same-origin policy is not applied\n" );
237 $wgUser =
new User();
246 $uselang =
$request->getVal(
'uselang', self::API_DEFAULT_USELANG );
247 if ( $uselang ===
'user' ) {
251 if ( $uselang ===
'content' ) {
257 if ( !$this->mInternalMode ) {
266 $errorFormat =
$request->getVal(
'errorformat',
'bc' );
267 $errorLangCode =
$request->getVal(
'errorlang',
'uselang' );
268 $errorsUseDB =
$request->getCheck(
'errorsuselocal' );
269 if ( in_array( $errorFormat, [
'plaintext',
'wikitext',
'html',
'raw',
'none' ],
true ) ) {
270 if ( $errorLangCode ===
'uselang' ) {
272 } elseif ( $errorLangCode ===
'content' ) {
280 $this->mResult, $errorLang, $errorFormat, $errorsUseDB
288 $this->mModuleMgr->addModules( self::$Modules,
'action' );
289 $this->mModuleMgr->addModules( $config->get(
'APIModules' ),
'action' );
290 $this->mModuleMgr->addModules( self::$Formats,
'format' );
291 $this->mModuleMgr->addModules( $config->get(
'APIFormatModules' ),
'format' );
293 Hooks::run(
'ApiMain::moduleManager', [ $this->mModuleMgr ] );
295 $this->mContinuationManager =
null;
296 $this->mEnableWrite = $enableWrite;
298 $this->mSquidMaxage = -1;
299 $this->mCommit =
false;
331 if (
$request->getVal(
'callback' ) !== null ) {
337 if (
$request->getVal(
'origin' ) ===
'*' ) {
344 if (
$request->getHeader(
'Treat-as-Untrusted' ) !==
false ) {
375 if ( $manager !==
null ) {
377 throw new InvalidArgumentException( __METHOD__ .
': Was passed ' .
378 is_object( $manager ) ? get_class( $manager ) : gettype( $manager )
381 if ( $this->mContinuationManager !==
null ) {
382 throw new UnexpectedValueException(
383 __METHOD__ .
': tried to set manager from ' . $manager->getSource() .
384 ' when a manager is already set from ' . $this->mContinuationManager->getSource()
388 $this->mContinuationManager = $manager;
416 'max-age' => $maxage,
417 's-maxage' => $maxage
447 if ( !in_array( $mode, [
'private',
'public',
'anon-public-user-private' ] ) ) {
448 wfDebug( __METHOD__ .
": unrecognised cache mode \"$mode\"\n" );
456 if ( $mode !==
'private' ) {
457 wfDebug( __METHOD__ .
": ignoring request for $mode cache mode, private wiki\n" );
463 if ( $mode ===
'public' && $this->
getParameter(
'uselang' ) ===
'user' ) {
468 wfDebug( __METHOD__ .
": downgrading cache mode 'public' to " .
469 "'anon-public-user-private' due to uselang=user\n" );
470 $mode =
'anon-public-user-private';
473 wfDebug( __METHOD__ .
": setting cache mode $mode\n" );
474 $this->mCacheMode = $mode;
499 $printer = $this->mModuleMgr->getModule( $format,
'format' );
500 if ( $printer ===
null ) {
513 if ( $this->mInternalMode ) {
533 if ( $this->
getRequest()->getMethod() ===
'OPTIONS' ) {
539 $obLevel = ob_get_level();
542 $t = microtime(
true );
546 $runTime = microtime(
true ) -
$t;
548 if ( $this->mModule->isWriteMode() && $this->
getRequest()->wasPosted() ) {
549 MediaWikiServices::getInstance()->getStatsdDataFactory()->timing(
550 'api.' . $this->mModule->getModuleName() .
'.executeTiming', 1000 * $runTime
553 }
catch ( Exception
$e ) {
568 while ( ob_get_level() > $obLevel ) {
599 $headerStr =
'MediaWiki-API-Error: ' . join(
', ', $errCodes );
615 $this->
addWarning(
'apiwarn-errorprinterfailed' );
618 $this->mPrinter->addWarning( $error );
619 }
catch ( Exception $ex2 ) {
629 [
'apiwarn-errorprinterfailed-ex', $ex->getMessage() ],
'errorprinterfailed'
633 $this->mPrinter =
null;
635 $this->mPrinter->forceDefaultParams();
636 if (
$e->getCode() ) {
658 $main->handleException(
$e );
659 $main->logRequest( 0,
$e );
660 }
catch ( Exception $e2 ) {
666 $main->sendCacheHeaders(
true );
687 if ( $originParam ===
null ) {
695 $matchOrigin =
false;
696 $allowTiming =
false;
699 if ( $originParam ===
'*' ) {
703 $allowCredentials =
'false';
709 $originHeader =
$request->getHeader(
'Origin' );
710 if ( $originHeader ===
false ) {
713 $originHeader = trim( $originHeader );
714 $origins = preg_split(
'/\s+/', $originHeader );
717 if ( !in_array( $originParam, $origins ) ) {
721 $response->header(
'Cache-Control: no-cache' );
722 echo
"'origin' parameter does not match Origin header\n";
730 $config->get(
'CrossSiteAJAXdomains' ),
731 $config->get(
'CrossSiteAJAXdomainExceptions' )
734 $allowOrigin = $originHeader;
735 $allowCredentials =
'true';
736 $allowTiming = $originHeader;
739 if ( $matchOrigin ) {
740 $requestedMethod =
$request->getHeader(
'Access-Control-Request-Method' );
741 $preflight =
$request->getMethod() ===
'OPTIONS' && $requestedMethod !==
false;
744 if ( $requestedMethod !==
'POST' && $requestedMethod !==
'GET' ) {
749 $requestedHeaders =
$request->getHeader(
'Access-Control-Request-Headers' );
750 if ( $requestedHeaders !==
false ) {
751 if ( !self::matchRequestedHeaders( $requestedHeaders ) ) {
754 $response->header(
'Access-Control-Allow-Headers: ' . $requestedHeaders );
758 $response->header(
'Access-Control-Allow-Methods: POST, GET' );
761 $response->header(
"Access-Control-Allow-Origin: $allowOrigin" );
762 $response->header(
"Access-Control-Allow-Credentials: $allowCredentials" );
764 if ( $allowTiming !==
false ) {
765 $response->header(
"Timing-Allow-Origin: $allowTiming" );
770 'Access-Control-Expose-Headers: MediaWiki-API-Error, Retry-After, X-Database-Lag'
776 $this->
getOutput()->addVaryHeader(
'Origin' );
791 foreach ( $rules
as $rule ) {
792 if ( preg_match( self::wildcardToRegex( $rule ),
$value ) ) {
794 foreach ( $exceptions
as $exc ) {
795 if ( preg_match( self::wildcardToRegex( $exc ),
$value ) ) {
815 if ( trim( $requestedHeaders ) ===
'' ) {
818 $requestedHeaders = explode(
',', $requestedHeaders );
819 $allowedAuthorHeaders = array_flip( [
832 foreach ( $requestedHeaders
as $rHeader ) {
833 $rHeader = strtolower( trim( $rHeader ) );
834 if ( !isset( $allowedAuthorHeaders[$rHeader] ) ) {
835 wfDebugLog(
'api',
'CORS preflight failed on requested header: ' . $rHeader );
851 $wildcard = preg_quote( $wildcard,
'/' );
852 $wildcard = str_replace(
858 return "/^https?:\/\/$wildcard$/";
870 $out->addVaryHeader(
'Treat-as-Untrusted' );
874 if ( $config->get(
'VaryOnXFP' ) ) {
875 $out->addVaryHeader(
'X-Forwarded-Proto' );
878 if ( !$isError && $this->mModule &&
881 $etag = $this->mModule->getConditionalRequestData(
'etag' );
882 if ( $etag !==
null ) {
885 $lastMod = $this->mModule->getConditionalRequestData(
'last-modified' );
886 if ( $lastMod !==
null ) {
898 if ( isset( $this->mCacheControl[
'max-age'] ) ) {
899 $maxage = $this->mCacheControl[
'max-age'];
900 } elseif ( ( $this->mModule && !$this->mModule->isWriteMode() ) ||
901 $this->mCacheMode !==
'private'
905 $privateCache =
'private, must-revalidate, max-age=' . $maxage;
907 if ( $this->mCacheMode ==
'private' ) {
908 $response->header(
"Cache-Control: $privateCache" );
912 $useKeyHeader = $config->get(
'UseKeyHeader' );
913 if ( $this->mCacheMode ==
'anon-public-user-private' ) {
914 $out->addVaryHeader(
'Cookie' );
916 if ( $useKeyHeader ) {
918 if (
$out->haveCacheVaryCookies() ) {
920 $response->header(
"Cache-Control: $privateCache" );
924 } elseif (
MediaWiki\Session\SessionManager::getGlobalSession()->isPersistent() ) {
927 $response->header(
"Cache-Control: $privateCache" );
935 if ( $useKeyHeader ) {
940 if ( !isset( $this->mCacheControl[
's-maxage'] ) ) {
941 $this->mCacheControl[
's-maxage'] = $this->
getParameter(
'smaxage' );
943 if ( !isset( $this->mCacheControl[
'max-age'] ) ) {
944 $this->mCacheControl[
'max-age'] = $this->
getParameter(
'maxage' );
947 if ( !$this->mCacheControl[
's-maxage'] && !$this->mCacheControl[
'max-age'] ) {
951 $response->header(
"Cache-Control: $privateCache" );
956 $this->mCacheControl[
'public'] =
true;
959 $maxAge = min( $this->mCacheControl[
's-maxage'], $this->mCacheControl[
'max-age'] );
960 $expiryUnixTime = ( $maxAge == 0 ? 1 : time() + $maxAge );
967 if ( is_bool(
$value ) ) {
969 $ccHeader .= $separator .
$name;
973 $ccHeader .= $separator .
"$name=$value";
978 $response->header(
"Cache-Control: $ccHeader" );
985 if ( !isset( $this->mPrinter ) ) {
987 if ( !$this->mModuleMgr->isDefined(
$value,
'format' ) ) {
995 if ( !$this->mPrinter->canPrintErrors() ) {
1021 foreach (
$e->getStatusValue()->getErrorsByType(
$type )
as $error ) {
1024 } elseif (
$type !==
'error' ) {
1028 $data =
$e->getMessageArray();
1029 $code = $data[
'code'];
1030 $info = $data[
'info'];
1031 unset( $data[
'code'], $data[
'info'] );
1036 $class = preg_replace(
'#^Wikimedia\\\Rdbms\\\#',
'', get_class(
$e ) );
1037 $code =
'internal_api_error_' . $class;
1038 if ( (
$e instanceof
DBQueryError ) && !$config->get(
'ShowSQLErrors' ) ) {
1042 'apierror-exceptioncaught',
1045 ?
$e->getMessageObject()
1066 $errors =
$result->getResultData( [
'errors' ] );
1067 $warnings =
$result->getResultData( [
'warnings' ] );
1069 if ( $warnings !==
null ) {
1072 if ( $errors !==
null ) {
1076 foreach ( $errors
as $error ) {
1077 if ( isset( $error[
'code'] ) ) {
1078 $errorCodes[$error[
'code']] =
true;
1086 $errorCodes[$msg->getApiCode()] =
true;
1087 $formatter->addError( $modulePath, $msg );
1090 $formatter->addWarning( $modulePath, $msg );
1096 $path = [
'error' ];
1106 $this->
msg(
'api-usage-docref',
$link )->inLanguage( $formatter->getLanguage() )->
text()
1108 . $this->
msg(
'api-usage-mailinglist-ref' )->inLanguage( $formatter->getLanguage() )->
text()
1112 if ( $config->get(
'ShowExceptionDetails' ) &&
1113 ( !
$e instanceof
DBError || $config->get(
'ShowDBErrorBacktrace' ) )
1118 $this->
msg(
'api-exception-trace',
1123 )->inLanguage( $formatter->getLanguage() )->
text()
1131 return array_keys( $errorCodes );
1143 if ( $requestid !==
null ) {
1147 if ( $this->
getConfig()->
get(
'ShowHostnames' ) && (
1148 in_array(
'servedby', $force,
true ) || $this->
getParameter(
'servedby' )
1174 $this->mAction =
$params[
'action'];
1187 $module = $this->mModuleMgr->getModule( $this->mAction,
'action' );
1188 if ( $module ===
null ) {
1190 [
'apierror-unknownaction',
wfEscapeWikiText( $this->mAction ) ],
'unknown_action'
1193 $moduleParams = $module->extractRequestParams();
1196 if ( $module->needsToken() ===
true ) {
1198 "Module '{$module->getModuleName()}' must be updated for the new token handling. " .
1199 'See documentation for ApiBase::needsToken for details.'
1202 if ( $module->needsToken() ) {
1203 if ( !$module->mustBePosted() ) {
1205 "Module '{$module->getModuleName()}' must require POST to use tokens."
1209 if ( !isset( $moduleParams[
'token'] ) ) {
1210 $module->dieWithError( [
'apierror-missingparam',
'token' ] );
1213 $module->requirePostedParameters( [
'token' ] );
1215 if ( !$module->validateToken( $moduleParams[
'token'], $moduleParams ) ) {
1216 $module->dieWithError(
'apierror-badtoken' );
1227 $dbLag = MediaWikiServices::getInstance()->getDBLoadBalancer()->getMaxLag();
1229 'host' => $dbLag[0],
1234 $jobQueueLagFactor = $this->
getConfig()->get(
'JobQueueIncludeInMaxLagFactor' );
1235 if ( $jobQueueLagFactor ) {
1238 $jobQueueLag = $totalJobs / (float)$jobQueueLagFactor;
1239 if ( $jobQueueLag > $lagInfo[
'lag'] ) {
1242 'lag' => $jobQueueLag,
1243 'type' =>
'jobqueue',
1244 'jobs' => $totalJobs,
1259 if ( $module->shouldCheckMaxlag() && isset(
$params[
'maxlag'] ) ) {
1262 if ( $lagInfo[
'lag'] > $maxLag ) {
1265 $response->header(
'Retry-After: ' . max( intval( $maxLag ), 5 ) );
1266 $response->header(
'X-Database-Lag: ' . intval( $lagInfo[
'lag'] ) );
1268 if ( $this->
getConfig()->
get(
'ShowHostnames' ) ) {
1270 [
'apierror-maxlag', $lagInfo[
'lag'], $lagInfo[
'host'] ],
1276 $this->
dieWithError( [
'apierror-maxlag-generic', $lagInfo[
'lag'] ],
'maxlag', $lagInfo );
1305 if ( $this->mInternalMode ) {
1310 if ( $this->
getRequest()->getMethod() !==
'GET' && $this->
getRequest()->getMethod() !==
'HEAD' ) {
1317 $ifNoneMatch = array_diff(
1321 if ( $ifNoneMatch ) {
1322 if ( $ifNoneMatch === [
'*' ] ) {
1326 $etag = $module->getConditionalRequestData(
'etag' );
1329 if ( $ifNoneMatch && $etag !==
null ) {
1330 $test = substr( $etag, 0, 2 ) ===
'W/' ? substr( $etag, 2 ) : $etag;
1331 $match = array_map(
function (
$s ) {
1332 return substr(
$s, 0, 2 ) ===
'W/' ? substr(
$s, 2 ) :
$s;
1334 $return304 = in_array( $test, $match,
true );
1341 $i = strpos(
$value,
';' );
1342 if ( $i !==
false ) {
1351 $ts->getTimestamp( TS_RFC2822 ) ===
$value ||
1353 $ts->format(
'l, d-M-y H:i:s' ) .
' GMT' ===
$value ||
1355 $ts->format(
'D M j H:i:s Y' ) ===
$value ||
1356 $ts->format(
'D M j H:i:s Y' ) ===
$value
1358 $lastMod = $module->getConditionalRequestData(
'last-modified' );
1359 if ( $lastMod !==
null ) {
1363 'user' => $this->
getUser()->getTouched(),
1364 'epoch' => $this->
getConfig()->get(
'CacheEpoch' ),
1366 if ( $this->
getConfig()->
get(
'UseSquid' ) ) {
1369 TS_MW, time() - $this->
getConfig()->
get(
'SquidMaxage' )
1373 $lastMod = max( $modifiedTimes );
1374 $return304 =
wfTimestamp( TS_MW, $lastMod ) <= $ts->getTimestamp( TS_MW );
1377 }
catch ( TimestampException
$e ) {
1384 $this->
getRequest()->response()->statusHeader( 304 );
1387 MediaWiki\suppressWarnings();
1388 ini_set(
'zlib.output_compression', 0 );
1389 MediaWiki\restoreWarnings();
1405 !
$user->isAllowed(
'read' )
1410 if ( $module->isWriteMode() ) {
1411 if ( !$this->mEnableWrite ) {
1413 } elseif ( !
$user->isAllowed(
'writeapi' ) ) {
1415 } elseif ( $this->
getRequest()->getHeader(
'Promise-Non-Write-API-Action' ) ) {
1416 $this->
dieWithError(
'apierror-promised-nonwrite-api' );
1424 if ( !
Hooks::run(
'ApiCheckCanExecute', [ $module,
$user, &$message ] ) ) {
1438 if ( $module->isWriteMode()
1440 &&
wfGetLB()->getServerCount() > 1
1452 $lagLimit = $this->
getConfig()->get(
'APIMaxLagThreshold' );
1453 $laggedServers = [];
1455 foreach ( $loadBalancer->getLagTimes()
as $serverIndex => $lag ) {
1456 if ( $lag > $lagLimit ) {
1458 $laggedServers[] = $loadBalancer->getServerName( $serverIndex ) .
" ({$lag}s)";
1463 $replicaCount =
wfGetLB()->getServerCount() - 1;
1464 if ( $numLagged >= ceil( $replicaCount / 2 ) ) {
1465 $laggedServers = implode(
', ', $laggedServers );
1468 "Api request failed as read only because the following DBs are lagged: $laggedServers"
1474 [
'readonlyreason' =>
"Waiting for $numLagged lagged database(s)" ]
1484 if ( isset(
$params[
'assert'] ) ) {
1486 switch (
$params[
'assert'] ) {
1488 if (
$user->isAnon() ) {
1493 if ( !
$user->isAllowed(
'bot' ) ) {
1499 if ( isset(
$params[
'assertuser'] ) ) {
1501 if ( !$assertUser || !$this->
getUser()->equals( $assertUser ) ) {
1516 if ( !
$request->wasPosted() && $module->mustBePosted() ) {
1523 $this->mPrinter = $module->getCustomPrinter();
1524 if ( is_null( $this->mPrinter ) ) {
1529 if (
$request->getProtocol() ===
'http' && (
1530 $request->getSession()->shouldForceHTTPS() ||
1531 ( $this->
getUser()->isLoggedIn() &&
1532 $this->
getUser()->requiresHTTPS() )
1534 $this->
addDeprecation(
'apiwarn-deprecation-httpsexpected',
'https-expected' );
1544 $this->mModule = $module;
1546 if ( !$this->mInternalMode ) {
1560 if ( !$this->mInternalMode ) {
1568 Hooks::run(
'APIAfterExecute', [ &$module ] );
1572 if ( !$this->mInternalMode ) {
1586 $limits = $this->
getConfig()->get(
'TrxProfilerLimits' );
1588 $trxProfiler->setLogger( LoggerFactory::getInstance(
'DBPerformance' ) );
1589 if ( $this->
getRequest()->hasSafeMethod() ) {
1590 $trxProfiler->setExpectations( $limits[
'GET'], __METHOD__ );
1592 $trxProfiler->setExpectations( $limits[
'POST-nonwrite'], __METHOD__ );
1595 $trxProfiler->setExpectations( $limits[
'POST'], __METHOD__ );
1611 'timeSpentBackend' => (int)round(
$time * 1000 ),
1612 'hadError' =>
$e !==
null,
1619 $logCtx[
'errorCodes'][] = $msg->getApiCode();
1624 $msg =
"API {$request->getMethod()} " .
1626 " {$logCtx['ip']} " .
1627 "T={$logCtx['timeSpentBackend']}ms";
1636 if ( isset( $sensitive[
$name] ) ) {
1638 $encValue =
'[redacted]';
1639 } elseif ( strlen(
$value ) > 256 ) {
1647 $msg .=
" {$name}={$encValue}";
1652 wfDebugLog(
'ApiAction',
'',
'private', $logCtx );
1663 $chars =
';@$!*(),/:';
1664 $numChars = strlen( $chars );
1665 for ( $i = 0; $i < $numChars; $i++ ) {
1666 $table[rawurlencode( $chars[$i] )] = $chars[$i];
1670 return strtr( rawurlencode(
$s ), $table );
1678 return array_keys( $this->mParamsUsed );
1686 $this->mParamsUsed += array_fill_keys( (
array)
$params,
true );
1695 return array_keys( $this->mParamsSensitive );
1704 $this->mParamsSensitive += array_fill_keys( (
array)
$params,
true );
1714 $this->mParamsUsed[
$name] =
true;
1717 if (
$ret ===
null ) {
1746 $this->mParamsUsed[
$name] =
true;
1757 $allParams = $this->
getRequest()->getValueNames();
1759 if ( !$this->mInternalMode ) {
1761 $printerParams = $this->mPrinter->encodeParamName(
1762 array_keys( $this->mPrinter->getFinalParams() ?: [] )
1764 $unusedParams = array_diff( $allParams, $paramsUsed, $printerParams );
1766 $unusedParams = array_diff( $allParams, $paramsUsed );
1769 if (
count( $unusedParams ) ) {
1771 'apierror-unrecognizedparams',
1772 Message::listParam( array_map(
'wfEscapeWikiText', $unusedParams ),
'comma' ),
1773 count( $unusedParams )
1784 if ( $this->
getConfig()->
get(
'DebugAPI' ) !==
false ) {
1791 $printer->setHttpStatus( $httpCode );
1793 $printer->execute();
1794 $printer->closePrinter();
1836 'requestid' =>
null,
1837 'servedby' =>
false,
1838 'curtimestamp' =>
false,
1839 'responselanginfo' =>
false,
1851 'errorsuselocal' => [
1861 =>
'apihelp-help-example-main',
1862 'action=help&recursivesubmodules=1'
1863 =>
'apihelp-help-example-recursive',
1872 foreach ( $oldHelp
as $k => $v ) {
1873 if ( $k ===
'submodules' ) {
1874 $help[
'permissions'] =
'';
1878 $help[
'datatypes'] =
'';
1879 $help[
'credits'] =
'';
1883 [
'class' =>
'apihelp-block apihelp-permissions' ] );
1884 $m = $this->
msg(
'api-help-permissions' );
1885 if ( !$m->isDisabled() ) {
1887 $m->numParams(
count( self::$mRights ) )->parse()
1891 foreach ( self::$mRights
as $right => $rightMsg ) {
1894 $rightMsg = $this->
msg( $rightMsg[
'msg'], $rightMsg[
'params'] )->parse();
1897 $groups = array_map(
function ( $group ) {
1898 return $group ==
'*' ?
'all' : $group;
1902 $this->
msg(
'api-help-permissions-granted-to' )
1903 ->numParams(
count( $groups ) )
1904 ->params( Message::listParam( $groups ) )
1912 if ( empty(
$options[
'nolead'] ) ) {
1914 $tocnumber = &
$options[
'tocnumber'];
1916 $header = $this->
msg(
'api-help-datatypes-header' )->parse();
1919 if ( !$this->
getConfig()->
get(
'ExperimentalHtmlIds' ) ) {
1924 [
'id' =>
'main/datatypes',
'class' =>
'apihelp-header' ],
1927 $help[
'datatypes'] .= $this->
msg(
'api-help-datatypes' )->parseAsBlock();
1928 if ( !isset( $tocData[
'main/datatypes'] ) ) {
1929 $tocnumber[$level]++;
1930 $tocData[
'main/datatypes'] = [
1931 'toclevel' =>
count( $tocnumber ),
1933 'anchor' =>
'main/datatypes',
1935 'number' => implode(
'.', $tocnumber ),
1941 if ( !$this->
getConfig()->
get(
'ExperimentalHtmlIds' ) ) {
1945 $header = $this->
msg(
'api-credits-header' )->parse();
1947 [
'id' =>
'main/credits',
'class' =>
'apihelp-header' ],
1950 $help[
'credits'] .= $this->
msg(
'api-credits' )->useDatabase(
false )->parseAsBlock();
1951 if ( !isset( $tocData[
'main/credits'] ) ) {
1952 $tocnumber[$level]++;
1953 $tocData[
'main/credits'] = [
1954 'toclevel' =>
count( $tocnumber ),
1956 'anchor' =>
'main/credits',
1958 'number' => implode(
'.', $tocnumber ),
1972 if ( !isset( $this->mCanApiHighLimits ) ) {
1973 $this->mCanApiHighLimits = $this->
getUser()->isAllowed(
'apihighlimits' );
1997 $this->
getRequest()->getHeader(
'Api-user-agent' ) .
' ' .
1998 $this->
getRequest()->getHeader(
'User-agent' )
getStatusValue()
Fetch the error status.
executeActionWithErrorHandling()
Execute an action, and in case of an error, erase whatever partial results have been accumulated,...
Library for creating and parsing MW-style timestamps.
This is the main API class, used for both external and internal processing.
getConfig()
Get the Config object.
WebRequest clone which takes values from a provided array.
Exception used to abort API execution with an error.
getContext()
Get the base IContextSource object.
error also a ContextSource you ll probably need to make sure the header is varied on $request
checkReadOnly( $module)
Check if the DB is read-only for this user.
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
static sanitizeLangCode( $code)
Accepts a language code and ensures it's sane.
processing should stop and the error should be shown to the user * false
msg()
Get a Message object with context set Parameters are the same as wfMessage()
getParamsUsed()
Get the request parameters used in the course of the preceding execute() request.
static instance()
Singleton.
createErrorPrinter()
Create the printer for error output.
getErrorFormatter()
Get the ApiErrorFormatter object associated with current request.
getVal( $name, $default=null)
Get a request value, and register the fact that it was used, for logging.
wfGetLB( $wiki=false)
Get a load balancer 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 text
This manages continuation state.
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
sendCacheHeaders( $isError)
Send caching headers.
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 '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
static $Modules
List of available modules: action name => module class.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
logRequest( $time, $e=null)
Log the preceding request.
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
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness,...
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
handleCORS()
Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.
static handleApiBeforeMainException(Exception $e)
Handle an exception from the ApiBeforeMain hook.
checkConditionalRequestHeaders( $module)
Check selected RFC 7232 precondition headers.
dieWithErrorOrDebug( $msg, $code=null, $data=null, $httpCode=null)
Will only set a warning instead of failing if the global $wgDebugAPI is set to true.
lacksSameOriginSecurity()
Get the security flag for the current request.
wfHostname()
Fetch server name for use in error reporting etc.
wfReadOnly()
Check whether the wiki is in read-only mode.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
const NO_SIZE_CHECK
For addValue() and similar functions, do not check size while adding a value Don't use this unless yo...
Allows to change the fields on the form that will be generated $name
getRequest()
Get the WebRequest object.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
encodeRequestLogValue( $s)
Encode a value in a format suitable for a space-separated log line.
getUser()
Get the User object.
ApiContinuationManager null $mContinuationManager
static matchOrigin( $value, $rules, $exceptions)
Attempt to match an Origin header against a set of rules and a set of exceptions.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
static $mRights
List of user roles that are specifically relevant to the API.
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
This abstract class implements many basic API functions, and is the base of all API classes.
Extension of RawMessage implementing IApiMessage.
getLanguage()
Get the Language object.
static closeElement( $element)
Returns "</$element>".
getModule()
Get the API module object.
An IContextSource implementation which will inherit context from another source but allow individual ...
markParamsUsed( $params)
Mark parameters as used.
setupExecuteAction()
Set up for the execution.
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
This class represents the result of the API operations.
setContinuationManager( $manager)
Set the continuation manager.
This exception will be thrown when dieUsage is called to stop module execution.
bool null $lacksSameOriginSecurity
Cached return value from self::lacksSameOriginSecurity()
getOutput()
Get the OutputPage object.
static rollbackMasterChangesAndLog( $e)
Roll back any open database transactions and log the stack trace of the exception.
getResult()
Get the ApiResult object associated with current request.
getSensitiveParams()
Get the request parameters that should be considered sensitive.
checkMaxLag( $module, $params)
Check the max lag if necessary.
const API_DEFAULT_USELANG
When no uselang parameter is given, this language will be used.
setCacheControl( $directives)
Set directives (key/value pairs) for the Cache-Control header.
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
getAllowedParams()
See ApiBase for description.
setupExternalResponse( $module, $params)
Check POST for external response and setup result printer.
see documentation in includes Linker php for Linker::makeImageLink & $time
createPrinterByName( $format)
Create an instance of an output formatter by its name.
getModuleManager()
Overrides to return this instance's module manager.
when a variable name is used in a it is silently declared as a new masking the global
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
static matchRequestedHeaders( $requestedHeaders)
Attempt to validate the value of Access-Control-Request-Headers against a list of headers that we all...
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
addRequestedFields( $force=[])
Add requested fields to the result.
setContext(IContextSource $context)
Set the IContextSource object.
Interface for MediaWiki-localized exceptions.
canApiHighLimits()
Check whether the current user is allowed to use high limits.
checkBotReadOnly()
Check whether we are readonly for bots.
getContinuationManager()
Get the continuation manager.
This class holds a list of modules and handles instantiation.
checkAsserts( $params)
Check asserts of the user's rights.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
static appendDebugInfoToApiResult(IContextSource $context, ApiResult $result)
Append the debug info to given ApiResult.
wfClearOutputBuffers()
More legible than passing a 'false' parameter to wfResetOutputBuffers():
static wildcardToRegex( $wildcard)
Helper function to convert wildcard string into a regex '*' => '.
checkExecutePermissions( $module)
Check for sufficient permissions to execute.
addDeprecation( $msg, $feature, $data=[])
Add a deprecation warning for this module.
const LIMIT_SML2
Slow query, apihighlimits limit.
dieReadOnly()
Helper function for readonly errors.
__construct( $context=null, $enableWrite=false)
Constructs an instance of ApiMain that utilizes the module and format specified by $request.
reportUnusedParams()
Report unused parameters, so the client gets a hint in case it gave us parameters we don't know,...
execute()
Execute api request.
isWriteMode()
Indicates whether this module requires write mode.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
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 $Formats
List of available formats: format name => format class.
markParamsSensitive( $params)
Mark parameters as sensitive.
setRequestExpectations(ApiBase $module)
Set database connection, query, and write expectations given this module request.
substituteResultWithError( $e)
Replace the result data with the information about an exception.
static getMain()
Static methods.
getCheck( $name)
Get a boolean request value, and register the fact that the parameter was used, for logging.
printResult( $httpCode=0)
Print results using the current printer.
this hook is for auditing only $response
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
static isEveryoneAllowed( $right)
Check if all users may be assumed to have the given permission.
const LIMIT_BIG2
Fast query, apihighlimits limit.
const API_DEFAULT_FORMAT
When no format parameter is given, this format will be used.
const GETHEADER_LIST
Flag to make WebRequest::getHeader return an array of values.
getUpload( $name)
Get a request upload, and register the fact that it was used, for logging.
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 modifiable & $code
modifyHelp(array &$help, array $options, array &$tocData)
Called from ApiHelp before the pieces are joined together and returned.
static getRequestId()
Get the unique request ID.
static singleton( $wiki=false)
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
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
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.
executeAction()
Execute the actual module, without any error handling.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
setupModule()
Set up the module for response.
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 factory( $code)
Get a cached or new language object for a given language code.
handleException(Exception $e)
Handle an exception as an API response.
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
isInternalMode()
Return true if the API was started by other PHP code using FauxRequest.
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
getUserAgent()
Fetches the user agent used for this request.
setCacheMaxAge( $maxage)
Set how long the response should be cached.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
errorMessagesFromException( $e, $type='error')
Create an error message for the given exception.
static getRedactedTraceAsString( $e)
Generate a string representation of an exception's stack trace.
setCacheMode( $mode)
Set the type of caching headers which will be sent.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
getPrinter()
Get the result formatter object.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
the array() calling protocol came about after MediaWiki 1.4rc1.
static getGroupsWithPermission( $role)
Get all the groups who have a given permission.
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
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