Go to the documentation of this file.
23 if ( !defined(
'MEDIAWIKI' ) ) {
24 die(
"This file is part of MediaWiki, it is not a valid entry point" );
32 use Wikimedia\ScopedCallback;
48 $path =
"$wgExtensionDirectory/$ext/extension.json";
69 foreach ( $exts
as $ext ) {
70 $registry->queue(
"$wgExtensionDirectory/$ext/extension.json" );
85 $path =
"$wgStyleDirectory/$skin/skin.json";
101 $registry->queue(
"$wgStyleDirectory/$skin/skin.json" );
112 return array_udiff( $a, $b,
'wfArrayDiff2_cmp' );
121 if ( is_string( $a ) && is_string( $b ) ) {
122 return strcmp( $a, $b );
123 } elseif ( count( $a ) !== count( $b ) ) {
124 return count( $a ) < count( $b ) ? -1 : 1;
128 while (
key( $a ) !==
null &&
key( $b ) !==
null ) {
129 $valueA = current( $a );
130 $valueB = current( $b );
131 $cmp = strcmp( $valueA, $valueB );
151 if ( defined(
'ARRAY_FILTER_USE_BOTH' ) ) {
152 return array_filter( $arr, $callback, ARRAY_FILTER_USE_BOTH );
154 $filteredKeys = array_filter( array_keys( $arr ),
function ( $key )
use ( $arr, $callback ) {
155 return call_user_func( $callback, $arr[$key], $key );
157 return array_intersect_key( $arr, array_fill_keys( $filteredKeys,
true ) );
170 return call_user_func( $callback, $key );
184 if ( is_null( $changed ) ) {
185 throw new MWException(
'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
187 if ( $default[$key] !==
$value ) {
212 $args = func_get_args();
219 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
221 # @todo FIXME: Sometimes get nested arrays for $params,
222 # which leads to E_NOTICEs
223 $spec = implode(
"\t",
$params );
224 $out[$spec] = $originalParams;
227 return array_values(
$out );
240 $keys = array_keys( $array );
241 $offsetByKey = array_flip(
$keys );
243 $offset = $offsetByKey[$after];
246 $before = array_slice( $array, 0, $offset + 1,
true );
247 $after = array_slice( $array, $offset + 1, count( $array ) - $offset,
true );
249 $output = $before + $insert + $after;
263 if ( is_object( $objOrArray ) ) {
264 $objOrArray = get_object_vars( $objOrArray );
266 foreach ( $objOrArray
as $key =>
$value ) {
267 if ( $recursive && ( is_object(
$value ) || is_array(
$value ) ) ) {
290 $max = mt_getrandmax() + 1;
291 $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12,
'.',
'' );
307 for ( $n = 0; $n < $length; $n += 7 ) {
308 $str .= sprintf(
'%07x', mt_rand() & 0xfffffff );
310 return substr( $str, 0, $length );
343 if ( is_null(
$s ) ) {
348 if ( is_null( $needle ) ) {
349 $needle = [
'%3B',
'%40',
'%24',
'%21',
'%2A',
'%28',
'%29',
'%2C',
'%2F',
'%7E' ];
350 if ( !isset( $_SERVER[
'SERVER_SOFTWARE'] ) ||
351 ( strpos( $_SERVER[
'SERVER_SOFTWARE'],
'Microsoft-IIS/7' ) ===
false )
357 $s = urlencode(
$s );
360 [
';',
'@',
'$',
'!',
'*',
'(',
')',
',',
'/',
'~',
':' ],
378 if ( !is_null( $array2 ) ) {
379 $array1 = $array1 + $array2;
383 foreach ( $array1
as $key =>
$value ) {
388 if ( $prefix !==
'' ) {
389 $key = $prefix .
"[$key]";
391 if ( is_array(
$value ) ) {
394 $cgi .= $firstTime ?
'' :
'&';
395 if ( is_array( $v ) ) {
398 $cgi .= urlencode( $key .
"[$k]" ) .
'=' . urlencode( $v );
403 if ( is_object(
$value ) ) {
406 $cgi .= urlencode( $key ) .
'=' . urlencode(
$value );
426 $bits = explode(
'&',
$query );
428 foreach ( $bits
as $bit ) {
432 if ( strpos( $bit,
'=' ) ===
false ) {
439 $key = urldecode( $key );
441 if ( strpos( $key,
'[' ) !==
false ) {
442 $keys = array_reverse( explode(
'[', $key ) );
443 $key = array_pop(
$keys );
446 $k = substr( $k, 0, -1 );
447 $temp = [ $k => $temp ];
449 if ( isset(
$ret[$key] ) ) {
450 $ret[$key] = array_merge(
$ret[$key], $temp );
470 if ( is_array(
$query ) ) {
476 $hashPos = strpos( $url,
'#' );
477 if ( $hashPos !==
false ) {
478 $fragment = substr( $url, $hashPos );
479 $url = substr( $url, 0, $hashPos );
483 if (
false === strpos( $url,
'?' ) ) {
491 if ( $fragment !==
false ) {
532 $defaultProto =
$wgRequest->getProtocol() .
'://';
538 $serverHasProto = $bits && $bits[
'scheme'] !=
'';
541 if ( $serverHasProto ) {
542 $defaultProto = $bits[
'scheme'] .
'://';
551 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
553 if ( substr( $url, 0, 2 ) ==
'//' ) {
554 $url = $defaultProtoWithoutSlashes . $url;
555 } elseif ( substr( $url, 0, 1 ) ==
'/' ) {
558 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
569 if ( $bits && isset( $bits[
'path'] ) ) {
575 } elseif ( substr( $url, 0, 1 ) !=
'/' ) {
576 # URL is a relative path
580 # Expanded URL is not valid.
600 if ( isset( $urlParts[
'delimiter'] ) ) {
601 if ( isset( $urlParts[
'scheme'] ) ) {
602 $result .= $urlParts[
'scheme'];
605 $result .= $urlParts[
'delimiter'];
608 if ( isset( $urlParts[
'host'] ) ) {
609 if ( isset( $urlParts[
'user'] ) ) {
611 if ( isset( $urlParts[
'pass'] ) ) {
612 $result .=
':' . $urlParts[
'pass'];
619 if ( isset( $urlParts[
'port'] ) ) {
620 $result .=
':' . $urlParts[
'port'];
624 if ( isset( $urlParts[
'path'] ) ) {
628 if ( isset( $urlParts[
'query'] ) ) {
629 $result .=
'?' . $urlParts[
'query'];
632 if ( isset( $urlParts[
'fragment'] ) ) {
633 $result .=
'#' . $urlParts[
'fragment'];
652 $inputLength = strlen( $urlPath );
654 while ( $inputOffset < $inputLength ) {
655 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
656 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
657 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
658 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
661 if ( $prefixLengthTwo ==
'./' ) {
662 # Step A, remove leading "./"
664 } elseif ( $prefixLengthThree ==
'../' ) {
665 # Step A, remove leading "../"
667 } elseif ( ( $prefixLengthTwo ==
'/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
668 # Step B, replace leading "/.$" with "/"
670 $urlPath[$inputOffset] =
'/';
671 } elseif ( $prefixLengthThree ==
'/./' ) {
672 # Step B, replace leading "/./" with "/"
674 } elseif ( $prefixLengthThree ==
'/..' && ( $inputOffset + 3 == $inputLength ) ) {
675 # Step C, replace leading "/..$" with "/" and
676 # remove last path component in output
678 $urlPath[$inputOffset] =
'/';
680 } elseif ( $prefixLengthFour ==
'/../' ) {
681 # Step C, replace leading "/../" with "/" and
682 # remove last path component in output
685 } elseif ( ( $prefixLengthOne ==
'.' ) && ( $inputOffset + 1 == $inputLength ) ) {
686 # Step D, remove "^.$"
688 } elseif ( ( $prefixLengthTwo ==
'..' ) && ( $inputOffset + 2 == $inputLength ) ) {
689 # Step D, remove "^..$"
692 # Step E, move leading path segment to output
693 if ( $prefixLengthOne ==
'/' ) {
694 $slashPos = strpos( $urlPath,
'/', $inputOffset + 1 );
696 $slashPos = strpos( $urlPath,
'/', $inputOffset );
698 if ( $slashPos ===
false ) {
699 $output .= substr( $urlPath, $inputOffset );
700 $inputOffset = $inputLength;
702 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
703 $inputOffset += $slashPos - $inputOffset;
708 $slashPos = strrpos(
$output,
'/' );
709 if ( $slashPos ===
false ) {
731 static $withProtRel =
null, $withoutProtRel =
null;
732 $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
733 if ( !is_null( $cachedValue ) ) {
743 if ( $includeProtocolRelative || $protocol !==
'//' ) {
744 $protocols[] = preg_quote( $protocol,
'/' );
748 $retval = implode(
'|', $protocols );
758 if ( $includeProtocolRelative ) {
807 $wasRelative = substr( $url, 0, 2 ) ==
'//';
808 if ( $wasRelative ) {
811 Wikimedia\suppressWarnings();
812 $bits = parse_url( $url );
813 Wikimedia\restoreWarnings();
817 if ( isset( $bits[
'host'] ) && strpos( $bits[
'host'],
'?' ) !==
false ) {
818 list( $host,
$query ) = explode(
'?', $bits[
'host'], 2 );
819 $bits[
'host'] = $host;
821 . ( $bits[
'path'] ??
'' )
822 . ( isset( $bits[
'query'] ) ?
'?' . $bits[
'query'] :
'' );
823 unset( $bits[
'path'] );
828 if ( !$bits || !isset( $bits[
'scheme'] ) ) {
833 $bits[
'scheme'] = strtolower( $bits[
'scheme'] );
837 $bits[
'delimiter'] =
'://';
839 $bits[
'delimiter'] =
':';
842 if ( isset( $bits[
'path'] ) ) {
843 $bits[
'host'] = $bits[
'path'];
851 if ( !isset( $bits[
'host'] ) ) {
855 if ( isset( $bits[
'path'] ) ) {
857 if ( substr( $bits[
'path'], 0, 1 ) !==
'/' ) {
858 $bits[
'path'] =
'/' . $bits[
'path'];
866 if ( $wasRelative ) {
867 $bits[
'scheme'] =
'';
868 $bits[
'delimiter'] =
'//';
884 return preg_replace_callback(
885 '/((?:%[89A-F][0-9A-F])+)/i',
886 'wfExpandIRI_callback',
911 if ( $bits[
'scheme'] ==
'mailto' ) {
912 $mailparts = explode(
'@', $bits[
'host'], 2 );
913 if ( count( $mailparts ) === 2 ) {
914 $domainpart = strtolower( implode(
'.', array_reverse( explode(
'.', $mailparts[1] ) ) ) );
919 $reversedHost = $domainpart .
'@' . $mailparts[0];
921 $reversedHost = strtolower( implode(
'.', array_reverse( explode(
'.', $bits[
'host'] ) ) ) );
925 if ( substr( $reversedHost, -1, 1 ) !==
'.' ) {
926 $reversedHost .=
'.';
929 $prot = $bits[
'scheme'];
930 $index = $prot . $bits[
'delimiter'] . $reversedHost;
932 if ( isset( $bits[
'port'] ) ) {
933 $index .=
':' . $bits[
'port'];
935 if ( isset( $bits[
'path'] ) ) {
936 $index .= $bits[
'path'];
940 if ( isset( $bits[
'query'] ) ) {
941 $index .=
'?' . $bits[
'query'];
943 if ( isset( $bits[
'fragment'] ) ) {
944 $index .=
'#' . $bits[
'fragment'];
948 return [
"http:$index",
"https:$index" ];
962 if ( is_array( $bits ) && isset( $bits[
'host'] ) ) {
963 $host =
'.' . $bits[
'host'];
964 foreach ( (
array)$domains
as $domain ) {
965 $domain =
'.' . $domain;
966 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
1002 $text = trim( $text );
1005 $context[
'seconds_elapsed'] = sprintf(
1007 microtime(
true ) - $_SERVER[
'REQUEST_TIME_FLOAT']
1011 ( memory_get_usage(
true ) / ( 1024 * 1024 ) )
1018 $context[
'private'] = ( $dest ===
false || $dest ===
'private' );
1020 $logger = LoggerFactory::getInstance(
'wfDebug' );
1033 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1034 if ( ( isset( $_GET[
'action'] ) && $_GET[
'action'] ==
'raw' )
1036 isset( $_SERVER[
'SCRIPT_NAME'] )
1037 && substr( $_SERVER[
'SCRIPT_NAME'], -8 ) ==
'load.php'
1053 $mem = memory_get_usage();
1055 $mem = floor( $mem / 1024 ) .
' KiB';
1059 wfDebug(
"Memory usage: $mem\n" );
1090 $text = trim( $text );
1092 $logger = LoggerFactory::getInstance( $logGroup );
1093 $context[
'private'] = ( $dest ===
false || $dest ===
'private' );
1106 $logger = LoggerFactory::getInstance(
'wfLogDBError' );
1107 $logger->error( trim( $text ),
$context );
1123 function wfDeprecated( $function, $version =
false, $component =
false, $callerOffset = 2 ) {
1137 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1150 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1169 $logger = LoggerFactory::getInstance(
'wfErrorLog' );
1171 $logger->info( trim( $text ),
$context );
1186 $profiler->logData();
1190 MediaWikiServices::getInstance()->getStatsdDataFactory(),
1209 $ctx = [
'elapsed' =>
$request->getElapsedTime() ];
1210 if ( !empty( $_SERVER[
'HTTP_X_FORWARDED_FOR'] ) ) {
1211 $ctx[
'forwarded_for'] = $_SERVER[
'HTTP_X_FORWARDED_FOR'];
1213 if ( !empty( $_SERVER[
'HTTP_CLIENT_IP'] ) ) {
1214 $ctx[
'client_ip'] = $_SERVER[
'HTTP_CLIENT_IP'];
1216 if ( !empty( $_SERVER[
'HTTP_FROM'] ) ) {
1217 $ctx[
'from'] = $_SERVER[
'HTTP_FROM'];
1219 if ( isset( $ctx[
'forwarded_for'] ) ||
1220 isset( $ctx[
'client_ip'] ) ||
1221 isset( $ctx[
'from'] ) ) {
1222 $ctx[
'proxy'] = $_SERVER[
'REMOTE_ADDR'];
1229 $ctx[
'anon'] =
$user->isItemLoaded(
'id' ) &&
$user->isAnon();
1234 $ctx[
'url'] = urldecode(
$request->getRequestURL() );
1235 }
catch ( Exception $ignored ) {
1239 $ctx[
'output'] = $profiler->getOutput();
1241 $log = LoggerFactory::getInstance(
'profileoutput' );
1242 $log->info(
"Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1253 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
1254 $stats->updateCount( $key, $count );
1263 return MediaWikiServices::getInstance()->getReadOnlyMode()
1276 return MediaWikiServices::getInstance()->getReadOnlyMode()
1287 return MediaWikiServices::getInstance()->getConfiguredReadOnlyMode()
1307 # Identify which language to get or create a language object for.
1308 # Using is_object here due to Stub objects.
1309 if ( is_object( $langcode ) ) {
1310 # Great, we already have the object (hopefully)!
1316 # $langcode is the language code of the wikis content language object.
1317 # or it is a boolean and value is true
1322 if ( $langcode ===
false || $langcode ===
$wgLang->getCode() ) {
1323 # $langcode is the language code of user language object.
1324 # or it was a boolean and value is false
1329 if ( in_array( $langcode, $validCodes ) ) {
1330 # $langcode corresponds to a valid language.
1334 # $langcode is a string, but not a valid language code; use content language.
1335 wfDebug(
"Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1356 $message =
new Message( $key );
1362 call_user_func_array( [ $message,
'params' ],
$params );
1381 $args = func_get_args();
1382 return call_user_func_array(
'Message::newFallbackSequence',
$args );
1394 # Fix windows line-endings
1395 # Some messages are split with explode("\n", $msg)
1396 $message = str_replace(
"\r",
'', $message );
1400 if ( is_array(
$args[0] ) ) {
1403 $replacementKeys = [];
1404 foreach (
$args as $n => $param ) {
1405 $replacementKeys[
'$' . ( $n + 1 )] = $param;
1407 $message = strtr( $message, $replacementKeys );
1422 if ( is_null( $host ) ) {
1423 # Hostname overriding
1426 # Set static and skip any detection
1431 if ( function_exists(
'posix_uname' ) ) {
1433 $uname = posix_uname();
1437 if ( is_array( $uname ) && isset( $uname[
'nodename'] ) ) {
1438 $host = $uname[
'nodename'];
1439 } elseif ( getenv(
'COMPUTERNAME' ) ) {
1440 # Windows computer name
1441 $host = getenv(
'COMPUTERNAME' );
1443 # This may be a virtual server.
1444 $host = $_SERVER[
'SERVER_NAME'];
1462 $elapsed = ( microtime(
true ) - $_SERVER[
'REQUEST_TIME_FLOAT'] );
1464 $responseTime = round( $elapsed * 1000 );
1465 $reportVars = [
'wgBackendResponseTime' => $responseTime ];
1483 static $disabled =
null;
1485 if ( is_null( $disabled ) ) {
1486 $disabled = !function_exists(
'debug_backtrace' );
1488 wfDebug(
"debug_backtrace() is disabled\n" );
1496 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1498 return array_slice( debug_backtrace(), 1 );
1513 if ( $raw ===
null ) {
1518 $frameFormat =
"%s line %s calls %s()\n";
1519 $traceFormat =
"%s";
1521 $frameFormat =
"<li>%s line %s calls %s()</li>\n";
1522 $traceFormat =
"<ul>\n%s</ul>\n";
1525 $frames = array_map(
function ( $frame )
use ( $frameFormat ) {
1526 $file = !empty( $frame[
'file'] ) ? basename( $frame[
'file'] ) :
'-';
1527 $line = isset( $frame[
'line'] ) ? $frame[
'line'] :
'-';
1528 $call = $frame[
'function'];
1529 if ( !empty( $frame[
'class'] ) ) {
1530 $call = $frame[
'class'] . $frame[
'type'] . $call;
1532 return sprintf( $frameFormat, $file,
$line, $call );
1535 return sprintf( $traceFormat, implode(
'', $frames ) );
1549 if ( isset( $backtrace[$level] ) ) {
1565 if ( !$limit || $limit > count( $trace ) - 1 ) {
1566 $limit = count( $trace ) - 1;
1568 $trace = array_slice( $trace, -$limit - 1, $limit );
1569 return implode(
'/', array_map(
'wfFormatStackFrame', $trace ) );
1579 if ( !isset( $frame[
'function'] ) ) {
1580 return 'NO_FUNCTION_GIVEN';
1582 return isset( $frame[
'class'] ) && isset( $frame[
'type'] ) ?
1583 $frame[
'class'] . $frame[
'type'] . $frame[
'function'] :
1597 return wfMessage(
'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1611 if (
$result ===
null || $force ) {
1613 if ( isset( $_SERVER[
'HTTP_ACCEPT_ENCODING'] ) ) {
1614 # @todo FIXME: We may want to blacklist some broken browsers
1617 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1618 $_SERVER[
'HTTP_ACCEPT_ENCODING'],
1622 if ( isset( $m[2] ) && ( $m[1] ==
'q' ) && ( $m[2] == 0 ) ) {
1626 wfDebug(
"wfClientAcceptsGzip: client accepts gzip.\n" );
1645 static $repl =
null, $repl2 =
null;
1646 if ( $repl ===
null || defined(
'MW_PARSER_TEST' ) || defined(
'MW_PHPUNIT_TEST' ) ) {
1650 '"' =>
'"',
'&' =>
'&',
"'" =>
''',
'<' =>
'<',
1651 '=' =>
'=',
'>' =>
'>',
'[' =>
'[',
']' =>
']',
1652 '{' =>
'{',
'|' =>
'|',
'}' =>
'}',
';' =>
';',
1653 "\n#" =>
"\n#",
"\r#" =>
"\r#",
1654 "\n*" =>
"\n*",
"\r*" =>
"\r*",
1655 "\n:" =>
"\n:",
"\r:" =>
"\r:",
1656 "\n " =>
"\n ",
"\r " =>
"\r ",
1657 "\n\n" =>
"\n ",
"\r\n" =>
" \n",
1658 "\n\r" =>
"\n ",
"\r\r" =>
"\r ",
1659 "\n\t" =>
"\n	",
"\r\t" =>
"\r	",
1660 "\n----" =>
"\n----",
"\r----" =>
"\r----",
1661 '__' =>
'__',
'://' =>
'://',
1666 foreach ( $magicLinks
as $magic ) {
1667 $repl[
"$magic "] =
"$magic ";
1668 $repl[
"$magic\t"] =
"$magic	";
1669 $repl[
"$magic\r"] =
"$magic ";
1670 $repl[
"$magic\n"] =
"$magic ";
1671 $repl[
"$magic\f"] =
"$magic";
1678 if ( substr( $prot, -1 ) ===
':' ) {
1679 $repl2[] = preg_quote( substr( $prot, 0, -1 ),
'/' );
1682 $repl2 = $repl2 ?
'/\b(' . implode(
'|', $repl2 ) .
'):/i' :
'/^(?!)/';
1684 $text = substr( strtr(
"\n$text", $repl ), 1 );
1685 $text = preg_replace( $repl2,
'$1:', $text );
1701 if ( !is_null(
$source ) || $force ) {
1717 $temp = (bool)( $dest & $bit );
1718 if ( !is_null( $state ) ) {
1736 $s = str_replace(
"\n",
"<br />\n", var_export( $var,
true ) .
"\n" );
1737 if ( headers_sent() || !isset(
$wgOut ) || !is_object(
$wgOut ) ) {
1756 $wgOut->sendCacheControl();
1760 header(
'Content-type: text/html; charset=utf-8' );
1761 print '<!DOCTYPE html>' .
1762 '<html><head><title>' .
1763 htmlspecialchars( $label ) .
1764 '</title></head><body><h1>' .
1765 htmlspecialchars( $label ) .
1767 nl2br( htmlspecialchars( $desc ) ) .
1768 "</p></body></html>\n";
1789 if ( $resetGzipEncoding ) {
1795 while (
$status = ob_get_status() ) {
1796 if ( isset(
$status[
'flags'] ) ) {
1797 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE;
1798 $deleteable = (
$status[
'flags'] & $flags ) === $flags;
1799 } elseif ( isset(
$status[
'del'] ) ) {
1803 $deleteable =
$status[
'type'] !== 0;
1805 if ( !$deleteable ) {
1810 if (
$status[
'name'] ===
'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1814 if ( !ob_end_clean() ) {
1819 if ( $resetGzipEncoding ) {
1820 if (
$status[
'name'] ==
'ob_gzhandler' ) {
1823 header_remove(
'Content-Encoding' );
1855 # No arg means accept anything (per HTTP spec)
1857 return [ $def => 1.0 ];
1862 $parts = explode(
',', $accept );
1864 foreach ( $parts
as $part ) {
1865 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1866 $values = explode(
';', trim( $part ) );
1868 if ( count( $values ) == 1 ) {
1869 $prefs[$values[0]] = 1.0;
1870 } elseif ( preg_match(
'/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1871 $prefs[$values[0]] = floatval( $match[1] );
1891 if ( array_key_exists(
$type, $avail ) ) {
1894 $mainType = explode(
'/',
$type )[0];
1895 if ( array_key_exists(
"$mainType/*", $avail ) ) {
1896 return "$mainType/*";
1897 } elseif ( array_key_exists(
'*/*', $avail ) ) {
1921 foreach ( array_keys( $sprefs )
as $type ) {
1922 $subType = explode(
'/',
$type )[1];
1923 if ( $subType !=
'*' ) {
1926 $combine[
$type] = $sprefs[
$type] * $cprefs[$ckey];
1931 foreach ( array_keys( $cprefs )
as $type ) {
1932 $subType = explode(
'/',
$type )[1];
1933 if ( $subType !=
'*' && !array_key_exists(
$type, $sprefs ) ) {
1936 $combine[
$type] = $sprefs[$skey] * $cprefs[
$type];
1944 foreach ( array_keys( $combine )
as $type ) {
1945 if ( $combine[
$type] > $bestq ) {
1947 $bestq = $combine[
$type];
1961 Wikimedia\suppressWarnings( $end );
1969 Wikimedia\restoreWarnings();
1981 $ret = MWTimestamp::convert( $outputtype, $ts );
1982 if (
$ret ===
false ) {
1983 wfDebug(
"wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1997 if ( is_null( $ts ) ) {
2011 return MWTimestamp::now( TS_MW );
2020 static $isWindows =
null;
2021 if ( $isWindows ===
null ) {
2022 $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) ===
'WIN';
2033 return defined(
'HHVM_VERSION' );
2043 return PHP_SAPI ===
'cli' || PHP_SAPI ===
'phpdbg';
2080 throw new MWException( __FUNCTION__ .
" given storage path '$dir'." );
2083 if ( !is_null( $caller ) ) {
2084 wfDebug(
"$caller: called wfMkdirParents($dir)\n" );
2087 if ( strval( $dir ) ===
'' || is_dir( $dir ) ) {
2091 $dir = str_replace( [
'\\',
'/' ], DIRECTORY_SEPARATOR, $dir );
2093 if ( is_null( $mode ) ) {
2098 Wikimedia\suppressWarnings();
2099 $ok = mkdir( $dir, $mode,
true );
2100 Wikimedia\restoreWarnings();
2104 if ( is_dir( $dir ) ) {
2109 wfLogWarning( sprintf(
"failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2120 wfDebug( __FUNCTION__ .
"( $dir )\n" );
2122 if ( is_dir( $dir ) ) {
2123 $objects = scandir( $dir );
2124 foreach ( $objects
as $object ) {
2125 if ( $object !=
"." && $object !=
".." ) {
2126 if ( filetype( $dir .
'/' . $object ) ==
"dir" ) {
2129 unlink( $dir .
'/' . $object );
2145 $ret = sprintf(
"%.${acc}f", $nr );
2146 return $round ? round(
$ret, $acc ) .
'%' :
"$ret%";
2189 $val = strtolower( $val );
2194 || preg_match(
"/^\s*[+-]?0*[1-9]/", $val );
2210 $args = func_get_args();
2224 return Shell::isDisabled() ?
'disabled' :
false;
2253 if ( Shell::isDisabled() ) {
2256 return 'Unable to run external programs, proc_open() is disabled.';
2259 if ( is_array( $cmd ) ) {
2260 $cmd = Shell::escape( $cmd );
2263 $includeStderr = isset(
$options[
'duplicateStderr'] ) &&
$options[
'duplicateStderr'];
2267 $result = Shell::command( [] )
2268 ->unsafeParams( (
array)$cmd )
2269 ->environment( $environ )
2271 ->includeStderr( $includeStderr )
2272 ->profileMethod( $profileMethod )
2274 ->restrict( Shell::RESTRICT_NONE )
2305 [
'duplicateStderr' =>
true,
'profileMethod' =>
wfGetCaller() ] );
2340 if ( isset(
$options[
'wrapper'] ) ) {
2345 return Shell::escape( array_merge( $cmd, $parameters ) );
2362 # This check may also protect against code injection in
2363 # case of broken installations.
2364 Wikimedia\suppressWarnings();
2366 Wikimedia\restoreWarnings();
2368 if ( !$haveDiff3 ) {
2369 wfDebug(
"diff3 not found\n" );
2373 # Make temporary files
2375 $oldtextFile = fopen( $oldtextName = tempnam( $td,
'merge-old-' ),
'w' );
2376 $mytextFile = fopen( $mytextName = tempnam( $td,
'merge-mine-' ),
'w' );
2377 $yourtextFile = fopen( $yourtextName = tempnam( $td,
'merge-your-' ),
'w' );
2379 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2380 # a newline character. To avoid this, we normalize the trailing whitespace before
2381 # creating the diff.
2383 fwrite( $oldtextFile, rtrim( $old ) .
"\n" );
2384 fclose( $oldtextFile );
2385 fwrite( $mytextFile, rtrim( $mine ) .
"\n" );
2386 fclose( $mytextFile );
2387 fwrite( $yourtextFile, rtrim( $yours ) .
"\n" );
2388 fclose( $yourtextFile );
2390 # Check for a conflict
2391 $cmd = Shell::escape(
$wgDiff3,
'-a',
'--overlap-only', $mytextName,
2392 $oldtextName, $yourtextName );
2393 $handle = popen( $cmd,
'r' );
2395 $mergeAttemptResult =
'';
2397 $data = fread( $handle, 8192 );
2398 if ( strlen( $data ) == 0 ) {
2401 $mergeAttemptResult .= $data;
2405 $conflict = $mergeAttemptResult !==
'';
2408 $cmd = Shell::escape(
$wgDiff3,
'-a',
'-e',
'--merge', $mytextName,
2409 $oldtextName, $yourtextName );
2410 $handle = popen( $cmd,
'r' );
2413 $data = fread( $handle, 8192 );
2414 if ( strlen( $data ) == 0 ) {
2420 unlink( $mytextName );
2421 unlink( $oldtextName );
2422 unlink( $yourtextName );
2424 if (
$result ===
'' && $old !==
'' && !$conflict ) {
2425 wfDebug(
"Unexpected null result from diff3. Command: $cmd\n" );
2443 if ( $before == $after ) {
2448 Wikimedia\suppressWarnings();
2450 Wikimedia\restoreWarnings();
2452 # This check may also protect against code injection in
2453 # case of broken installations.
2455 wfDebug(
"diff executable not found\n" );
2456 $diffs =
new Diff( explode(
"\n", $before ), explode(
"\n", $after ) );
2458 return $format->format( $diffs );
2461 # Make temporary files
2463 $oldtextFile = fopen( $oldtextName = tempnam( $td,
'merge-old-' ),
'w' );
2464 $newtextFile = fopen( $newtextName = tempnam( $td,
'merge-your-' ),
'w' );
2466 fwrite( $oldtextFile, $before );
2467 fclose( $oldtextFile );
2468 fwrite( $newtextFile, $after );
2469 fclose( $newtextFile );
2472 $cmd =
"$wgDiff " .
$params .
' ' . Shell::escape( $oldtextName, $newtextName );
2474 $h = popen( $cmd,
'r' );
2476 unlink( $oldtextName );
2477 unlink( $newtextName );
2478 throw new Exception( __METHOD__ .
'(): popen() failed' );
2484 $data = fread( $h, 8192 );
2485 if ( strlen( $data ) == 0 ) {
2493 unlink( $oldtextName );
2494 unlink( $newtextName );
2497 $diff_lines = explode(
"\n", $diff );
2498 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0],
'---' ) === 0 ) {
2499 unset( $diff_lines[0] );
2501 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1],
'+++' ) === 0 ) {
2502 unset( $diff_lines[1] );
2505 $diff = implode(
"\n", $diff_lines );
2530 $php_ver = PHP_VERSION;
2532 if ( version_compare( $php_ver, (
string)$req_ver,
'<' ) ) {
2533 throw new MWException(
"PHP $req_ver required--this is only $php_ver" );
2562 if ( version_compare(
$wgVersion, (
string)$req_ver,
'<' ) ) {
2563 throw new MWException(
"MediaWiki $req_ver required--this is only $wgVersion" );
2580 if ( $suffix ==
'' ) {
2583 $encSuffix =
'(?:' . preg_quote( $suffix,
'#' ) .
')?';
2587 if ( preg_match(
"#([^/\\\\]*?){$encSuffix}[/\\\\]*$#",
$path,
$matches ) ) {
2605 $path = str_replace(
'/', DIRECTORY_SEPARATOR,
$path );
2606 $from = str_replace(
'/', DIRECTORY_SEPARATOR, $from );
2610 $from = rtrim( $from, DIRECTORY_SEPARATOR );
2612 $pieces = explode( DIRECTORY_SEPARATOR, dirname(
$path ) );
2613 $against = explode( DIRECTORY_SEPARATOR, $from );
2615 if ( $pieces[0] !== $against[0] ) {
2622 while ( count( $pieces ) && count( $against )
2623 && $pieces[0] == $against[0] ) {
2624 array_shift( $pieces );
2625 array_shift( $against );
2629 while ( count( $against ) ) {
2630 array_unshift( $pieces,
'..' );
2631 array_shift( $against );
2636 return implode( DIRECTORY_SEPARATOR, $pieces );
2647 $session = SessionManager::getGlobalSession();
2648 $delay = $session->delaySave();
2650 $session->resetId();
2654 if ( session_id() !== $session->getId() ) {
2658 ScopedCallback::consume( $delay );
2674 session_id( $sessionId );
2677 $session = SessionManager::getGlobalSession();
2678 $session->persist();
2680 if ( session_id() !== $session->getId() ) {
2681 session_id( $session->getId() );
2683 Wikimedia\quietCall(
'session_start' );
2695 $file =
"$IP/serialized/$name";
2696 if ( file_exists( $file ) ) {
2697 $blob = file_get_contents( $file );
2713 return call_user_func_array(
2730 $args = array_slice( func_get_args(), 2 );
2731 $keyspace = $prefix ?
"$db-$prefix" : $db;
2732 return call_user_func_array(
2734 [ $keyspace,
$args ]
2751 return call_user_func_array(
2766 return "$wgDBname-$wgDBprefix";
2780 $bits = explode(
'-', $wiki, 2 );
2781 if ( count( $bits ) < 2 ) {
2812 function wfGetDB( $db, $groups = [], $wiki =
false ) {
2813 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2826 if ( $wiki ===
false ) {
2827 return MediaWikiServices::getInstance()->getDBLoadBalancer();
2829 $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2830 return $factory->getMainLB( $wiki );
2842 return MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2892 if ( $script ===
'index' ) {
2894 } elseif ( $script ===
'load' ) {
2897 return "{$wgScriptPath}/{$script}.php";
2907 if ( isset( $_SERVER[
'SCRIPT_NAME'] ) ) {
2918 return $_SERVER[
'SCRIPT_NAME'];
2920 return $_SERVER[
'URL'];
2932 return $value ?
'true' :
'false';
2967 $ifWritesSince =
null, $wiki =
false, $cluster =
false, $timeout =
null
2969 if ( $timeout ===
null ) {
2970 $timeout =
wfIsCLI() ? 60 : 10;
2973 if ( $cluster ===
'*' ) {
2976 } elseif ( $wiki ===
false ) {
2981 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2982 $lbFactory->waitForReplication( [
2984 'cluster' => $cluster,
2985 'timeout' => $timeout,
2987 'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince :
null
3006 for ( $i = $seconds; $i >= 0; $i-- ) {
3007 if ( $i != $seconds ) {
3008 echo str_repeat(
"\x08", strlen( $i + 1 ) );
3030 $name = preg_replace(
3048 if ( $memlimit != -1 ) {
3050 if ( $conflimit == -1 ) {
3051 wfDebug(
"Removing PHP's memory limit\n" );
3052 Wikimedia\suppressWarnings();
3053 ini_set(
'memory_limit', $conflimit );
3054 Wikimedia\restoreWarnings();
3056 } elseif ( $conflimit > $memlimit ) {
3057 wfDebug(
"Raising PHP's memory limit to $conflimit bytes\n" );
3058 Wikimedia\suppressWarnings();
3059 ini_set(
'memory_limit', $conflimit );
3060 Wikimedia\restoreWarnings();
3076 $timeLimit = ini_get(
'max_execution_time' );
3082 ignore_user_abort(
true );
3095 $string = trim( $string );
3096 if ( $string ===
'' ) {
3099 $last = $string[strlen( $string ) - 1];
3100 $val = intval( $string );
3203 if ( $length !==
false ) {
3204 $realLen = strlen( $data );
3205 if ( $realLen < $length ) {
3206 throw new MWException(
"Tried to use wfUnpack on a "
3207 .
"string of length $realLen, but needed one "
3208 .
"of at least length $length."
3213 Wikimedia\suppressWarnings();
3214 $result = unpack( $format, $data );
3215 Wikimedia\restoreWarnings();
3219 throw new MWException(
"unpack could not unpack binary data" );
3239 # Handle redirects; callers almost always hit wfFindFile() anyway,
3240 # so just use that method because it has a fast process cache.
3242 $name = $file ? $file->getTitle()->getDBkey() :
$name;
3244 # Run the extension hook
3252 'bad-image-list', ( $blacklist ===
null ) ?
'default' : md5( $blacklist )
3254 $badImages =
$cache->get( $key );
3256 if ( $badImages ===
false ) {
3257 if ( $blacklist ===
null ) {
3258 $blacklist =
wfMessage(
'bad_image_list' )->inContentLanguage()->plain();
3260 # Build the list now
3262 $lines = explode(
"\n", $blacklist );
3265 if ( substr(
$line, 0, 1 ) !==
'*' ) {
3271 if ( !preg_match_all(
'/\[\[:?(.*?)\]\]/',
$line, $m ) ) {
3276 $imageDBkey =
false;
3277 foreach ( $m[1]
as $i => $titleText ) {
3279 if ( !is_null(
$title ) ) {
3281 $imageDBkey =
$title->getDBkey();
3283 $exceptions[
$title->getPrefixedDBkey()] =
true;
3288 if ( $imageDBkey !==
false ) {
3289 $badImages[$imageDBkey] = $exceptions;
3292 $cache->set( $key, $badImages, 60 );
3295 $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() :
false;
3296 $bad = isset( $badImages[
$name] ) && !isset( $badImages[
$name][$contextKey] );
3310 Hooks::run(
'CanIPUseHTTPS', [ $ip, &$canDo ] );
3323 $infinityValues = [
'infinite',
'indefinite',
'infinity',
'never' ];
3324 return in_array( $str, $infinityValues );
3344 $multipliers = [ 1 ];
3348 $multipliers[] = 1.5;
3358 if ( isset(
$params[
'page'] ) ) {
3359 $basicParams[
'page'] =
$params[
'page'];
3365 foreach ( $multipliers
as $multiplier ) {
3366 $thumbLimits = array_merge( $thumbLimits, array_map(
3367 function ( $width )
use ( $multiplier ) {
3368 return round( $width * $multiplier );
3371 $imageLimits = array_merge( $imageLimits, array_map(
3372 function ( $pair )
use ( $multiplier ) {
3374 round( $pair[0] * $multiplier ),
3375 round( $pair[1] * $multiplier ),
3382 if ( in_array(
$params[
'width'], $thumbLimits ) ) {
3383 $normalParams = $basicParams + [
'width' =>
$params[
'width'] ];
3385 $handler->normaliseParams( $file, $normalParams );
3389 foreach ( $imageLimits
as $pair ) {
3390 $normalParams = $basicParams + [
'width' => $pair[0],
'height' => $pair[1] ];
3393 $handler->normaliseParams( $file, $normalParams );
3395 if ( $normalParams[
'width'] ==
$params[
'width'] ) {
3407 if ( !isset( $normalParams[$key] ) || $normalParams[$key] !=
$value ) {
3429 foreach ( $baseArray
as $name => &$groupVal ) {
3430 if ( isset( $newValues[
$name] ) ) {
3431 $groupVal += $newValues[
$name];
3435 $baseArray += $newValues;
3449 if ( !function_exists(
'getrusage' ) ) {
3451 } elseif ( defined(
'HHVM_VERSION' ) && PHP_OS ===
'Linux' ) {
3452 return getrusage( 2 );
3454 return getrusage( 0 );
wfMessage( $key)
This is the function for getting translated interface messages.
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
$wgPhpCli
Executable path of the PHP cli binary.
wfUseMW( $req_ver)
This function works like "use VERSION" in Perl except it checks the version of MediaWiki,...
wfArrayInsertAfter(array $array, array $insert, $after)
Insert array into another array after the specified KEY
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 modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
wfPercent( $nr, $acc=2, $round=true)
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
$wgThumbLimits
Adjust thumbnails on image pages according to a user setting.
wfBCP47( $code)
Get the normalised IETF language tag See unit test for examples.
static singleton()
Get a RepoGroup instance.
wfCanIPUseHTTPS( $ip)
Determine whether the client at a given source IP is likely to be able to access the wiki via HTTPS.
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
static getLocalClusterInstance()
Get the main cluster-local cache object.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfDiff( $before, $after, $params='-u')
Returns unified plain-text diff of two texts.
$wgResponsiveImages
Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
wfSetupSession( $sessionId=false)
Initialise php session.
$wgDebugRawPage
If true, log debugging data from action=raw and load.php.
wfThumbIsStandard(File $file, array $params)
Returns true if these thumbnail parameters match one that MediaWiki requests from file description pa...
$wgTmpDirectory
The local filesystem path to a temporary directory.
wfArrayPlus2d(array $baseArray, array $newValues)
Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
static instance()
Singleton.
the array() calling protocol came about after MediaWiki 1.4rc1.
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
wfArrayFilter(array $arr, callable $callback)
Like array_filter with ARRAY_FILTER_USE_BOTH, but works pre-5.6.
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 $output
$wgDiff3
Path to the GNU diff3 utility.
wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult=null)
wfMerge attempts to merge differences between three texts.
wfDebugBacktrace( $limit=0)
Safety wrapper for debug_backtrace().
wfSetVar(&$dest, $source, $force=false)
Sets dest to source and returns the original value of dest If source is NULL, it just returns the val...
wfGetLB( $wiki=false)
Get a load balancer object.
wfFormatStackFrame( $frame)
Return a string representation of frame.
wfRemoveDotSegments( $urlPath)
Remove all dot-segments in the provided URL path.
$wgScript
The URL path to index.php.
wfSetBit(&$dest, $bit, $state=true)
As for wfSetVar except setting a bit.
wfNegotiateType( $cprefs, $sprefs)
Returns the 'best' match between a client's requested internet media types and the server's list of a...
wfMakeUrlIndexes( $url)
Make URL indexes, appropriate for the el_index field of externallinks.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$wgVersion
MediaWiki version number.
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
wfUnpack( $format, $data, $length=false)
Wrapper around php's unpack.
wfConfiguredReadOnlyReason()
Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
$wgShowHostnames
Expose backend server host names through the API and various HTML comments.
wfObjectToArray( $objOrArray, $recursive=true)
Recursively converts the parameter (an object) to an array with the same data.
wfSuppressWarnings( $end=false)
Reference-counted warning suppression.
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness,...
wfArrayDiff2_cmp( $a, $b)
wfGetScriptUrl()
Get the script URL.
$wgMessageCacheType
The cache type for storing the contents of the MediaWiki namespace.
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
Stub profiler that does nothing.
$wgDiff
Path to the GNU diff utility.
wfBaseName( $path, $suffix='')
Return the final portion of a pathname.
wfQueriesMustScale()
Should low-performance queries be disabled?
unserialize( $serialized)
wfHostname()
Fetch server name for use in error reporting etc.
wfReadOnly()
Check whether the wiki is in read-only mode.
wfMsgReplaceArgs( $message, $args)
Replace message parameter keys on the given formatted output.
wfUsePHP( $req_ver)
This function works like "use VERSION" in Perl, the program will die with a backtrace if the current ...
wfSplitWikiID( $wiki)
Split a wiki ID into DB name and table prefix.
wfLogWarning( $msg, $callerOffset=1, $level=E_USER_WARNING)
Send a warning as a PHP error and the debug log.
wfStringToBool( $val)
Convert string value to boolean, when the following are interpreted as true:
wfArrayFilterByKey(array $arr, callable $callback)
Like array_filter with ARRAY_FILTER_USE_KEY, but works pre-5.6.
$wgTransactionalTimeLimit
The minimum amount of time that MediaWiki needs for "slow" write request, particularly ones with mult...
$wgDebugLogPrefix
Prefix for debug log lines.
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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
wfExpandIRI( $url)
Take a URL, make sure it's expanded to fully qualified, and replace any encoded non-ASCII Unicode cha...
wfMessageFallback()
This function accepts multiple message keys and returns a message instance for the first message whic...
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
$wgDBprefix
Table name prefix.
wfShellWikiCmd( $script, array $parameters=[], array $options=[])
Generate a shell-escaped command line string to run a MediaWiki cli script.
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
wfBoolToStr( $value)
Convenience function converts boolean values into "true" or "false" (string) values.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
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 key
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Implements some public methods and some protected utility functions which are required by multiple ch...
wfGetMainCache()
Get the main cache object.
wfStripIllegalFilenameChars( $name)
Replace all invalid characters with '-'.
wfMemcKey()
Make a cache key for the local wiki.
wfGetRusage()
Get system resource usage of current request context.
mimeTypeMatch( $type, $avail)
Checks if a given MIME type matches any of the keys in the given array.
wfGlobalCacheKey()
Make a cache key with database-agnostic prefix.
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 $wgDBname
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
static fetchLanguageNames( $inLanguage=null, $include='mw')
Get an array of language names, indexed by code.
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
wfArrayDiff2( $a, $b)
Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
wfIncrStats( $key, $count=1)
Increment a statistics counter.
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
wfTransactionalTimeLimit()
Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfShellExecDisabled()
Check if wfShellExec() is effectively disabled via php.ini config.
wfUrlProtocolsWithoutProtRel()
Like wfUrlProtocols(), but excludes '//' from the protocol list.
global $wgCommandLineMode
$wgDebugLogGroups
Map of string log group names to log destinations.
$wgLoadScript
The URL path to load.php.
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
static getInstance( $id)
Get a cached instance of the specified type of cache object.
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
wfLoadSkins(array $skins)
Load multiple skins at once.
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
$wgParserCacheType
The cache type for storing article HTML.
namespace and then decline to actually register it file or subcat img or subcat $title
static deprecated( $function, $version=false, $component=false, $callerOffset=2)
Show a warning that $function is deprecated.
wfGetCache( $cacheType)
Get a specific cache object.
$wgEnableMagicLinks
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links.
when a variable name is used in a it is silently declared as a new masking the global
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfMemoryLimit()
Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit.
wfForeignMemcKey( $db, $prefix)
Make a cache key for a foreign DB.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfAcceptToPrefs( $accept, $def=' */*')
Converts an Accept-* header into an array mapping string values to quality factors.
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
wfExpandIRI_callback( $matches)
Private callback for wfExpandIRI.
$wgCanonicalServer
Canonical URL of the server, to use in IRC feeds and notification e-mails.
$wgMemoryLimit
The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP's memory limit i...
wfIsDebugRawPage()
Returns true if debug logging should be suppressed if $wgDebugRawPage = false.
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
$wgDebugTimestamps
Prefix debug messages with relative timestamp.
wfErrorLog( $text, $file, array $context=[])
Log to a file without getting "file size exceeded" signals.
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
wfIsBadImage( $name, $contextTitle=false, $blacklist=null)
Determine if an image exists on the 'bad image list'.
wfLoadExtensions(array $exts)
Load multiple extensions at once.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
wfClearOutputBuffers()
More legible than passing a 'false' parameter to wfResetOutputBuffers():
wfClientAcceptsGzip( $force=false)
Whether the client accept gzip encoding.
$wgUrlProtocols
URL schemes that should be recognized as valid by wfParseUrl().
$wgExtensionDirectory
Filesystem extensions directory.
wfIsCLI()
Check if we are running from the commandline.
wfIsWindows()
Check if the operating system is Windows.
$wgServer
URL of the server.
wfEscapeShellArg()
Version of escapeshellarg() that works better on Windows.
$wgLanguageCode
Site language code.
wfIsInfinity( $str)
Determine input string is represents as infinity.
wfDebugMem( $exact=false)
Send a line giving PHP memory usage.
wfInitShellLocale()
Formerly set the locale for locale-sensitive operations.
$wgDirectoryMode
Default value for chmoding of new directories.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
static makeVariablesScript( $data)
wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed)
Appends to second array if $value differs from that in $default.
$wgDisableOutputCompression
Disable output compression (enabled by default if zlib is available)
wfVarDump( $var)
A wrapper around the PHP function var_export().
$wgIllegalFileChars
Additional characters that are not allowed in filenames.
wfGetParserCacheStorage()
Get the cache object used by the parser cache.
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
wfGetNull()
Get a platform-independent path to the null file, e.g.
static getUsableTempDirectory()
static getMain()
Get the RequestContext object associated with the main request.
wfGetLBFactory()
Get the load balancer factory object.
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
$wgOverrideHostname
Override server hostname detection with a hardcoded value.
wfFindFile( $title, $options=[])
Find a file.
wfReportTime()
Returns a script tag that stores the amount of time it took MediaWiki to handle the request in millis...
wfGetAllCallers( $limit=3)
Return a string consisting of callers in the stack.
wfLoadExtension( $ext, $path=null)
Load an extension.
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 $skin
wfRunHooks( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in $wgHooks.
wfGetMessageCacheStorage()
Get the cache object used by the message cache.
wfLoadSkin( $skin, $path=null)
Load a skin.
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
$wgImageLimits
Limit images on image description pages to a user-selectable limit.
Allows to change the fields on the form that will be generated $name
wfRandom()
Get a random decimal value between 0 and 1, in a way not likely to give duplicate values for any real...
wfTempDir()
Tries to get the system directory for temporary files.
$wgMiserMode
Disable database-intensive features.
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
wfReadOnlyReason()
Check if the site is in read-only mode and return the message if so.
wfMatchesDomainList( $url, $domains)
Check whether a given URL has a domain that occurs in a given set of domains.
static header( $code)
Output an HTTP status code header.
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
wfGetPrecompiledData( $name)
Get an object from the precompiled serialized directory.
wfRecursiveRemoveDir( $dir)
Remove a directory and all its content.
$wgHttpsPort
Port where you have HTTPS running Supports HTTPS on non-standard ports.
CACHE_MEMCACHED $wgMainCacheType
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 bcp47( $code)
Get the normalised IETF language tag See unit test for examples.
The Message class provides methods which fulfil two basic services:
wfBacktrace( $raw=null)
Get a debug backtrace as a string.
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
wfAssembleUrl( $urlParts)
This function will reassemble a URL parsed with wfParseURL.
wfRelativePath( $path, $from)
Generate a relative path name to the given file.
static factory( $code)
Get a cached or new language object for a given language code.
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
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 legalChars()
Get a regex character class describing the legal characters in a link.
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 $request
if(! $wgDBerrorLogTZ) $wgRequest
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 warning( $msg, $callerOffset=1, $level=E_USER_NOTICE, $log='auto')
Adds a warning entry to the log.
getHandler()
Get a MediaHandler instance for this file.
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
wfIsHHVM()
Check if we are running under HHVM.
$wgScriptPath
The path we should point to.
wfLocalFile( $title)
Get an object referring to a locally registered file.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
wfShowingResults( $offset, $limit)
wfResetSessionID()
Reset the session id.
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 incomplete not yet checked for validity & $retval
wfGetCaller( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
$wgStyleDirectory
Filesystem stylesheets directory.
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
wfLogDBError( $text, array $context=[])
Log for database errors.
$wgInternalServer
Internal server name as known to CDN, if different.
wfCountDown( $seconds)
Count down from $seconds to zero on the terminal, with a one-second pause between showing each number...
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
wfShellExecWithStderr( $cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
static getLocalServerInstance( $fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
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
Class representing a 'diff' between two sequences of strings.
wfShellExec( $cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.