MediaWiki  master
GlobalFunctions.php File Reference

Global functions used everywhere. More...

Go to the source code of this file.

Functions

 mimeTypeMatch ( $type, $avail)
 Checks if a given MIME type matches any of the keys in the given array. More...
 
 wfAcceptToPrefs ( $accept, $def=' */*')
 Converts an Accept-* header into an array mapping string values to quality factors. More...
 
 wfAppendQuery ( $url, $query)
 Append a query string to an existing URL, which may or may not already have query string parameters already. More...
 
 wfAppendToArrayIfNotDefault ( $key, $value, $default, &$changed)
 Appends to second array if $value differs from that in $default. More...
 
 wfArrayDiff2 ( $a, $b)
 Like array_diff( $a, $b ) except that it works with two-dimensional arrays. More...
 
 wfArrayDiff2_cmp ( $a, $b)
 
 wfArrayFilter (array $arr, callable $callback)
 
 wfArrayFilterByKey (array $arr, callable $callback)
 
 wfArrayInsertAfter (array $array, array $insert, $after)
 Insert array into another array after the specified KEY More...
 
 wfArrayPlus2d (array $baseArray, array $newValues)
 Merges two (possibly) 2 dimensional arrays into the target array ($baseArray). More...
 
 wfArrayToCgi ( $array1, $array2=null, $prefix='')
 This function takes one or two arrays as input, and returns a CGI-style string, e.g. More...
 
 wfAssembleUrl ( $urlParts)
 This function will reassemble a URL parsed with wfParseURL. More...
 
 wfBacktrace ( $raw=null)
 Get a debug backtrace as a string. More...
 
 wfBaseName ( $path, $suffix='')
 Return the final portion of a pathname. More...
 
 wfBCP47 ( $code)
 Get the normalised IETF language tag See unit test for examples. More...
 
 wfBoolToStr ( $value)
 Convenience function converts boolean values into "true" or "false" (string) values. More...
 
 wfCanIPUseHTTPS ( $ip)
 Determine whether the client at a given source IP is likely to be able to access the wiki via HTTPS. More...
 
 wfCgiToArray ( $query)
 This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns the same string in array form. More...
 
 wfClearOutputBuffers ()
 More legible than passing a 'false' parameter to wfResetOutputBuffers(): More...
 
 wfClientAcceptsGzip ( $force=false)
 Whether the client accept gzip encoding. More...
 
 wfConfiguredReadOnlyReason ()
 Get the value of $wgReadOnly or the contents of $wgReadOnlyFile. More...
 
 wfCountDown ( $seconds)
 Count down from $seconds to zero on the terminal, with a one-second pause between showing each number. More...
 
 wfDebug ( $text, $dest='all', array $context=[])
 Sends a line to the debug log if enabled or, optionally, to a comment in output. More...
 
 wfDebugBacktrace ( $limit=0)
 Safety wrapper for debug_backtrace(). More...
 
 wfDebugLog ( $logGroup, $text, $dest='all', array $context=[])
 Send a line to a supplementary debug log file, if configured, or main debug log if not. More...
 
 wfDebugMem ( $exact=false)
 Send a line giving PHP memory usage. More...
 
 wfDeprecated ( $function, $version=false, $component=false, $callerOffset=2)
 Throws a warning that $function is deprecated. More...
 
 wfDiff ( $before, $after, $params='-u')
 Returns unified plain-text diff of two texts. More...
 
 wfEscapeShellArg (... $args)
 Version of escapeshellarg() that works better on Windows. More...
 
 wfEscapeWikiText ( $text)
 Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc. More...
 
 wfExpandIRI ( $url)
 Take a URL, make sure it's expanded to fully qualified, and replace any encoded non-ASCII Unicode characters with their UTF-8 original forms for more compact display and legibility for local audiences. More...
 
 wfExpandUrl ( $url, $defaultProto=PROTO_CURRENT)
 Expand a potentially local URL to a fully-qualified URL. More...
 
 wfFindFile ( $title, $options=[])
 Find a file. More...
 
 wfForeignMemcKey ( $db, $prefix,... $args)
 Make a cache key for a foreign DB. More...
 
 wfFormatStackFrame ( $frame)
 Return a string representation of frame. More...
 
 wfGetAllCallers ( $limit=3)
 Return a string consisting of callers in the stack. More...
 
 wfGetCache ( $cacheType)
 Get a specific cache object. More...
 
 wfGetCaller ( $level=2)
 Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. More...
 
 wfGetDB ( $db, $groups=[], $wiki=false)
 Get a Database object. More...
 
 wfGetLangObj ( $langcode=false)
 Return a Language object from $langcode. More...
 
 wfGetLB ( $wiki=false)
 Get a load balancer object. More...
 
 wfGetLBFactory ()
 Get the load balancer factory object. More...
 
 wfGetMainCache ()
 Get the main cache object. More...
 
 wfGetMessageCacheStorage ()
 Get the cache object used by the message cache. More...
 
 wfGetNull ()
 Get a platform-independent path to the null file, e.g. More...
 
 wfGetPrecompiledData ( $name)
 Get an object from the precompiled serialized directory. More...
 
 wfGetRusage ()
 Get system resource usage of current request context. More...
 
 wfGetScriptUrl ()
 Get the script URL. More...
 
 wfGetServerUrl ( $proto)
 Get the wiki's "server", i.e. More...
 
 wfGlobalCacheKey (... $args)
 Make a cache key with database-agnostic prefix. More...
 
 wfHostname ()
 Fetch server name for use in error reporting etc. More...
 
 wfHttpError ( $code, $label, $desc)
 Provide a simple HTTP error. More...
 
 wfIncrStats ( $key, $count=1)
 Increment a statistics counter. More...
 
 wfIniGetBool ( $setting)
 Safety wrapper around ini_get() for boolean settings. More...
 
 wfIsBadImage ( $name, $contextTitle=false, $blacklist=null)
 Determine if an image exists on the 'bad image list'. More...
 
 wfIsCLI ()
 Check if we are running from the commandline. More...
 
 wfIsDebugRawPage ()
 Returns true if debug logging should be suppressed if $wgDebugRawPage = false. More...
 
 wfIsHHVM ()
 Check if we are running under HHVM. More...
 
 wfIsInfinity ( $str)
 Determine input string is represents as infinity. More...
 
 wfIsWindows ()
 Check if the operating system is Windows. More...
 
 wfLoadExtension ( $ext, $path=null)
 Load an extension. More...
 
 wfLoadExtensions (array $exts)
 Load multiple extensions at once. More...
 
 wfLoadSkin ( $skin, $path=null)
 Load a skin. More...
 
 wfLoadSkins (array $skins)
 Load multiple skins at once. More...
 
 wfLocalFile ( $title)
 Get an object referring to a locally registered file. More...
 
 wfLogDBError ( $text, array $context=[])
 Log for database errors. More...
 
 wfLogProfilingData ()
 
 wfLogWarning ( $msg, $callerOffset=1, $level=E_USER_WARNING)
 Send a warning as a PHP error and the debug log. More...
 
 wfMakeUrlIndexes ( $url)
 Make URL indexes, appropriate for the el_index field of externallinks. More...
 
 wfMatchesDomainList ( $url, $domains)
 Check whether a given URL has a domain that occurs in a given set of domains. More...
 
 wfMemcKey (... $args)
 Make a cache key for the local wiki. More...
 
 wfMemoryLimit ()
 Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit. More...
 
 wfMerge ( $old, $mine, $yours, &$result, &$mergeAttemptResult=null)
 wfMerge attempts to merge differences between three texts. More...
 
 wfMergeErrorArrays (... $args)
 Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g. More...
 
 wfMessage ( $key,... $params)
 This is the function for getting translated interface messages. More...
 
 wfMessageFallback (... $keys)
 This function accepts multiple message keys and returns a message instance for the first message which is non-empty. More...
 
 wfMkdirParents ( $dir, $mode=null, $caller=null)
 Make directory, and make all parent directories if they don't exist. More...
 
 wfMsgReplaceArgs ( $message, $args)
 Replace message parameter keys on the given formatted output. More...
 
 wfNegotiateType ( $cprefs, $sprefs)
 Returns the 'best' match between a client's requested internet media types and the server's list of available types. More...
 
 wfObjectToArray ( $objOrArray, $recursive=true)
 Recursively converts the parameter (an object) to an array with the same data. More...
 
 wfParseUrl ( $url)
 parse_url() work-alike, but non-broken. More...
 
 wfPercent ( $nr, $acc=2, $round=true)
 
 wfQueriesMustScale ()
 Should low-performance queries be disabled? More...
 
 wfRandom ()
 Get a random decimal value in the domain of [0, 1), in a way not likely to give duplicate values for any realistic number of articles. More...
 
 wfRandomString ( $length=32)
 Get a random string containing a number of pseudo-random hex characters. More...
 
 wfReadOnly ()
 Check whether the wiki is in read-only mode. More...
 
 wfReadOnlyReason ()
 Check if the site is in read-only mode and return the message if so. More...
 
 wfRecursiveRemoveDir ( $dir)
 Remove a directory and all its content. More...
 
 wfRelativePath ( $path, $from)
 Generate a relative path name to the given file. More...
 
 wfRemoveDotSegments ( $urlPath)
 Remove all dot-segments in the provided URL path. More...
 
 wfReportTime ( $nonce=null)
 Returns a script tag that stores the amount of time it took MediaWiki to handle the request in milliseconds as 'wgBackendResponseTime'. More...
 
 wfResetOutputBuffers ( $resetGzipEncoding=true)
 Clear away any user-level output buffers, discarding contents. More...
 
 wfResetSessionID ()
 Reset the session id. More...
 
 wfRestoreWarnings ()
 
 wfScript ( $script='index')
 Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScriptPath etc. More...
 
 wfSetBit (&$dest, $bit, $state=true)
 As for wfSetVar except setting a bit. More...
 
 wfSetupSession ( $sessionId=false)
 Initialise php session. More...
 
 wfSetVar (&$dest, $source, $force=false)
 Sets dest to source and returns the original value of dest If source is NULL, it just returns the value, it doesn't set the variable If force is true, it will set the value even if source is NULL. More...
 
 wfShellExec ( $cmd, &$retval=null, $environ=[], $limits=[], $options=[])
 Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported. More...
 
 wfShellExecWithStderr ( $cmd, &$retval=null, $environ=[], $limits=[])
 Execute a shell command, returning both stdout and stderr. More...
 
 wfShellWikiCmd ( $script, array $parameters=[], array $options=[])
 Generate a shell-escaped command line string to run a MediaWiki cli script. More...
 
 wfShorthandToInteger ( $string='', $default=-1)
 Converts shorthand byte notation to integer form. More...
 
 wfShowingResults ( $offset, $limit)
 
 wfSplitWikiID ( $wiki)
 Split a wiki ID into DB name and table prefix. More...
 
 wfStringToBool ( $val)
 Convert string value to boolean, when the following are interpreted as true: More...
 
 wfStripIllegalFilenameChars ( $name)
 Replace all invalid characters with '-'. More...
 
 wfSuppressWarnings ( $end=false)
 Reference-counted warning suppression. More...
 
 wfTempDir ()
 Tries to get the system directory for temporary files. More...
 
 wfThumbIsStandard (File $file, array $params)
 Returns true if these thumbnail parameters match one that MediaWiki requests from file description pages and/or parser output. More...
 
 wfTimestamp ( $outputtype=TS_UNIX, $ts=0)
 Get a timestamp string in one of various formats. More...
 
 wfTimestampNow ()
 Convenience function; returns MediaWiki timestamp for the present time. More...
 
 wfTimestampOrNull ( $outputtype=TS_UNIX, $ts=null)
 Return a formatted timestamp, or null if input is null. More...
 
 wfTransactionalTimeLimit ()
 Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit. More...
 
 wfUnpack ( $format, $data, $length=false)
 Wrapper around php's unpack. More...
 
 wfUrlencode ( $s)
 We want some things to be included as literal characters in our title URLs for prettiness, which urlencode encodes by default. More...
 
 wfUrlProtocols ( $includeProtocolRelative=true)
 Returns a regular expression of url protocols. More...
 
 wfUrlProtocolsWithoutProtRel ()
 Like wfUrlProtocols(), but excludes '//' from the protocol list. More...
 
 wfVarDump ( $var)
 A wrapper around the PHP function var_export(). More...
 
 wfWaitForSlaves ( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
 Waits for the replica DBs to catch up to the master position. More...
 
 wfWarn ( $msg, $callerOffset=1, $level=E_USER_NOTICE)
 Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings. More...
 
 wfWikiID ()
 Get an ASCII string identifying this wiki This is used as a prefix in memcached keys. More...
 

Detailed Description

Global functions used everywhere.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Definition in file GlobalFunctions.php.

Function Documentation

◆ mimeTypeMatch()

mimeTypeMatch (   $type,
  $avail 
)
private

Checks if a given MIME type matches any of the keys in the given array.

Basic wildcards are accepted in the array keys.

Returns the matching MIME type (or wildcard) if a match, otherwise NULL if no match.

Parameters
string$type
array$avail
Returns
string

Definition at line 1822 of file GlobalFunctions.php.

References $type.

Referenced by GlobalTest\testMimeTypeMatch(), and wfNegotiateType().

◆ wfAcceptToPrefs()

wfAcceptToPrefs (   $accept,
  $def = '*/*' 
)

Converts an Accept-* header into an array mapping string values to quality factors.

Parameters
string$accept
string$defDefault
Returns
float[] Associative array of string => float pairs

Definition at line 1786 of file GlobalFunctions.php.

References as.

◆ wfAppendQuery()

◆ wfAppendToArrayIfNotDefault()

wfAppendToArrayIfNotDefault (   $key,
  $value,
  $default,
$changed 
)

Appends to second array if $value differs from that in $default.

Parameters
string | int$key
mixed$value
mixed$default
array&$changedArray to alter
Exceptions
MWException

Definition at line 175 of file GlobalFunctions.php.

References $value.

◆ wfArrayDiff2()

wfArrayDiff2 (   $a,
  $b 
)

Like array_diff( $a, $b ) except that it works with two-dimensional arrays.

Parameters
array$a
array$b
Returns
array

Definition at line 111 of file GlobalFunctions.php.

Referenced by WikiPage\doRollback(), EditPage\getEditPermissionErrors(), GlobalTest\testWfArrayDiff2(), and UploadBase\verifyTitlePermissions().

◆ wfArrayDiff2_cmp()

wfArrayDiff2_cmp (   $a,
  $b 
)
Parameters
array | string$a
array | string$b
Returns
int

Definition at line 120 of file GlobalFunctions.php.

References key.

◆ wfArrayFilter()

wfArrayFilter ( array  $arr,
callable  $callback 
)
Deprecated:
since 1.32, use array_filter() with ARRAY_FILTER_USE_BOTH directly
Parameters
array$arr
callable$callbackWill be called with the array value and key (in that order) and should return a bool which will determine whether the array element is kept.
Returns
array

Definition at line 150 of file GlobalFunctions.php.

Referenced by WfArrayFilterTest\testWfArrayFilter().

◆ wfArrayFilterByKey()

wfArrayFilterByKey ( array  $arr,
callable  $callback 
)
Deprecated:
since 1.32, use array_filter() with ARRAY_FILTER_USE_KEY directly
Parameters
array$arr
callable$callbackWill be called with the array key and should return a bool which will determine whether the array element is kept.
Returns
array

Definition at line 162 of file GlobalFunctions.php.

Referenced by WfArrayFilterTest\testWfArrayFilterByKey().

◆ wfArrayInsertAfter()

wfArrayInsertAfter ( array  $array,
array  $insert,
  $after 
)

Insert array into another array after the specified KEY

Parameters
array$arrayThe array.
array$insertThe array to insert.
mixed$afterThe key to insert after
Returns
array

Definition at line 229 of file GlobalFunctions.php.

References $keys, and $output.

Referenced by ApiComparePages\getAllowedParams(), DeletedContributionsPage\getSubTitle(), and UpdateExtensionJsonSchema\updateTo2().

◆ wfArrayPlus2d()

wfArrayPlus2d ( array  $baseArray,
array  $newValues 
)

Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).

Values that exist in both values will be combined with += (all values of the array of $newValues will be added to the values of the array of $baseArray, while values, that exists in both, the value of $baseArray will be used).

Parameters
array$baseArrayThe array where you want to add the values of $newValues to
array$newValuesAn array with new values
Returns
array The combined array
Since
1.26

Definition at line 3241 of file GlobalFunctions.php.

References $name, and as.

Referenced by HTMLUserTextField\__construct(), ExtensionRegistry\exportExtractedData(), and WfArrayPlus2dTest\testWfArrayPlus2d().

◆ wfArrayToCgi()

◆ wfAssembleUrl()

wfAssembleUrl (   $urlParts)

This function will reassemble a URL parsed with wfParseURL.

This is useful if you need to edit part of a URL and put it back together.

This is the basic structure used (brackets contain keys for $urlParts): [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]

Todo:
Need to integrate this into wfExpandUrl (see T34168)
Since
1.19
Parameters
array$urlPartsURL parts, as output from wfParseUrl
Returns
string URL assembled from its component parts

Definition at line 608 of file GlobalFunctions.php.

Referenced by WfAssembleUrlTest\testWfAssembleUrl(), and wfExpandUrl().

◆ wfBacktrace()

wfBacktrace (   $raw = null)

Get a debug backtrace as a string.

Parameters
bool | null$rawIf true, the return value is plain text. If false, HTML. Defaults to $wgCommandLineMode if unset.
Returns
string
Since
1.25 Supports $raw parameter.

Definition at line 1441 of file GlobalFunctions.php.

References $line, $wgCommandLineMode, use, and wfDebugBacktrace().

Referenced by MWDebug\deprecated(), and Revision\RevisionStore\getTitle().

◆ wfBaseName()

wfBaseName (   $path,
  $suffix = '' 
)

Return the final portion of a pathname.

Reimplemented because PHP5's "basename()" is buggy with multibyte text. https://bugs.php.net/bug.php?id=33898

PHP's basename() only considers '\' a pathchar on Windows and Netware. We'll consider it so always, as we don't want '\s' in our Unix paths either.

Parameters
string$path
string$suffixString to remove if present
Returns
string

Definition at line 2428 of file GlobalFunctions.php.

References $matches, and $path.

Referenced by Exif\__construct(), ImageBuilder\checkMissingImage(), FileOpPerfTest\doPerfTest(), ImportImages\execute(), WfBaseNameTest\testBaseName(), wfRelativePath(), and wfStripIllegalFilenameChars().

◆ wfBCP47()

wfBCP47 (   $code)

Get the normalised IETF language tag See unit test for examples.

See mediawiki.language.bcp47 for the JavaScript implementation.

Deprecated:
since 1.31, use LanguageCode::bcp47() directly.
Parameters
string$codeThe language code.
Returns
string The language code which complying with BCP 47 standards.

Definition at line 2966 of file GlobalFunctions.php.

References $code, LanguageCode\bcp47(), and wfDeprecated().

◆ wfBoolToStr()

wfBoolToStr (   $value)

Convenience function converts boolean values into "true" or "false" (string) values.

Parameters
bool$value
Returns
string

Definition at line 2771 of file GlobalFunctions.php.

References $value.

Referenced by LocalSettingsGenerator\__construct(), ApiRsd\formatRsdApiList(), LocalSettingsGenerator\getDefaultText(), and GlobalTest\testClientAcceptsGzipTest().

◆ wfCanIPUseHTTPS()

wfCanIPUseHTTPS (   $ip)

Determine whether the client at a given source IP is likely to be able to access the wiki via HTTPS.

Parameters
string$ipThe IPv4/6 address in the normal human-readable form
Returns
bool

Definition at line 3122 of file GlobalFunctions.php.

References Hooks\run().

Referenced by LoginSignupSpecialPage\execute(), MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor(), and User\requiresHTTPS().

◆ wfCgiToArray()

wfCgiToArray (   $query)

This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns the same string in array form.

This allows compatibility with legacy functions that accept raw query strings instead of nice arrays. Of course, keys and values are urldecode()d.

Parameters
string$queryQuery string
Returns
string[] Array version of input

Definition at line 413 of file GlobalFunctions.php.

References $keys, $query, $ret, $value, as, and list.

Referenced by Linker\link(), Linker\makeBrokenImageLinkObj(), SpecialChangeEmail\onSuccess(), OutputPage\returnToMain(), LoginHelper\showReturnToPage(), MediaWiki\Storage\SqlBlobStore\splitBlobAddress(), SpecialCreateAccount\successfulAction(), GlobalTest\testCgiRoundTrip(), and GlobalTest\testCgiToArray().

◆ wfClearOutputBuffers()

wfClearOutputBuffers ( )

More legible than passing a 'false' parameter to wfResetOutputBuffers():

Clear away output buffers, but keep the Content-Encoding header produced by ob_gzhandler, if any.

This should be used for HTTP 304 responses, where you need to preserve the Content-Encoding header of the real result, but also need to suppress the output of ob_gzhandler to keep to spec and avoid breaking Firefox in rare cases where the headers and body are broken over two packets.

Definition at line 1774 of file GlobalFunctions.php.

References wfResetOutputBuffers().

Referenced by ApiMain\checkConditionalRequestHeaders(), and OutputPage\checkLastModified().

◆ wfClientAcceptsGzip()

wfClientAcceptsGzip (   $force = false)

Whether the client accept gzip encoding.

Uses the Accept-Encoding header to check if the client supports gzip encoding. Use this when considering to send a gzip-encoded response to the client.

Parameters
bool$forceForces another check even if we already have a cached result.
Returns
bool

Definition at line 1540 of file GlobalFunctions.php.

References wfDebug().

Referenced by MediaWiki\OutputHandler\handleGzip(), HTMLFileCache\loadFromFileCache(), HTMLFileCache\saveToFileCache(), and GlobalTest\testClientAcceptsGzipTest().

◆ wfConfiguredReadOnlyReason()

wfConfiguredReadOnlyReason ( )

Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.

Returns
string|bool String when in read-only mode; false otherwise
Since
1.27

Definition at line 1219 of file GlobalFunctions.php.

Referenced by FileBackendGroup\initFromGlobals(), and JobQueueGroup\singleton().

◆ wfCountDown()

wfCountDown (   $seconds)

Count down from $seconds to zero on the terminal, with a one-second pause between showing each number.

For use in command-line scripts.

Deprecated:
since 1.31, use Maintenance::countDown()
Parameters
int$seconds

Definition at line 2842 of file GlobalFunctions.php.

References wfDeprecated().

◆ wfDebug()

wfDebug (   $text,
  $dest = 'all',
array  $context = [] 
)

Sends a line to the debug log if enabled or, optionally, to a comment in output.

In normal operation this is a NOP.

Controlling globals: $wgDebugLogFile - points to the log file $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output. $wgDebugComments - if on, some debug items may appear in comments in the HTML output.

Since
1.25 support for additional context data
Parameters
string$text
string | bool$destDestination of the message:
  • 'all': both to the log and HTML (debug toolbar or HTML comments)
  • 'private': excluded from HTML output For backward compatibility, it can also take a boolean:
  • true: same as 'all'
  • false: same as 'private'
array$contextAdditional logging context data

Definition at line 946 of file GlobalFunctions.php.

References $context, $wgDebugLogPrefix, $wgDebugRawPage, $wgDebugTimestamps, and wfIsDebugRawPage().

Referenced by QuickTemplate\__construct(), PageArchive\__construct(), UploadFromChunks\__construct(), UploadFromStash\__construct(), SearchUpdate\__construct(), ApiMain\__construct(), DifferenceEngine\__construct(), Parser\__construct(), UploadStashFile\__construct(), StubObject\_unstub(), LogPage\actionText(), ImageGalleryBase\add(), ParserTestRunner\addArticle(), MediaHandler\addMeta(), LinkBatch\addObj(), LocalFileMoveBatch\addOlds(), ParserOutput\addTrackingCategory(), Skin\afterContentHook(), Parser\braceSubstitution(), SkinTemplate\buildContentActionUrls(), EmailNotification\canSendUserTalkEmail(), AjaxResponse\checkLastModified(), OutputPage\checkLastModified(), UploadBase\checkSvgScriptCallback(), UploadBase\checkXMLEncodingMissmatch(), JobQueueDB\claimOldest(), LocalRepo\cleanupDeletedBatch(), UploadBase\cleanupTempFile(), SpecialEditWatchlist\cleanupWatchlist(), UploadStash\clear(), CloneDatabase\cloneTableStructure(), MediaWiki\Storage\SqlBlobStore\compressData(), UploadFromChunks\concatenateChunks(), Article\confirmDelete(), DjVuImage\convertDumpToXML(), UploadBase\createFromRequest(), BaseDump\debug(), WikiImporter\debug(), RecompressTracked\debug(), SVGReader\debug(), SectionProfiler\debug(), Block\defaultRetroactiveAutoblock(), Article\delete(), Block\deleteIfExpired(), User\deleteNewtalk(), ChangeTags\deleteTagEverywhere(), UploadBase\detectScript(), UploadBase\detectVirus(), DiffEngine\diffInternal(), Parser\disableCache(), BitmapMetadataHandler\doApp13(), Block\doAutoblock(), JobQueueDB\doBatchPushInternal(), WikiPage\doDeleteArticleBatched(), WikiPage\doDeleteArticleReal(), MockImageHandler\doFakeTransform(), WikiFilePage\doPurge(), DatabaseOracle\doQuery(), Block\doRetroactiveAutoblock(), UserrightsPage\doSaveUserGroups(), TransformationalImageHandler\doTransform(), DjVuHandler\doTransform(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), EditPage\edit(), ZipDirectoryReader\error(), ApiUpload\execute(), SpecialUserLogout\execute(), ChangesFeed\execute(), SpecialUpload\execute(), LocalFileRestoreBatch\execute(), DjVuHandler\extractTreesFromMetadata(), PoolWorkArticleView\fallback(), IcuCollation\fetchFirstLetterData(), Article\fetchRevisionRecord(), DiffEngine\find_middle_snake(), BlockLevelPass\findColonNoLinks(), WikiImporter\finishImportPage(), FormatMetadata\flattenArrayReal(), DeletedContribsPager\formatRow(), ContribsPager\formatRow(), FileRepo\freeTemp(), LCStoreCDB\get(), ParserCache\get(), MediaWiki\Interwiki\ClassicInterwikiLookup\getAllPrefixesCached(), User\getBlockedStatus(), CoreParserFunctions\getCachedRevisionObject(), PoolWorkArticleView\getCachedWork(), ContextSource\getContext(), Profiler\getContext(), Action\getContext(), SpecialPage\getContext(), Article\getContext(), SpecialVersion\getCreditsForExtension(), WikiPage\getDeletionUpdates(), ForeignDBFile\getDescriptionText(), File\getDescriptionText(), UploadStash\getFile(), DoubleRedirectJob\getFinalDestination(), WikiFilePage\getForeignCategories(), GenderCache\getGenderOf(), MediaHandlerFactory\getHandler(), DjVuImage\getInfo(), SpecialUpload\getInitialPageText(), MediaWiki\Interwiki\ClassicInterwikiLookup\getInterwikiCacheEntry(), ParserCache\getKey(), TransformationalImageHandler\getMagickVersion(), RequestContext\getMainAndWarn(), GIFHandler\getMetadata(), PNGHandler\getMetadata(), PNGMetadataExtractor\getMetadata(), GIFMetadataExtractor\getMetadata(), TiffHandler\getMetadata(), JpegHandler\getMetadata(), DjVuHandler\getMetadata(), SvgHandler\getMetadata(), DjVuHandler\getMetaTree(), DjVuImage\getMultiPageInfo(), WebRequestUpload\getName(), Title\getNsText(), DjVuImage\getPageInfo(), WikiPage\getParserOutput(), SpecialEmailUser\getPermissionsError(), EditPage\getPreloadedContent(), UserCache\getProp(), Title\getRestrictionTypes(), Parser\getRevisionTimestampSubstring(), ExternalStoreDB\getSlave(), SpecialEmailUser\getTarget(), ForeignAPIRepo\getThumbError(), ForeignAPIRepo\getThumbUrl(), UploadStashFile\getThumbUrl(), ForeignAPIRepo\getThumbUrlFromCache(), Title\getTitleValue(), Parser\getUserSig(), Parser\getVariableValue(), File\getViewURL(), XCFHandler\getXCFMetaData(), MediaWiki\OutputHandler\handleGzip(), OutputPage\haveCacheVaryCookies(), ThumbnailRenderJob\hitThumbUrl(), ForeignAPIRepo\httpGet(), EditPage\importFormData(), WikiRevision\importLogItem(), Block\insert(), ExternalStore\insertWithFallback(), EditPage\internalAttemptSave(), FileCacheBase\isCacheGood(), MediaWiki\Shell\Shell\isDisabled(), DjVuHandler\isEnabled(), SvgHandler\isEnabled(), FileDependency\isExpired(), LocalisationCache\isExpired(), Block\isExpired(), WebPHandler\isMetadataValid(), ExifBitmapHandler\isMetadataValid(), PNGHandler\isMetadataValid(), GIFHandler\isMetadataValid(), MovePage\isValidMoveTarget(), Title\isValidMoveTarget(), Block\isWhitelistedFromAutoblocks(), MessageCache\load(), SiteStats\loadAndLazyInit(), ChangesFeed\loadFromCache(), User\loadFromCache(), HTMLFileCache\loadFromFileCache(), AjaxResponse\loadFromMemcached(), User\loadOptions(), PopulateArchiveRevId\makeDummyRevisionRow(), Linker\makeExternalImage(), Linker\makeExternalLink(), Linker\makeImageLink(), Linker\makeMediaLinkFile(), ImportStreamSource\newFromURL(), WikiImporter\notice(), RawAction\onView(), DumpUploads\outputItem(), Revision\RenderedRevision\outputVariesOnRevisionMetaData(), SearchMySQL\parseQuery(), SearchSqlite\parseQuery(), SearchPostgres\parseQuery(), BacklinkCache\partition(), DiffHistoryBlob\patch(), AjaxDispatcher\performAction(), ApiUpload\performStash(), User\pingLimiter(), MediaWiki\preOutputCommit(), SkinTemplate\prepareQuickTemplate(), SpecialUpload\processUpload(), LocalFile\purgeThumbList(), BacklinkCache\queryLinks(), SvgHandler\rasterize(), TextPassDumper\readDump(), LocalisationCache\recache(), LocalFile\recordUpload2(), UploadStash\removeFileNoAuth(), Parser\renderImageGallery(), WikiPage\replaceSectionAtRev(), Parser\replaceVariables(), MediaWiki\restInPeace(), DjVuImage\retrieveMetaData(), JpegHandler\rotate(), BitmapHandler\rotate(), DoubleRedirectJob\run(), ParserTestRunner\runTest(), ParserCache\save(), FileCacheBase\saveText(), HTMLFileCache\saveToFileCache(), SearchPostgres\searchQuery(), JpegMetadataExtractor\segmentSplitter(), UserMailer\send(), OutputPage\sendCacheControl(), UserMailer\sendInternal(), UserMailer\sendWithPear(), ApiMain\setCacheMode(), LanguageClassesTestCase\setUp(), ParserTestTopLevelSuite\setUp(), ViewAction\show(), LocalRepo\skipWriteOperationIfSha1(), User\spreadBlock(), UploadStash\stashFile(), FileRepo\storeBatch(), ParserTestTopLevelSuite\tearDown(), ParserTestRunner\teardownDatabase(), GlobalTest\testDebugFunctionTest(), ApiUploadTest\testUploadChunks(), WikiImporter\throwXmlError(), MediaWiki\Tidy\RemexDriver\tidy(), MediaWiki\Tidy\RemexCompatMunger\trace(), File\transform(), BitmapHandler\transformCustom(), BitmapHandler\transformGd(), BitmapHandler\transformImageMagick(), BitmapHandler\transformImageMagickExt(), LocalisationCacheBulkLoad\trimCache(), SpecialUploadStash\tryClearStashedUploads(), Article\tryFileCache(), PageArchive\undelete(), PageArchive\undeleteRevisions(), Block\update(), UploadFromChunks\updateChunkStatus(), User\updateNewtalk(), OldLocalFile\upgradeRow(), LocalFile\upgradeRow(), HTMLFileCache\useFileCache(), Revision\RevisionRecord\userCanBitfield(), LogEventsList\userCanBitfield(), SpecialEmailUser\validateTarget(), ImageHandler\validateThumbParams(), UploadBase\verifyExtension(), UploadBase\verifyFile(), UploadBase\verifyMimeType(), Article\view(), WikiImporter\warn(), wfClientAcceptsGzip(), wfDebugBacktrace(), wfDebugMem(), wfDiff(), wfGetLangObj(), wfMemoryLimit(), wfMerge(), wfMkdirParents(), wfRecursiveRemoveDir(), and wfTimestamp().

◆ wfDebugBacktrace()

wfDebugBacktrace (   $limit = 0)

Safety wrapper for debug_backtrace().

Will return an empty array if debug_backtrace is disabled, otherwise the output from debug_backtrace() (trimmed).

Parameters
int$limitThis parameter can be used to limit the number of stack frames returned
Returns
array Array of backtrace information

Definition at line 1413 of file GlobalFunctions.php.

References wfDebug().

Referenced by MWDebug\getCallerDescription(), wfBacktrace(), wfGetAllCallers(), and wfGetCaller().

◆ wfDebugLog()

wfDebugLog (   $logGroup,
  $text,
  $dest = 'all',
array  $context = [] 
)

Send a line to a supplementary debug log file, if configured, or main debug log if not.

To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to a string filename or an associative array mapping 'destination' to the desired filename. The associative array may also contain a 'sample' key with an integer value, specifying a sampling factor. Sampled log events will be emitted with a 1 in N random chance.

Since
1.23 support for sampling log messages via $wgDebugLogGroups.
1.25 support for additional context data
1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
Parameters
string$logGroup
string$text
string | bool$destDestination of the message:
  • 'all': both to the log and HTML (debug toolbar or HTML comments)
  • 'private': only to the specific log if set in $wgDebugLogGroups and discarded otherwise For backward compatibility, it can also take a boolean:
  • true: same as 'all'
  • false: same as 'private'
array$contextAdditional logging context data

Definition at line 1040 of file GlobalFunctions.php.

References $context.

Referenced by GitInfo\__construct(), LocalisationCache\__construct(), MediaWikiPHPUnitTestListener\addError(), MediaWikiPHPUnitTestListener\addFailure(), MediaWikiPHPUnitTestListener\addIncompleteTest(), MediaWikiPHPUnitTestListener\addSkippedTest(), AutoLoader\autoload(), ExternalStoreDB\batchFetchBlobs(), RCCacheEntryFactory\buildCLink(), RCCacheEntryFactory\buildDiffLink(), ApiMain\checkBotReadOnly(), UploadFromChunks\concatenateChunks(), IPTC\convIPTCHelper(), ParserTestTopLevelSuite\debug(), Exif\debug(), Exif\debugFile(), SectionProfiler\debugGroup(), WebPHandler\decodeLosslessChunkHeader(), WebPHandler\decodeLossyChunkHeader(), JobQueueRedis\doAck(), JobQueueRedis\doBatchPush(), FileBackendMultiWrite\doOperationsInternal(), JobQueueRedis\doPop(), TransformationalImageHandler\doTransform(), DjVuHandler\doTransform(), SvgHandler\doTransform(), MediaWikiPHPUnitTestListener\endTest(), MediaWikiPHPUnitTestListener\endTestSuite(), CheckUsernames\execute(), LocalFileMoveBatch\execute(), WebPHandler\extractMetadata(), WebPHandler\extractMetadataFromChunks(), PoolWorkArticleView\fallback(), ExternalStoreDB\fetchBlob(), Message\formatListParam(), ParserCache\get(), IPTC\getCharset(), LocalisationCache\getCompiledPluralRules(), ContentHandler\getContentText(), ContentHandler\getForModelID(), ResourceLoaderImage\getImageData(), ParserCache\getKey(), RequestContext\getLanguage(), LocalFileMoveBatch\getMoveTriplets(), ResourceLoaderFileModule\getTemplates(), RequestContext\getTitle(), WebResponse\header(), CdnCacheUpdate\HTCPPurge(), User\inDnsBlacklist(), ExternalStore\insertWithFallback(), EditPage\internalAttemptSave(), User\isCreatableName(), MessageCache\load(), MessageCache\loadFromDB(), SquidPurgeClient\log(), MWLBFactory\logDeprecation(), PoolCounterWork\logError(), MediaHandler\logErrorForExternalProcess(), JobQueueFederated\logException(), ApiBase\logFeatureUsage(), ApiMain\logRequest(), MediaWiki\main(), Parser\makeLimitReport(), LocalFile\move(), MediaWiki\Site\MediaWikiPageNameNormalizer\normalizePageName(), IPTC\parse(), MessageCache\parse(), User\pingLimiter(), GitInfo\precomputeValues(), MediaWiki\preOutputCommit(), CdnCacheUpdate\purge(), ResourceLoaderFileModule\readStyleFile(), UploadFromUrl\reallyFetchFile(), MediaHandler\removeBadFile(), LocalFileMoveBatch\removeNonexistentFiles(), FileBackendMultiWrite\resyncFiles(), SquidPurgeClientPool\run(), ResourceLoaderModule\saveFileDependencies(), UploadFromUrl\saveTempFileChunk(), MWDebug\sendMessage(), WebResponse\setCookie(), MediaWikiPHPUnitTestListener\startTest(), MediaWikiPHPUnitTestListener\startTestSuite(), WebResponse\statusHeader(), and IPTC\timeHelper().

◆ wfDebugMem()

wfDebugMem (   $exact = false)

Send a line giving PHP memory usage.

Parameters
bool$exactPrint exact byte values instead of kibibytes (default: false)

Definition at line 1005 of file GlobalFunctions.php.

References wfDebug().

Referenced by GlobalTest\testDebugFunctionTest().

◆ wfDeprecated()

wfDeprecated (   $function,
  $version = false,
  $component = false,
  $callerOffset = 2 
)

Throws a warning that $function is deprecated.

Parameters
string$function
string | bool$versionVersion of MediaWiki that the function was deprecated in (Added in 1.19).
string | bool$componentAdded in 1.19.
int$callerOffsetHow far up the call stack is the original caller. 2 = function that called the function that called wfDeprecated (Added in 1.20)
Returns
null

Definition at line 1076 of file GlobalFunctions.php.

References MWDebug\deprecated().

Referenced by MediaWiki\Widget\Search\SimpleSearchResultWidget\__construct(), MediaWiki\Auth\LegacyHookPreAuthenticationProvider\__construct(), MediaWiki\Widget\Search\SimpleSearchResultSetWidget\__construct(), DoubleReplacer\__construct(), RegexlikeReplacer\__construct(), HashtableReplacer\__construct(), SearchResultSet\__construct(), Block\__construct(), ApiResult\__construct(), __get(), __set(), DeprecatedGlobal\_newObject(), LinkCache\addLink(), OutputPage\addScriptFile(), WebInstallerOutput\addWikiText(), OutputPage\addWikiText(), OutputPage\addWikiTextTidy(), OutputPage\addWikiTextTitle(), OutputPage\addWikiTextTitleInternal(), OutputPage\addWikiTextTitleTidy(), OutputPage\addWikiTextWithTitle(), MediaWiki\Session\SessionManager\autoCreateUser(), SearchResultSet\bcIterator(), Hooks\callHook(), Replacer\cb(), User\checkPassword(), User\checkTemporaryPassword(), User\createNew(), Preferences\datetimePreferences(), Article\doEditContent(), CryptRand\driftHash(), Preferences\editingPreferences(), OutputPage\enableSectionEditLinks(), Maintenance\error(), Title\escapeFragmentForURL(), Sanitizer\escapeIdReferenceList(), SpecialExpandTemplates\execute(), Interwiki\fetch(), Parser\fetchFile(), Revision\fetchRevision(), Preferences\filesPreferences(), SpecialRecentChanges\filterByCategories(), Title\fixUrlQueryArgs(), DummyLinker\formatSize(), Linker\formatSize(), DummyLinker\formatTemplates(), Linker\formatTemplates(), MWCryptRand\generate(), CryptRand\generate(), CryptRand\generateHex(), Preferences\generateSkinOptions(), Interwiki\getAllPrefixes(), BufferingStatsdDataFactory\getBuffer(), ResourceLoaderWikiModule\getContentObj(), EditPage\getContextTitle(), MediaWiki\MediaWikiServices\getCryptRand(), WikiPage\getDeletionUpdates(), ApiBase\getDescription(), ApiBase\getDescriptionMessage(), ParserOptions\getEditSection(), ParserOutput\getEditSectionTokens(), DifferenceEngine\getEngine(), HTMLForm\getErrors(), ApiBase\getExamples(), Message\getFormat(), Preferences\getFormObject(), User\getGroupMember(), User\getGroupName(), User\getGroupPage(), IcuCollation\getICUVersion(), ActorMigration\getInsertValuesWithTempTable(), JsonContent\getJsonData(), OutputPage\getKeyHeader(), PageArchive\getLastRevisionText(), MWLBFactory\getLBFactoryClass(), ResourceLoaderStartUpModule\getLegacyModules(), MWExceptionHandler\getLogId(), SearchEngine\getNearMatchResultSet(), HTMLInfoField\getOOUI(), ApiBase\getParamDescription(), Preferences\getPreferences(), Revision\getRevisionText(), Title\getSkinFromCssJsSubpage(), ResourceLoaderStartUpModule\getStartupModules(), StripState\getSubState(), SpecialEmailUser\getTarget(), PageArchive\getTextFromRow(), SpecialPage\getTitle(), ParserOutput\getTOCEnabled(), WatchAction\getUnwatchToken(), MediaWikiTestCase\hideDeprecated(), Language\initEncoding(), CryptRand\initialRandomState(), CommentStore\insertWithTempTable(), Parser\internalParseHalfParsed(), Interwiki\invalidateCache(), Title\isCssJsSubpage(), Title\isCssOrJsPage(), Title\isCssSubpage(), Title\isJsSubpage(), User\isLocallyBlockedProxy(), Parser\isValidHalfParsedText(), Interwiki\isValidInterwiki(), ParserOptions\legacyOptions(), Linker\link(), PageArchive\listAllPages(), Revision\loadFromId(), User\makeGroupLinkHTML(), User\makeGroupLinkWiki(), ContentHandler\makeParserOptions(), Language\markNoConversion(), StripState\merge(), Preferences\miscPreferences(), BaseTemplate\msgHtml(), QuickTemplate\msgHtml(), SiteSQLStore\newInstance(), CommentStore\newKey(), SearchResultSet\next(), LanguageAr\normalize(), LanguageMl\normalize(), SkinTemplate\outputPage(), Revision\pageJoinCond(), OutputPage\parse(), OutputPage\parseInline(), OutputPage\parserOptions(), ParserTestRunner\perTestSetup(), WikiPage\prepareContentForEdit(), ApiQueryBase\prepareUrlQuerySearchString(), Preferences\profilePreferences(), JobQueueGroup\pushLazyJobs(), SquidPurgeClient\queuePurge(), CryptRand\randomState(), Preferences\rcPreferences(), ExtensionRegistry\readFromQueue(), ResourceLoaderFileModule\readStyleFiles(), Language\recodeForEdit(), Language\recodeInput(), Sanitizer\removeHTMLtags(), Preferences\renderingPreferences(), SearchResultSet\rewind(), ApiQuerySearch\run(), Preferences\searchPreferences(), OutputPage\sectionEditLinksEnabled(), Revision\selectArchiveFields(), OldLocalFile\selectFields(), LocalFile\selectFields(), Block\selectFields(), ArchivedFile\selectFields(), RecentChange\selectFields(), WikiPage\selectFields(), Revision\selectFields(), User\selectFields(), Revision\selectPageFields(), Revision\selectTextFields(), Revision\selectUserFields(), OutputPage\sendCacheControl(), AjaxResponse\sendHeaders(), Parser\serializeHalfParsedText(), ParserOptions\setEditSection(), ParserOutput\setEditSectionTokens(), SearchResult\setExtensionData(), MWTidy\setInstance(), User\setInternalPassword(), User\setPassword(), QuickTemplate\setRef(), HTMLForm\setSubmitProgressive(), ParserOutput\setTOCEnabled(), ParserOptions\setWrapOutputClass(), OutputPage\showFileCopyError(), OutputPage\showFileDeleteError(), OutputPage\showFileNotFoundError(), OutputPage\showFileRenameError(), LogEventsList\showOptions(), SpecialSearch\showResults(), OutputPage\showUnexpectedValueError(), MWCryptRand\singleton(), EventRelayerGroup\singleton(), Preferences\skinPreferences(), UploadFromChunks\stashFile(), UploadFromChunks\stashFileGetKey(), UploadBase\stashFileGetKey(), MediaWikiTestCase\stashMwGlobals(), UploadFromChunks\stashSession(), UploadBase\stashSession(), SpecialEmailUser\submit(), EditPage\submit(), ApiBase\truncateArray(), Parser\unserializeHalfParsedText(), EmailNotification\updateWatchlistTimestamp(), Revision\userJoinCond(), SpecialEmailUser\validateTarget(), MWCryptRand\wasStrong(), CryptRand\wasStrong(), Preferences\watchlistPreferences(), wfBCP47(), wfCountDown(), wfMakeUrlIndexes(), wfResetSessionID(), wfSetupSession(), OutputPage\wrapWikiMsg(), and MediaWiki\Session\PHPSessionHandler\write().

◆ wfDiff()

wfDiff (   $before,
  $after,
  $params = '-u' 
)

Returns unified plain-text diff of two texts.

"Useful" for machine processing of diffs.

Deprecated:
since 1.25, use DiffEngine/UnifiedDiffFormatter directly
Parameters
string$beforeThe text before the changes.
string$afterThe text after the changes.
string$paramsCommand-line options for the diff command.
Returns
string Unified diff of $before and $after

Definition at line 2348 of file GlobalFunctions.php.

References $params, $wgDiff, wfDebug(), and wfTempDir().

Referenced by ParserDiffTest\__call(), CompareParserCache\execute(), and CompareParsers\processRevision().

◆ wfEscapeShellArg()

◆ wfEscapeWikiText()

wfEscapeWikiText (   $text)

Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.

making its way through. This is achieved by substituting certain characters with HTML entities. As required by the callers, "<nowiki>" is not used.

Parameters
string$textText to be escaped

Definition at line 1575 of file GlobalFunctions.php.

References $wgEnableMagicLinks, $wgUrlProtocols, and as.

Referenced by MediaHandler\addMeta(), CoreParserFunctions\basepagename(), CoreParserFunctions\basepagenamee(), Parser\braceSubstitution(), SpecialPageLanguage\changePageLanguage(), ApiMain\checkAsserts(), ApiQueryImageInfo\checkParameterNormalise(), SpecialContributions\contributionsSub(), ApiMain\createPrinterByName(), CoreParserFunctions\defaultsort(), Article\delete(), CoreParserFunctions\displaytitle(), FileDeleteForm\doDelete(), Article\doDelete(), WikiPage\doDeleteArticleBatched(), ApiCSPReport\error(), ApiMain\errorMessagesFromException(), ApiValidatePassword\execute(), ApiProtect\execute(), ApiUndelete\execute(), ApiMove\execute(), ApiMergeHistory\execute(), ApiEditPage\execute(), ApiExpandTemplates\execute(), ApiQueryAllMessages\execute(), ApiOptions\execute(), ApiParse\execute(), SpecialUnblock\execute(), ApiQueryLogEvents\execute(), ApiQueryUserContribs\execute(), ApiComparePages\execute(), ApiUserrights\execute(), ApiAMCreateAccount\execute(), ApiLinkAccount\execute(), ApiClientLogin\execute(), FileDuplicateSearchPage\execute(), SpecialMergeHistory\execute(), PasswordReset\execute(), ApiQueryRevisionsBase\extractDeprecatedContent(), ApiBase\extractRequestParams(), ApiQueryRevisionsBase\extractRevisionInfo(), CoreParserFunctions\fullpagename(), CoreParserFunctions\fullpagenamee(), ApiComparePages\getDiffRevision(), ApiFeedRecentChanges\getFeedObject(), ApiErrorFormatter\getMessageFromException(), ApiBase\getModuleFromPath(), ApiRollback\getRbTitle(), ApiRollback\getRbUser(), TextSlotDiffRenderer\getTextDiffInternal(), ApiBase\getTitleFromTitleOrPageId(), ApiBase\getTitleOrPageId(), Parser\getUserSig(), Parser\getVariableValue(), ApiBase\getWatchlistUser(), EditPage\importFormData(), SpecialBlock\maybeAlterFormDefaults(), ApiQueryImageInfo\mergeThumbParams(), SpecialRandomInCategory\onSubmit(), SpecialBlock\onSuccess(), ImagePage\openShowImage(), ImageListPager\outputUserDoesNotExist(), CoreParserFunctions\pagename(), CoreParserFunctions\pagenamee(), ApiBase\parseMultiValue(), SpecialBlock\postText(), ApiQueryBase\prefixedTitlePartToKey(), FileDeleteForm\prepareMessage(), ApiQueryBlocks\prepareUsername(), CoreParserFunctions\rootpagename(), CoreParserFunctions\rootpagenamee(), ApiQueryImages\run(), ApiQueryCategories\run(), ApiQueryLinks\run(), ApiQueryRevisions\run(), ApiQueryRecentChanges\run(), ApiMain\setupModule(), ProtectionForm\show(), SpecialSearch\showCreateLink(), UserrightsPage\showEditUserGroupsForm(), SpecialUndelete\showHistory(), EditPage\showIntro(), Article\showMissingArticle(), SpecialSearch\showResults(), LoginSignupSpecialPage\showSuccessPage(), EditPage\spamPageWithContent(), CoreParserFunctions\subjectpagename(), CoreParserFunctions\subjectpagenamee(), CoreParserFunctions\subpagename(), CoreParserFunctions\subpagenamee(), CoreParserFunctions\talkpagename(), CoreParserFunctions\talkpagenamee(), CoreParserFunctionsTest\testGender(), ApiQueryBase\titlePartToKey(), ApiFileRevert\validateParameters(), SpecialBlock\validateTarget(), ApiBase\validateTimestamp(), and ApiBase\validateUser().

◆ wfExpandIRI()

wfExpandIRI (   $url)

Take a URL, make sure it's expanded to fully qualified, and replace any encoded non-ASCII Unicode characters with their UTF-8 original forms for more compact display and legibility for local audiences.

Todo:
handle punycode domains too
Parameters
string$url
Returns
string

Definition at line 884 of file GlobalFunctions.php.

References $matches, array(), and wfExpandUrl().

Referenced by Skin\printSource(), and GlobalTest\testExpandIRI().

◆ wfExpandUrl()

wfExpandUrl (   $url,
  $defaultProto = PROTO_CURRENT 
)

Expand a potentially local URL to a fully-qualified URL.

Assumes $wgServer is correct.

The meaning of the PROTO_* constants is as follows: PROTO_HTTP: Output a URL starting with http:// PROTO_HTTPS: Output a URL starting with https:// PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL) PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer

Todo:
this won't work with current-path-relative URLs like "subdir/foo.html", etc.
Parameters
string$urlEither fully-qualified or a local path + query
string | int | null$defaultProtoOne of the PROTO_* constants. Determines the protocol to use if $url or $wgServer is protocol-relative
Returns
string|false Fully-qualified URL, current-path-relative URL or false if no valid URL can be constructed

Definition at line 512 of file GlobalFunctions.php.

References $wgCanonicalServer, $wgHttpsPort, $wgInternalServer, $wgRequest, $wgServer, PROTO_CANONICAL, PROTO_CURRENT, PROTO_HTTP, PROTO_HTTPS, PROTO_INTERNAL, wfAssembleUrl(), wfParseUrl(), and wfRemoveDotSegments().

Referenced by MWHttpRequest\__construct(), DumpCategoriesAsRdf\addDumpHeader(), ApiQuerySiteinfo\appendGeneralInfo(), ApiQuerySiteinfo\appendInterwikiMap(), ApiQuerySiteinfo\appendRightsInfo(), EmailNotification\composeCommonMailtext(), ApiQueryExternalLinks\execute(), SpecialApiHelp\execute(), ApiQueryLangLinks\execute(), ApiQueryIWLinks\execute(), CdnCacheUpdate\expand(), ApiQueryInfo\extractPageInfo(), CoreParserFunctions\filepath(), MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\footerHtml(), ApiParse\formatIWLinks(), ApiParse\formatLangLinks(), File\getCanonicalUrl(), Title\getCanonicalURL(), SpecialVersion\getEntryPointInfo(), RevertAction\getFormFields(), File\getFullUrl(), Title\getFullURL(), OutputPage\getHeadLinksArray(), ApiQueryImageInfo\getInfo(), LocalRepo\getInfo(), Title\getInternalURL(), ApiRsd\getRsdApiList(), FeedItem\getUniqueIdUnescaped(), MediaWiki\Widget\Search\SimpleSearchResultSetWidget\headerHtml(), ForeignAPIRepo\httpGet(), MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\iwIcon(), MediaWiki\main(), RevertAction\onSuccess(), RSSFeed\outHeader(), AtomFeed\outHeader(), RSSFeed\outItem(), AtomFeed\outItem(), OutputPage\output(), SpecialUploadStash\outputRemoteScaledThumb(), MediaWiki\performAction(), FileDeleteForm\prepareMessage(), ApiMainTest\provideExceptionErrors(), CSSMin\remapOne(), ApiQuerySiteinfoTest\rightsInfoProvider(), ApiQueryExtLinksUsage\run(), ApiOpenSearch\search(), SearchSuggestion\setSuggestedTitle(), EditPage\showIntro(), ApiMain\substituteResultWithError(), ApiQuerySiteinfoTest\testInterwikiMap(), SpecialSearchTest\testSubPageRedirect(), WfExpandUrlTest\testWfExpandUrl(), File\transform(), MediaWiki\tryNormaliseRedirect(), wfExpandIRI(), wfGetServerUrl(), and wfStreamThumb().

◆ wfFindFile()

◆ wfForeignMemcKey()

wfForeignMemcKey (   $db,
  $prefix,
  $args 
)

Make a cache key for a foreign DB.

Must match what wfMemcKey() would produce in context of the foreign wiki.

Parameters
string$db
string$prefix
string...$args
Returns
string

Definition at line 2575 of file GlobalFunctions.php.

References $args, and ObjectCache\getLocalClusterInstance().

Referenced by ForeignDBRepo\getSharedCacheKey(), and GlobalTest\testWfForeignMemcKey().

◆ wfFormatStackFrame()

wfFormatStackFrame (   $frame)

Return a string representation of frame.

Parameters
array$frame
Returns
string

Definition at line 1509 of file GlobalFunctions.php.

Referenced by wfGetCaller().

◆ wfGetAllCallers()

wfGetAllCallers (   $limit = 3)

Return a string consisting of callers in the stack.

Useful sometimes for profiling specific points.

Parameters
int$limitThe maximum depth of the stack frame to return, or false for the entire stack.
Returns
string

Definition at line 1494 of file GlobalFunctions.php.

References wfDebugBacktrace().

Referenced by MediaWiki\Session\SessionBackend\addData(), MediaWiki\Session\SessionBackend\dirty(), RequestContext\getTitle(), MessageCache\parse(), OutputPage\parserOptions(), and MediaWiki\Session\SessionBackend\renew().

◆ wfGetCache()

wfGetCache (   $cacheType)

Get a specific cache object.

Deprecated:
since 1.32, use ObjectCache::getInstance() instead
Parameters
int | string$cacheTypeA CACHE_* constants, or other key in $wgObjectCaches
Returns
BagOStuff

Definition at line 2978 of file GlobalFunctions.php.

References ObjectCache\getInstance().

Referenced by JobQueue\__construct(), SpecialVersion\getCreditsForExtension(), CacheHelper\initCaching(), ForkController\initChild(), and CacheHelper\saveCache().

◆ wfGetCaller()

wfGetCaller (   $level = 2)

Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie.

FUNCTION) wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller() wfGetCaller( 3 ) is the parent of that.

Parameters
int$level
Returns
string

Definition at line 1478 of file GlobalFunctions.php.

References wfDebugBacktrace(), and wfFormatStackFrame().

Referenced by StubObject\_unstub(), DeferredUpdates\addCallableUpdate(), MediaWikiTestCase\assertSelect(), WfGetCallerTest\callerOne(), ParserTestRunner\checkSetupDone(), ParserTestTopLevelSuite\debug(), MediaWiki\Shell\Command\execute(), WfGetCallerTest\intermediateFunction(), MWDebug\log(), WfGetCallerTest\testZero(), MediaWiki\HeaderCallback\warnIfHeadersSent(), wfShellExec(), and wfShellExecWithStderr().

◆ wfGetDB()

wfGetDB (   $db,
  $groups = [],
  $wiki = false 
)

Get a Database object.

Parameters
int$dbIndex of the connection to get. May be DB_MASTER for the master (for write queries), DB_REPLICA for potentially lagged read queries, or an integer >= 0 for a particular server.
string|string[]$groups Query groups. An array of group names that this query belongs to. May contain a single string if the query is only in one group.
string | bool$wikiThe wiki ID, or false for the current wiki

Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request will always return the same object, unless the underlying connection or load balancer is manually destroyed.

Note 2: use $this->getDB() in maintenance scripts that may be invoked by updater to ensure that a proper database is being updated.

Todo:
Replace calls to wfGetDB with calls to LoadBalancer::getConnection() on an injected instance of LoadBalancer.
Returns
\Wikimedia\Rdbms\Database

Definition at line 2652 of file GlobalFunctions.php.

References wfGetLB().

Referenced by SpecialRandomrootpage\__construct(), MergeHistoryPager\__construct(), SearchDatabase\__construct(), DeletedContribsPager\__construct(), ContribsPager\__construct(), ImageListPager\__construct(), MergeHistory\__construct(), LogPager\__construct(), Block\__construct(), IndexPager\__construct(), Pingback\acquireLock(), OutputPage\addCategoryLinksToLBAndGetResult(), BotPasswordTest\addDBData(), ApiComparePagesTest\addDBDataOnce(), MediaWiki\Session\BotPasswordSessionProviderTest\addDBDataOnce(), LinkCache\addLinkObj(), LogPage\addRelations(), User\addToDatabase(), MediaWikiTestCase\assertSelect(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider\beginSecondaryAccountCreation(), ImageListPager\buildQueryConds(), SpecialPageLanguage\changePageLanguage(), CheckStorage\check(), User\checkAndSetTouched(), Pingback\checkIfSent(), TrackBlobs\checkIntegrity(), User\checkNewtalk(), RevisionDeleter\checkRevisionExistence(), RecompressTracked\checkTrackingTable(), MediaWiki\Tests\Maintenance\DeleteAutoPatrolLogsTest\cleanLoggingTable(), CgzCopyTransaction\commit(), WikiPage\commitRollback(), Title\countRevisionsBetween(), SearchEngineFactory\create(), User\createNew(), ChangesListSpecialPageTest\createUsers(), Block\defaultRetroactiveAutoblock(), PrefixSearch\defaultSearchBackend(), ChangeTags\defineTag(), UserGroupMembership\delete(), MediaWiki\Block\BlockRestriction\delete(), SearchMySQL\delete(), Block\delete(), Article\delete(), MediaWiki\Block\BlockRestriction\deleteByBlockId(), MediaWiki\Block\BlockRestriction\deleteByParentBlockId(), DifferenceEngine\deletedLink(), User\deleteNewtalk(), ChangeTags\deleteTagEverywhere(), Title\deleteTitleProtection(), SpecialUndelete\diffHeader(), RecompressTracked\doAllOrphans(), RecompressTracked\doAllPages(), UsersPager\doBatchLookups(), CategoryViewer\doCategoryQuery(), FileDeleteForm\doDelete(), WikiPage\doDeleteArticleBatched(), SpecialExport\doExport(), SpecialRecentChangesLinked\doMainQuery(), RecompressTracked\doOrphanList(), RecompressTracked\doPage(), PopulateInterwiki\doPopulate(), UserCache\doQuery(), GenderCache\doQuery(), LinkBatch\doQuery(), MovePageForm\doSubmit(), WikiPage\doUpdateRestrictions(), LinkHolderArray\doVariants(), Title\estimateRevisionCount(), ApiSetNotificationTimestamp\execute(), ParserTestsMaintenance\execute(), QueryPage\fetchFromCache(), HistoryAction\fetchRevisions(), ChangesListSpecialPageTest\fetchUsers(), TrackBlobs\findOrphanBlobs(), User\findUsersByGroup(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\finishAccountCreation(), RecompressTracked\finishIncompleteMoves(), DoubleRedirectJob\fixRedirects(), EditPageTest\forceRevisionDate(), ApiEditPageTest\forceRevisionDate(), ApiResult\formatExpiry(), Language\formatExpiry(), DoubleRedirectsPage\formatResult(), LCStoreDB\get(), User\getActorId(), MediaWiki\Interwiki\ClassicInterwikiLookup\getAllPrefixesDB(), PageProps\getAllProperties(), Title\getAuthorsBetween(), ContentHandler\getAutoDeleteReason(), EditPage\getBaseRevision(), SpecialBlockList\getBlockListPager(), Block\getBlocksForIPList(), Title\getBrokenLinksFrom(), QueryPage\getCachedTimestamp(), Title\getCascadeProtectionSources(), WikiPage\getCategories(), RCDatabaseLogEntry\getComment(), ResourceLoaderWikiModule\getContentObj(), WikiPage\getContributors(), RevDelRevisionList\getCurrent(), AllMessagesTablePager\getCustomisedStatuses(), RangeChronologicalPagerTest\getDateRangeCondProvider(), UserRightsProxy\getDB(), BacklinkCache\getDB(), ResourceLoaderWikiModule\getDB(), LinksDeletionUpdate\getDB(), SpecialRecentChanges\getDB(), SpecialWatchlist\getDB(), ApiBase\getDB(), LinksUpdate\getDB(), Maintenance\getDB(), ChangesListSpecialPage\getDB(), LocalRepo\getDBFactory(), User\getEditCount(), ResourceLoaderModule\getFileDependencies(), DoubleRedirectJob\getFinalDestination(), User\getFirstEditTimestamp(), Title\getFirstRevision(), User\getFormerGroups(), WikiPage\getHiddenCategories(), SpecialActiveUsers\getIntroText(), EditPage\getLastDelete(), PageArchive\getLastRevisionId(), SpecialExport\getLinks(), Title\getLinksFrom(), Title\getLinksTo(), DifferenceEngine\getMarkPatrolledLinkInfo(), LocalRepo\getMasterDB(), Category\getMembers(), UserGroupMembership\getMembership(), UserGroupMembership\getMembershipsForUser(), SpecialRandomInCategory\getMinAndMaxForCat(), ApiQuery\getNamedDB(), User\getNewMessageLinks(), Pingback\getOrCreatePingbackId(), SpecialExport\getPagesFromCategory(), SpecialExport\getPagesFromNamespace(), Title\getParentCategories(), PageArchive\getPreviousRevision(), PageProps\getProperties(), LinkFilter\getQueryConditions(), WantedPagesPage\getQueryInfo(), BrokenRedirectsPage\getQueryInfo(), NewFilesPager\getQueryInfo(), DeletedContribsPager\getQueryInfo(), MediaStatisticsPage\getQueryInfo(), UncategorizedCategoriesPage\getQueryInfo(), UnwatchedpagesPage\getQueryInfo(), WithoutInterwikiPage\getQueryInfo(), UsersPager\getQueryInfo(), LinkSearchPage\getQueryInfo(), SpecialRandomInCategory\getQueryInfo(), Block\getRangeCond(), QueryPage\getRecacheDB(), Title\getRedirectsHere(), WikiPage\getRedirectTarget(), Title\getRelativeRevisionID(), LocalRepo\getReplicaDB(), PageArchive\getRevision(), PageArchive\getRevisionByConditions(), OutputPage\getRlClient(), Linker\getRollbackEditCount(), Title\getSubpages(), MIMEsearchPage\getSuggestionsForTypes(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\getTestPage(), HistoryBlobStub\getText(), HistoryBlobCurStub\getText(), TrackBlobs\getTextClause(), Title\getTitleProtectionInternal(), Title\getTouched(), SpecialUpload\getUploadForm(), PasswordReset\getUsersByEmail(), LCStoreDB\getWriteConnection(), User\idForName(), User\idFromName(), WikiRevision\importLogItem(), CheckStorage\importRevision(), User\initEditCountInternal(), Block\initFromRow(), Category\initialize(), BackupDumper\initProgress(), TrackBlobs\initTrackingTable(), MediaWiki\Block\BlockRestriction\insert(), UserGroupMembership\insert(), Block\insert(), ManualLogEntry\insert(), MediaWiki\Tests\Maintenance\DeleteAutoPatrolLogsTest\insertLoggingData(), WikiPage\insertProtectNullRevision(), WikiPage\insertRedirect(), WikiPage\insertRedirectEntry(), Title\invalidateCache(), HTMLCacheUpdateJob\invalidateTitles(), WikiPage\isBatchedDelete(), Title\isBigDeletion(), WikiPage\isCountable(), PageArchive\isDeleted(), Title\isDeleted(), Title\isDeletedQuick(), Title\isNewPage(), Title\isSingleRevRedirect(), Block\isWhitelistedFromAutoblocks(), ApiStashEdit\lastEditTime(), LogPager\limitPerformer(), PageArchive\listAllPages(), ChangeTags\listExplicitlyDefinedTags(), PageArchive\listFiles(), PageArchive\listPagesByPrefix(), PageArchive\listPagesBySearch(), PageArchive\listRevisions(), ChangeTags\listSoftwareActivatedTags(), ChangeTags\listSoftwareDefinedTags(), ArchivedFile\load(), MediaWiki\Interwiki\ClassicInterwikiLookup\load(), User\load(), MessageCache\loadCachedMessagePageEntry(), User\loadFromCache(), User\loadFromDatabase(), MessageCache\loadFromDB(), ArchivedFile\loadFromRow(), RecentChange\loadFromRow(), User\loadGroups(), WikiPage\loadLastEdit(), User\loadOptions(), Title\loadRestrictions(), Title\loadRestrictionsFromRows(), DifferenceEngine\loadRevisionData(), WikiPage\lockAndGetLatest(), ProfilerOutputDb\log(), ChangeTags\logTagManagementAction(), LocalIdLookup\lookupCentralIds(), LocalIdLookup\lookupUserNames(), LinkFilter\makeLikeArray(), RevisionDbTestBase\makeRevisionWithProps(), ChangeTags\makeTagSummarySubquery(), Pingback\markSent(), EditPage\mergeChangesIntoContent(), SearchMySQL\minSearchLength(), MovePage\move(), RecompressTracked\moveTextRow(), moveToExternal(), MovePage\moveToInternal(), Title\nameOf(), RecentChange\newFromConds(), User\newFromConfirmationCode(), WikiPage\newFromID(), Block\newFromID(), Title\newFromID(), UserArray\newFromIDs(), Title\newFromIDs(), UserArray\newFromNames(), Block\newLoad(), User\newSystemUser(), ChangesListSpecialPageTest\normalizeCondition(), RecentChange\notifyEdit(), RecentChange\notifyNew(), HistoryAction\onView(), ImagePage\openShowImage(), InfoAction\pageCounts(), ApiStashEdit\parseAndStash(), ClassicInterwikiLookupTest\populateDB(), InterwikiTest\populateDB(), ResourceLoader\preloadModuleInfo(), MediaWiki\Tests\Revision\NoContentModelRevisionStoreDbTest\provideGetSlotsQueryInfo(), CommentStoreTest\provideInsertRoundTrip(), ActorMigrationTest\provideInsertRoundTrip(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\providerChangeAuthenticationData(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\providerChangeAuthenticationData(), MediaWiki\Tests\Revision\RevisionQueryInfoTest\provideSlotsQueryInfo(), ManualLogEntry\publish(), Block\purgeExpired(), Title\purgeExpiredRestrictions(), RecentChangesUpdateJob\purgeExpiredRows(), SpecialPagesWithProp\queryExistingProps(), ImagePage\queryImageLinks(), DoubleRedirectsPage\reallyGetQueryInfo(), RecentChange\reallyMarkPatrolled(), RebuildRecentchanges\rebuildRecentChangesTablePass5(), QueryPage\recache(), MessageBlobStore\recacheMessageBlob(), Category\refreshCounts(), Category\refreshCountsIfEmpty(), ChangeTagsList\reloadFromMaster(), RevDelList\reloadFromMaster(), LinkHolderArray\replaceInternal(), ImportReporter\reportPage(), RevisionListBase\reset(), resolveStub(), resolveStubs(), CheckStorage\restoreText(), DeleteLinksJob\run(), CategoryFinder\run(), MediaWikiTestCase\run(), RecentChange\save(), LogPage\saveContent(), ResourceLoaderModule\saveFileDependencies(), User\saveOptions(), User\saveSettings(), UserNamePrefixSearch\search(), RandomPage\selectRandomPageFromDB(), SpecialRandomInCategory\selectRandomPageFromDB(), RevDelArchivedRevisionItem\setBits(), RevDelArchiveItem\setBits(), RevDelLogItem\setBits(), RevDelArchivedFileItem\setBits(), RevDelRevisionItem\setBits(), RevDelFileItem\setBits(), TestUser\setPasswordForUser(), PagePropsTest\setProperties(), DatabaseIntegrationTest\setUp(), ApiQueryRecentChangesIntegrationTest\setUp(), LinksUpdateTest\setUp(), PageArchiveTestBase\setUp(), ParserTestTopLevelSuite\setUp(), ParserTestRunner\setupDatabase(), ApiLoginTest\setUpForBotPassword(), ApiParseTest\setupInterwiki(), MediaWikiShell\setupLegacy(), RevisionDeleteUser\setUsernameBitfields(), RevDelList\setVisibility(), SpecialAllPages\showChunk(), MovePageForm\showForm(), SpecialWhatLinksHere\showIndirectLinks(), EditPage\showIntro(), LogEventsList\showLogExtract(), Article\showMissingArticle(), Article\showPatrolFooter(), SpecialPrefixindex\showPrefixChunk(), UserOptionsMaintenance\showUsageStats(), SpecialVersion\softwareInformation(), Parser\statelessFetchRevision(), RevDelLogList\suggestTarget(), RecompressTracked\syncDBs(), ChangeTags\tagUsageStatistics(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testAccountCreation(), MediaWiki\Auth\AuthManagerTest\testAccountCreation(), MediaWiki\Auth\AuthManagerTest\testAccountCreationLogging(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testAuthentication(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testAuthentication(), MediaWiki\Auth\AuthManagerTest\testAutoAccountCreation(), ApiBlockTest\testBlockWithEmailBlock(), ApiBlockTest\testBlockWithExpiry(), ApiBlockTest\testBlockWithHide(), ApiBlockTest\testBlockWithTag(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testCountRevisionsByPageId(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testCountRevisionsByTitle(), EditPageTest\testCreatePageTrx(), ChangeTagsTest\testDeleteTags(), ApiDeleteTest\testDeleteWithTag(), WikiPageDbTestBase\testDoDeleteArticle(), WikiPageDbTestBase\testDoDeleteUpdates(), WikiPageDbTestBase\testDoEditContent(), WikiPageDbTestBase\testDoEditUpdates(), SiteStatsUpdateTest\testDoUpdate(), ApiEditPageTest\testEditWithTag(), UserTest\testExperienceLevel(), MediaWiki\Tests\Maintenance\DeleteAutoPatrolLogsTest\testFromId(), ReverseChronologicalPagerTest\testGetDateCond(), TitleTest\testGetFragmentForURL(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testGetParentLengths(), RevisionDbTestBase\testGetParentLengths_multipleRevIds(), RevisionDbTestBase\testGetParentLengths_noRevIds(), RevisionDbTestBase\testGetParentLengths_oneRevId(), BotPasswordTest\testGetPassword(), ResourceLoaderWikiModuleTest\testGetPreloadedBadTitle(), ResourceLoaderWikiModuleTest\testGetPreloadedTitleInfo(), ResourceLoaderWikiModuleTest\testGetPreloadedTitleInfoEmpty(), RevisionDbTestBase\testInsertOn(), RevisionDbTestBase\testInsertOn_exceptionOnIncomplete(), RevisionDbTestBase\testInsertOn_success(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testInsertRevisionOn_archive(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testInsertRevisionOn_blobAddressExists(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testInsertRevisionOn_failures(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testInsertRevisionOn_successes(), ApiQuerySiteinfoTest\testInterwikiMap(), ChangeTagsTest\testListExplicitlyDefinedTags(), RevisionDbTestBase\testLoadFromId(), RevisionDbTestBase\testLoadFromPageId(), RevisionDbTestBase\testLoadFromPageIdWithLatestRevId(), RevisionDbTestBase\testLoadFromPageIdWithNotLatestRevId(), RevisionDbTestBase\testLoadFromTimestamp(), RevisionDbTestBase\testLoadFromTitle(), RevisionDbTestBase\testLoadFromTitleWithLatestRevId(), RevisionDbTestBase\testLoadFromTitleWithNotLatestRevId(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testLoadRevisionFromId(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testLoadRevisionFromPageId(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testLoadRevisionFromTimestamp(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testLoadRevisionFromTitle(), ChangeTagsTest\testModifyDisplayQuery(), RevisionDbTestBase\testNewFromArchiveRow(), RevisionDbTestBase\testNewFromArchiveRowOverrides(), MediaWiki\Session\UserInfoTest\testNewFromId(), RevisionDbTestBase\testNewFromRow(), RevisionDbTestBase\testNewKnownCurrent(), RevisionDbTestBase\testNewKnownCurrent_returnsFalseWhenTitleDoesntExist(), RevisionDbTestBase\testNewKnownCurrent_withPageId(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testNewNullRevision(), RevisionDbTestBase\testNewNullRevision(), RevisionDbTestBase\testNewNullRevision_badPage(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testNewNullRevision_nonExistingTitle(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testNewRevisionFromArchiveRow_getArchiveQueryInfo(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testNewRevisionFromArchiveRow_legacyEncoding(), LBFactoryTest\testNiceDomains(), MessageCacheTest\testNoDBAccess(), ApiStashEditTest\testPageWithNoRevisions(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testProviderChangeAuthenticationData(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testProviderChangeAuthenticationData(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testProviderChangeAuthenticationDataEmail(), ChangesListSpecialPageTest\testRcHidebyothersFilter(), ChangesListSpecialPageTest\testRcHidemyselfFilter(), LBFactoryTest\testRedefineLocalDomain(), MessageCacheTest\testReplaceMsg(), MediaWiki\Tests\Maintenance\DeleteAutoPatrolLogsTest\testRun(), PrefixSearchTest\testSearch(), PrefixSearchTest\testSearchWithOffset(), MultiWriteBagOStuffTest\testSetDelayed(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testSetPasswordResetFlag(), CategoryChangesRdfTest\testSparqlUpdate(), DatabaseIntegrationTest\testStoredFunctions(), MultiWriteBagOStuffTest\testSyncMerge(), ChangeTagsTest\testTagUsageStatistics(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testTestUserCanAuthenticate(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testTestUserCanAuthenticate(), LBFactoryTest\testTrickyDomain(), DeferredUpdatesTest\testTryOpportunisticExecute(), ApiUnblockTest\testUnblockWithTagNewBackend(), PageArchiveTestBase\testUndeleteRevisions(), ApiEditPageTest\testUndoAfterToInvalidRev(), ApiEditPageTest\testUndoWithSwappedRevisions(), ImportTest\testUnknownUserHandling(), EditPageTest\testUpdatePageTrx(), ChangeTagsTest\testUpdateTags(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\testUserCanAuthenticate(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\testUserCanAuthenticate(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\testUserExists(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\testUserExists(), RevisionDbTestBase\testUserWasLastToEdit(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testUserWasLastToEdit_false(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testUserWasLastToEdit_true(), ApiUserrightsTest\testWithTag(), TrackBlobs\trackOrphanText(), TrackBlobs\trackRevisions(), ResourceLoader\tryRespondFromFileCache(), ChangeTags\undefineTag(), PageArchive\undeleteRevisions(), MediaWiki\Block\BlockRestriction\update(), SearchOracle\update(), SearchSqlite\update(), SearchMySQL\update(), Block\update(), RecentChangesUpdateJob\updateActiveUsers(), WikiPage\updateCategoryCounts(), User\updateNewtalk(), UserOptionsMaintenance\updateOptions(), ChangeTags\updateTags(), ChangeTags\updateTagSummaryRow(), ChangeTags\updateTagsWithChecks(), Block\updateTimestamp(), SearchOracle\updateTitle(), SearchSqlite\updateTitle(), SearchMySQL\updateTitle(), ActivityUpdateJob\updateWatchlistNotification(), Revision\userWasLastToEdit(), and ApiTag\validateLogId().

◆ wfGetLangObj()

wfGetLangObj (   $langcode = false)

Return a Language object from $langcode.

Parameters
Language | string | bool$langcodeEither:
  • a Language object
  • code of the language to get the message for, if it is a valid code create a language for that language, if it is a string but not a valid code then make a basic language object
  • a boolean: if it's false then use the global object for the current user's language (as a fallback for the old parameter functionality), or if it is true then use global object for the wiki's content language.
Returns
Language

Definition at line 1239 of file GlobalFunctions.php.

References $wgLang, $wgLanguageCode, Language\factory(), Language\fetchLanguageNames(), and wfDebug().

Referenced by SpecialAllMessages\execute(), MessageCache\get(), ContentHandler\getPageLanguage(), Title\getPageLanguage(), Title\getPageViewLanguage(), ContentHandlerTest\testGetPageLanguage(), and Linker\tocList().

◆ wfGetLB()

wfGetLB (   $wiki = false)

Get a load balancer object.

Deprecated:
since 1.27, use MediaWikiServices::getDBLoadBalancer() or MediaWikiServices::getDBLoadBalancerFactory() instead.
Parameters
string | bool$wikiWiki ID, or false for the current wiki
Returns
\Wikimedia\Rdbms\LoadBalancer

Definition at line 2665 of file GlobalFunctions.php.

Referenced by wfGetDB().

◆ wfGetLBFactory()

wfGetLBFactory ( )

Get the load balancer factory object.

Deprecated:
since 1.27, use MediaWikiServices::getDBLoadBalancerFactory() instead.
Returns
\Wikimedia\Rdbms\LBFactory

Definition at line 2681 of file GlobalFunctions.php.

◆ wfGetMainCache()

◆ wfGetMessageCacheStorage()

wfGetMessageCacheStorage ( )

Get the cache object used by the message cache.

Returns
BagOStuff

Definition at line 2997 of file GlobalFunctions.php.

References $wgMessageCacheType, and ObjectCache\getInstance().

Referenced by UploadFromUrlTestSuite\setUp(), and MessageCache\singleton().

◆ wfGetNull()

wfGetNull ( )

Get a platform-independent path to the null file, e.g.

/dev/null

Returns
string

Definition at line 2780 of file GlobalFunctions.php.

References wfIsWindows().

Referenced by Dump7ZipOutput\setup7zCommand().

◆ wfGetPrecompiledData()

wfGetPrecompiledData (   $name)

Get an object from the precompiled serialized directory.

Parameters
string$name
Returns
mixed The variable on success, false on failure

Definition at line 2541 of file GlobalFunctions.php.

References $blob, $IP, and unserialize().

Referenced by IcuCollation\fetchFirstLetterData().

◆ wfGetRusage()

wfGetRusage ( )

Get system resource usage of current request context.

Invokes the getrusage(2) system call, requesting RUSAGE_SELF if on PHP5 or RUSAGE_THREAD if on HHVM. Returns false if getrusage is not available.

Since
1.24
Returns
array|bool Resource usage data or false if no data available.

Definition at line 3262 of file GlobalFunctions.php.

Referenced by JobRunner\getMaxRssKb(), SectionProfiler\getTime(), and ParserOutput\getTimes().

◆ wfGetScriptUrl()

wfGetScriptUrl ( )

Get the script URL.

Returns
string Script URL

Definition at line 2746 of file GlobalFunctions.php.

◆ wfGetServerUrl()

wfGetServerUrl (   $proto)

Get the wiki's "server", i.e.

the protocol and host part of the URL, with a protocol specified using a PROTO_* constant as in wfExpandUrl()

Since
1.32
Parameters
string | int | null$protoOne of the PROTO_* constants.
Returns
string The URL

Definition at line 590 of file GlobalFunctions.php.

References wfExpandUrl().

Referenced by WebRequest\getFullRequestURL(), and GenerateSitemap\indexEntry().

◆ wfGlobalCacheKey()

wfGlobalCacheKey (   $args)

Make a cache key with database-agnostic prefix.

Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix instead. Must have a prefix as otherwise keys that use a database name in the first segment will clash with wfMemcKey/wfForeignMemcKey.

Deprecated:
since 1.30 Call makeGlobalKey on a BagOStuff instance
Since
1.26
Parameters
string...$args
Returns
string

Definition at line 2592 of file GlobalFunctions.php.

References $args, and ObjectCache\getLocalClusterInstance().

Referenced by GlobalTest\testWfGlobalCacheKey().

◆ wfHostname()

◆ wfHttpError()

wfHttpError (   $code,
  $label,
  $desc 
)

Provide a simple HTTP error.

Parameters
int | string$code
string$label
string$desc

Definition at line 1683 of file GlobalFunctions.php.

References $code, $wgOut, HttpStatus\header(), print, and MediaWiki\HeaderCallback\warnIfHeadersSent().

Referenced by SpecialRunJobs\execute(), RawAction\getRawText(), MWExceptionRenderer\output(), AjaxDispatcher\performAction(), and MWException\report().

◆ wfIncrStats()

wfIncrStats (   $key,
  $count = 1 
)

Increment a statistics counter.

Parameters
string$key
int$count
Returns
void

Definition at line 1185 of file GlobalFunctions.php.

Referenced by ParserCache\get(), DifferenceEngine\getDiffBody(), ParserCache\getKey(), and WikiPage\getParserOutput().

◆ wfIniGetBool()

wfIniGetBool (   $setting)

Safety wrapper around ini_get() for boolean settings.

The values returned from ini_get() are pre-normalized for settings set via php.ini or php_flag/php_admin_flag... but not for those set via php_value/php_admin_value.

It's fairly common for people to use php_value instead of php_flag, which can leave you with an 'off' setting giving a false positive for code that just takes the ini_get() return value as a boolean.

To make things extra interesting, setting via php_value accepts "true" and "yes" as true, but php.ini and php_flag consider them false. :) Unrecognized values go false... again opposite PHP's own coercion from string to bool.

Luckily, 'properly' set settings will always come back as '0' or '1', so we only have to worry about them and the 'improper' settings.

I frickin' hate PHP... :P

Parameters
string$setting
Returns
bool

Definition at line 2104 of file GlobalFunctions.php.

References wfStringToBool().

Referenced by MediaWiki\Http\HttpRequestFactory\canMakeRequests(), MWHttpRequest\canMakeRequests(), MediaWiki\Http\HttpRequestFactory\create(), MWHttpRequestTester\factory(), UploadBase\isEnabled(), WebInstaller\startSession(), and MediaWiki\Session\PHPSessionHandlerTest\testInstall().

◆ wfIsBadImage()

wfIsBadImage (   $name,
  $contextTitle = false,
  $blacklist = null 
)

Determine if an image exists on the 'bad image list'.

The format of MediaWiki:Bad_image_list is as follows:

  • Only list items (lines starting with "*") are considered
  • The first link on a line must be a link to a bad image
  • Any subsequent links on the same line are considered to be exceptions, i.e. articles where the image may occur inline.
Parameters
string$nameThe image name to check
Title | bool$contextTitleThe page on which the image occurs, if known
string | null$blacklistWikitext of a file blacklist
Returns
bool

Definition at line 3052 of file GlobalFunctions.php.

References $cache, $line, $lines, $name, $title, as, ObjectCache\getLocalServerInstance(), Title\newFromText(), Hooks\run(), wfFindFile(), and wfMessage().

Referenced by ApiQueryImageInfo\execute(), GlobalWithDBTest\testWfIsBadImage(), and TraditionalImageGallery\toHTML().

◆ wfIsCLI()

wfIsCLI ( )

◆ wfIsDebugRawPage()

wfIsDebugRawPage ( )

Returns true if debug logging should be suppressed if $wgDebugRawPage = false.

Returns
bool

Definition at line 980 of file GlobalFunctions.php.

References $cache.

Referenced by wfDebug(), and wfLogProfilingData().

◆ wfIsHHVM()

wfIsHHVM ( )

Check if we are running under HHVM.

Returns
bool

Definition at line 1964 of file GlobalFunctions.php.

Referenced by Parser\__construct(), Installer\doEnvironmentChecks(), MWDebug\getDebugInfo(), UploadBase\isEnabled(), and SpecialVersion\softwareInformation().

◆ wfIsInfinity()

wfIsInfinity (   $str)

◆ wfIsWindows()

◆ wfLoadExtension()

wfLoadExtension (   $ext,
  $path = null 
)

Load an extension.

This queues an extension to be loaded through the ExtensionRegistry system.

Parameters
string$extName of the extension to load
string | null$pathAbsolute path of where to find the extension.json file
Since
1.25

Definition at line 45 of file GlobalFunctions.php.

References $path, $wgExtensionDirectory, and ExtensionRegistry\getInstance().

◆ wfLoadExtensions()

wfLoadExtensions ( array  $exts)

Load multiple extensions at once.

Same as wfLoadExtension, but more efficient if you are loading multiple extensions.

If you want to specify custom paths, you should interact with ExtensionRegistry directly.

See also
wfLoadExtension
Parameters
string[]$exts Array of extension names to load
Since
1.25

Definition at line 66 of file GlobalFunctions.php.

References $ext, $wgExtensionDirectory, as, and ExtensionRegistry\getInstance().

◆ wfLoadSkin()

wfLoadSkin (   $skin,
  $path = null 
)

Load a skin.

See also
wfLoadExtension
Parameters
string$skinName of the extension to load
string | null$pathAbsolute path of where to find the skin.json file
Since
1.25

Definition at line 82 of file GlobalFunctions.php.

References $path, $wgStyleDirectory, and ExtensionRegistry\getInstance().

◆ wfLoadSkins()

wfLoadSkins ( array  $skins)

Load multiple skins at once.

See also
wfLoadExtensions
Parameters
string[]$skins Array of extension names to load
Since
1.25

Definition at line 97 of file GlobalFunctions.php.

References $skin, $wgStyleDirectory, as, and ExtensionRegistry\getInstance().

◆ wfLocalFile()

◆ wfLogDBError()

wfLogDBError (   $text,
array  $context = [] 
)

Log for database errors.

Since
1.25 support for additional context data
Parameters
string$textDatabase error message.
array$contextAdditional logging context data

Definition at line 1058 of file GlobalFunctions.php.

References $context.

◆ wfLogProfilingData()

◆ wfLogWarning()

wfLogWarning (   $msg,
  $callerOffset = 1,
  $level = E_USER_WARNING 
)

Send a warning as a PHP error and the debug log.

This is intended for logging warnings in production. For logging development warnings, use WfWarn instead.

Parameters
string$msgMessage to send
int$callerOffsetNumber of items to go back in the backtrace to find the correct caller (1 = function calling wfLogWarning, ...)
int$levelPHP error level; defaults to E_USER_WARNING

Definition at line 1103 of file GlobalFunctions.php.

References MWDebug\warning().

Referenced by ChangesListSpecialPage\areFiltersInConflict(), MediaWiki\Storage\SqlBlobStore\compressData(), Language\convertGrammar(), WikiPage\doDeleteArticleBatched(), Revision\ensureTitle(), MediaWiki\Storage\SqlBlobStore\fetchBlob(), CommentStore\getCommentInternal(), MediaWiki\Special\SpecialPageFactory\getPage(), Revision\getRevisionText(), TextSlotDiffRenderer\getTextDiffInternal(), SiteImporter\handleException(), Html\inlineScript(), ParserOutput\mergeInternalMetaDataFrom(), OutputPage\parserOptions(), OutputPage\transformFilePath(), and wfMkdirParents().

◆ wfMakeUrlIndexes()

wfMakeUrlIndexes (   $url)

Make URL indexes, appropriate for the el_index field of externallinks.

Deprecated:
since 1.33, use LinkFilter::makeIndexes() instead
Parameters
string$url
Returns
array

Definition at line 901 of file GlobalFunctions.php.

References LinkFilter\makeIndexes(), and wfDeprecated().

◆ wfMatchesDomainList()

wfMatchesDomainList (   $url,
  $domains 
)

Check whether a given URL has a domain that occurs in a given set of domains.

Parameters
string$url
array$domainsArray of domains (strings)
Returns
bool True if the host part of $url ends in one of the strings in $domains

Definition at line 912 of file GlobalFunctions.php.

References array(), as, and wfParseUrl().

Referenced by Skin\addToSidebarPlain(), Parser\getExternalLinkRel(), and GlobalTest\testWfMatchesDomainList().

◆ wfMemcKey()

wfMemcKey (   $args)

Make a cache key for the local wiki.

Deprecated:
since 1.30 Call makeKey on a BagOStuff instance
Parameters
string...$args
Returns
string

Definition at line 2561 of file GlobalFunctions.php.

References $args, and ObjectCache\getLocalClusterInstance().

Referenced by PoolWorkArticleView\__construct(), CacheHelper\getCacheKeyString(), MediaWiki\Auth\AuthManagerTest\testAutoAccountCreation(), and GlobalTest\testWfMemcKey().

◆ wfMemoryLimit()

wfMemoryLimit ( )

Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit.

Returns
int Resulting value of the memory limit.

Definition at line 2883 of file GlobalFunctions.php.

References $wgMemoryLimit, wfDebug(), and wfShorthandToInteger().

◆ wfMerge()

wfMerge (   $old,
  $mine,
  $yours,
$result,
$mergeAttemptResult = null 
)

wfMerge attempts to merge differences between three texts.

Returns true for a clean merge and false for failure or a conflict.

Parameters
string$old
string$mine
string$yours
string&$result
string | null&$mergeAttemptResult
Returns
bool

Definition at line 2265 of file GlobalFunctions.php.

References $wgDiff3, wfDebug(), and wfTempDir().

Referenced by TextContentHandler\merge3(), GlobalTest\testMerge(), and GlobalTest\testMerge_worksWithLessParameters().

◆ wfMergeErrorArrays()

wfMergeErrorArrays (   $args)

Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.

wfMergeErrorArrays( [ [ 'x' ] ], [ [ 'x', '2' ] ], [ [ 'x' ] ], [ [ 'y' ] ] ); returns: [ [ 'x', '2' ], [ 'x' ], [ 'y' ] ]

Parameters
array...$args
Returns
array

Definition at line 203 of file GlobalFunctions.php.

References $args, $out, $params, and as.

Referenced by MovePage\checkPermissions(), MergeHistory\checkPermissions(), SpecialImport\execute(), Title\isValidMoveOperation(), SpecialChangeContentModel\onSubmit(), and DifferenceEngine\showDiffPage().

◆ wfMessage()

wfMessage (   $key,
  $params 
)

This is the function for getting translated interface messages.

See also
Message class for documentation how to use them.
https://www.mediawiki.org/wiki/Manual:Messages_API

This function replaces all old wfMsg* functions.

Parameters
string|string[]|MessageSpecifier$key Message key, or array of keys, or a MessageSpecifier
string|string[]...$params Normal message parameters
Returns
Message
Since
1.17
See also
Message::__construct

Definition at line 1288 of file GlobalFunctions.php.

References $params.

Referenced by wfIsBadImage(), and wfShowingResults().

◆ wfMessageFallback()

wfMessageFallback (   $keys)

This function accepts multiple message keys and returns a message instance for the first message which is non-empty.

If all messages are empty then an instance of the first message key is returned.

Parameters
string...$keys Message keys
Returns
Message
Since
1.18
See also
Message::newFallbackSequence

Definition at line 1311 of file GlobalFunctions.php.

References $keys, and Message\newFallbackSequence().

Referenced by SkinTemplate\buildContentNavigationUrls(), FileRepo\getDisplayName(), ImagePage\openShowImage(), and SkinTemplate\tabAction().

◆ wfMkdirParents()

◆ wfMsgReplaceArgs()

wfMsgReplaceArgs (   $message,
  $args 
)

Replace message parameter keys on the given formatted output.

Parameters
string$message
array$args
Returns
string
Access:
private

Definition at line 1323 of file GlobalFunctions.php.

References $args, and as.

Referenced by WikiPage\commitRollback(), MWException\msg(), and MWExceptionRenderer\msg().

◆ wfNegotiateType()

wfNegotiateType (   $cprefs,
  $sprefs 
)

Returns the 'best' match between a client's requested internet media types and the server's list of available types.

Each list should be an associative array of type to preference (preference is a float between 0.0 and 1.0). Wildcards in the types are acceptable.

Parameters
array$cprefsClient's acceptable type list
array$sprefsServer's offered types
Returns
string
Todo:
FIXME: Doesn't handle params like 'text/plain; charset=UTF-8' XXX: generalize to negotiate other stuff

Definition at line 1850 of file GlobalFunctions.php.

References $type, as, and mimeTypeMatch().

Referenced by GlobalTest\testNegotiateType().

◆ wfObjectToArray()

wfObjectToArray (   $objOrArray,
  $recursive = true 
)

Recursively converts the parameter (an object) to an array with the same data.

Parameters
object | array$objOrArray
bool$recursive
Returns
array

Definition at line 252 of file GlobalFunctions.php.

References $value, and as.

◆ wfParseUrl()

wfParseUrl (   $url)

parse_url() work-alike, but non-broken.

Differences:

1) Does not raise warnings on bad URLs (just returns false). 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as protocol-relative URLs) correctly. 3) Adds a "delimiter" element to the array (see (2)). 4) Verifies that the protocol is on the $wgUrlProtocols whitelist. 5) Rejects some invalid URLs that parse_url doesn't, e.g. the empty string or URLs starting with a line feed character.

Parameters
string$urlA URL to parse
Returns
string[]|bool Bits of the URL in an associative array, or false on failure. Possible fields:
  • scheme: URI scheme (protocol), e.g. 'http', 'mailto'. Lowercase, always present, but can be an empty string for protocol-relative URLs.
  • delimiter: either '://', ':' or '//'. Always present.
  • host: domain name / IP. Always present, but could be an empty string, e.g. for file: URLs.
  • user: user name, e.g. for HTTP Basic auth URLs such as http://user:pass@example.com/ Missing when there is no username.
  • pass: password, same as above.
  • path: path including the leading /. Will be missing when empty (e.g. 'http://example.com')
  • query: query string (as a string; see wfCgiToArray() for parsing it), can be missing.
  • fragment: the part after #, can be missing.

Definition at line 814 of file GlobalFunctions.php.

References $wgUrlProtocols.

Referenced by MWHttpRequest\__construct(), DeleteSelfExternals\execute(), ApiAMCreateAccount\execute(), ApiLinkAccount\execute(), ApiClientLogin\execute(), LinkSearchPage\execute(), MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\footerHtml(), WikiMap\getCanonicalServerInfoForAllWikis(), WikiReference\getDisplayName(), WikiMap\getWikiFromUrl(), WikiMap\getWikiWikiReferenceFromSites(), MediaWiki\Widget\Search\SimpleSearchResultSetWidget\headerHtml(), ThumbnailRenderJob\hitThumbUrl(), UploadFromUrl\isAllowedHost(), MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\iwIcon(), LinkFilter\makeIndexes(), LinkFilter\makeLikeArray(), UserMailer\makeMsgId(), ContentSecurityPolicy\prepareUrlForCSP(), WfAssembleUrlTest\provideURLParts(), SquidPurgeClient\queuePurge(), RedisPubSubFeedEngine\send(), AbstractChangesListSpecialPageTestCase\testValidateOptions(), WfParseUrlTest\testWfParseUrl(), MediaWiki\triggerAsyncJobs(), ExtensionJsonValidator\validate(), wfExpandUrl(), and wfMatchesDomainList().

◆ wfPercent()

wfPercent (   $nr,
  $acc = 2,
  $round = true 
)
Parameters
int$nrThe number to format
int$accThe number of digits after the decimal point, default 2
bool$roundWhether or not to round the value, default true
Returns
string

Definition at line 2076 of file GlobalFunctions.php.

References $ret.

Referenced by profile_point\display(), ParserTestPrinter\reportPercentage(), and GlobalTest\testWfPercentTest().

◆ wfQueriesMustScale()

wfQueriesMustScale ( )

Should low-performance queries be disabled?

Returns
bool

Definition at line 2714 of file GlobalFunctions.php.

References $wgMiserMode, SiteStats\edits(), SiteStats\pages(), and SiteStats\users().

◆ wfRandom()

wfRandom ( )

Get a random decimal value in the domain of [0, 1), in a way not likely to give duplicate values for any realistic number of articles.

Note
This is designed for use in relation to Special:RandomPage and the page_random database field.
Returns
string

Definition at line 278 of file GlobalFunctions.php.

Referenced by CompareParserCache\execute(), ResetPageRandom\execute(), RandomPage\getRandomTitle(), SpecialRandomInCategory\getRandomTitle(), WikiPage\insertOn(), ApiQueryRandom\run(), and GlobalTest\testRandom().

◆ wfRandomString()

wfRandomString (   $length = 32)

Get a random string containing a number of pseudo-random hex characters.

Note
This is not secure, if you are trying to generate some sort of token please use MWCryptRand instead.
Parameters
int$lengthThe length of the string to generate
Returns
string
Since
1.20

Definition at line 296 of file GlobalFunctions.php.

Referenced by MockFileBackend\doGetLocalCopyMulti(), JobQueueDB\doPop(), SvgHandler\doTransform(), BenchmarkSanitizer\execute(), BenchmarkLruHash\execute(), MakeTestEdits\execute(), TestUserRegistry\getImmutableTestUser(), MockLocalRepo\getLocalCopy(), MockLocalRepo\getLocalReference(), TestUserRegistry\getMutableTestUser(), WebRequest\getRequestId(), StripState\merge(), UIDGenerator\newUUIDv4(), BenchmarkTitleValue\randomize(), UploadSourceAdapter\registerSource(), FileBackendTest\setUp(), GitInfoTest\setUpBeforeClass(), WANObjectCacheTest\testBusyValue(), WANObjectCacheTest\testCheckKeyInitHoldoff(), GlobalVarConfigTest\testConstructor(), WANObjectCacheTest\testDelete(), ReplicatedBagOStuffTest\testGet(), ReplicatedBagOStuffTest\testGetAbsent(), WANObjectCacheTest\testGetMulti(), WANObjectCacheTest\testGetMultiCheckKeys(), WANObjectCacheTest\testGetMultiWithSetCallback(), WANObjectCacheTest\testGetMultiWithUnionSetCallback(), WANObjectCacheTest\testGetNotExists(), WANObjectCacheTest\testGetWithSetCallback(), WANObjectCacheTest\testGetWithSetCallback_versions(), WANObjectCacheTest\testGetWithSeveralCheckKeys(), GlobalVarConfigTest\testHas(), WANObjectCacheTest\testInterimHoldOffCaching(), WANObjectCacheTest\testLockTSE(), WANObjectCacheTest\testLockTSESlow(), WANObjectCacheTest\testPreemtiveRefresh(), WANObjectCacheTest\testProcessCache(), GlobalTest\testRandomString(), WANObjectCacheTest\testReap(), JobQueueTest\testRootDeduplication(), FileBackendTest\testSanitizeOpHeaders(), ReplicatedBagOStuffTest\testSet(), WANObjectCacheTest\testSetAndGet(), MultiWriteBagOStuffTest\testSetDelayed(), MultiWriteBagOStuffTest\testSetImmediate(), WANObjectCacheTest\testSetOver(), WANObjectCacheTest\testSetWithLag(), WANObjectCacheTest\testStaleSet(), MultiWriteBagOStuffTest\testSyncMerge(), WANObjectCacheTest\testTouchKeys(), and WANObjectCacheTest\testWritePending().

◆ wfReadOnly()

◆ wfReadOnlyReason()

wfReadOnlyReason ( )

Check if the site is in read-only mode and return the message if so.

This checks wfConfiguredReadOnlyReason() and the main load balancer for replica DB lag. This may result in DB connection being made.

Returns
string|bool String when in read-only mode; false otherwise

Definition at line 1208 of file GlobalFunctions.php.

Referenced by ReadOnlyError\__construct(), ProtectionForm\__construct(), ApiQuerySiteinfo\appendGeneralInfo(), MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\checkAccountCreatePermissions(), ApiBase\dieReadOnly(), WikiPage\doUpdateRestrictions(), McrUndoAction\show(), EditPage\showHeader(), ReadOnlyErrorTest\testConstruction(), and GlobalTest\testReadOnlyGlobalChange().

◆ wfRecursiveRemoveDir()

wfRecursiveRemoveDir (   $dir)

◆ wfRelativePath()

wfRelativePath (   $path,
  $from 
)

Generate a relative path name to the given file.

May explode on non-matching case-insensitive paths, funky symlinks, etc.

Parameters
string$pathAbsolute destination path including target filename
string$fromAbsolute source path, directory only
Returns
string

Definition at line 2452 of file GlobalFunctions.php.

References $path, and wfBaseName().

Referenced by DumpUploads\outputItem().

◆ wfRemoveDotSegments()

wfRemoveDotSegments (   $urlPath)

Remove all dot-segments in the provided URL path.

For example, '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see RFC3986 section 5.2.4.

Todo:
Need to integrate this into wfExpandUrl (see T34168)
Since
1.19
Parameters
string$urlPathURL path, potentially containing dot-segments
Returns
string URL path with all dot-segments removed

Definition at line 662 of file GlobalFunctions.php.

References $output.

Referenced by PathRouter\parse(), CSSMin\remapOne(), WfRemoveDotSegmentsTest\testWfRemoveDotSegments(), and wfExpandUrl().

◆ wfReportTime()

wfReportTime (   $nonce = null)

Returns a script tag that stores the amount of time it took MediaWiki to handle the request in milliseconds as 'wgBackendResponseTime'.

If $wgShowHostnames is true, the script will also set 'wgHostname' to the hostname of the server handling the request.

Parameters
string | null$nonceValue from OutputPage::getCSPNonce
Returns
string|WrappedString HTML

Definition at line 1390 of file GlobalFunctions.php.

References $wgShowHostnames, Skin\makeVariablesScript(), and wfHostname().

Referenced by SkinTemplate\prepareQuickTemplate().

◆ wfResetOutputBuffers()

wfResetOutputBuffers (   $resetGzipEncoding = true)

Clear away any user-level output buffers, discarding contents.

Suitable for 'starting afresh', for instance when streaming relatively large amounts of data without buffering, or wanting to output image files without ob_gzhandler's compression.

The optional $resetGzipEncoding parameter controls suppression of the Content-Encoding header sent by ob_gzhandler; by default it is left. See comments for wfClearOutputBuffers() for why it would be used.

Note that some PHP configuration options may add output buffer layers which cannot be removed; these are left in place.

Parameters
bool$resetGzipEncoding

Definition at line 1720 of file GlobalFunctions.php.

References $wgDisableOutputCompression.

Referenced by SpecialExport\execute(), SpecialUploadStash\outputContents(), ResourceLoader\tryRespondNotModified(), and wfClearOutputBuffers().

◆ wfResetSessionID()

wfResetSessionID ( )

Reset the session id.

Deprecated:
since 1.27, use MediaWiki\Session\SessionManager instead
Since
1.22

Definition at line 2494 of file GlobalFunctions.php.

References wfDeprecated(), and wfSetupSession().

◆ wfRestoreWarnings()

wfRestoreWarnings ( )
Deprecated:
since 1.26, use Wikimedia\restoreWarnings() directly Restore error level to previous value

Definition at line 1900 of file GlobalFunctions.php.

◆ wfScript()

wfScript (   $script = 'index')

◆ wfSetBit()

wfSetBit ( $dest,
  $bit,
  $state = true 
)

As for wfSetVar except setting a bit.

Parameters
int&$dest
int$bit
bool$state
Returns
bool

Definition at line 1648 of file GlobalFunctions.php.

◆ wfSetupSession()

wfSetupSession (   $sessionId = false)

Initialise php session.

Deprecated:
since 1.27, use MediaWiki\Session\SessionManager instead. Generally, "using" SessionManager will be calling ->getSessionById() or ::getGlobalSession() (depending on whether you were passing $sessionId here), then calling $session->persist().
Parameters
bool | string$sessionId

Definition at line 2519 of file GlobalFunctions.php.

References wfDeprecated().

Referenced by wfResetSessionID().

◆ wfSetVar()

◆ wfShellExec()

wfShellExec (   $cmd,
$retval = null,
  $environ = [],
  $limits = [],
  $options = [] 
)

Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported.

Parameters
string|string[]$cmd If string, a properly shell-escaped command line, or an array of unescaped arguments, in which case each value will be escaped Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
null | mixed&$retvalOptional, will receive the program's exit code. (non-zero is usually failure). If there is an error from read, select, or proc_open(), this will be set to -1.
array$environOptional environment variables which should be added to the executed command environment.
array$limitsOptional array with limits(filesize, memory, time, walltime) this overwrites the global wgMaxShell* limits.
array$optionsArray of options:
  • duplicateStderr: Set this to true to duplicate stderr to stdout, including errors from limit.sh
  • profileMethod: By default this function will profile based on the calling method. Set this to a string for an alternative method to profile from
Returns
string Collected stdout as a string
Deprecated:
since 1.30 use class MediaWiki\Shell\Shell

Definition at line 2168 of file GlobalFunctions.php.

References $options, array(), and wfGetCaller().

Referenced by UIDGenerator\__construct(), DjVuHandler\doTransform(), ParserTestPrinter\quickDiff(), Maintenance\readlineEmulation(), DjVuImage\retrieveMetaData(), JpegPixelFormatTest\testPixelFormatRendering(), WfShellExecTest\testT69870(), wfShellExecWithStderr(), RandomImageGenerator\writeImageWithApi(), and RandomImageGenerator\writeImageWithCommandLine().

◆ wfShellExecWithStderr()

wfShellExecWithStderr (   $cmd,
$retval = null,
  $environ = [],
  $limits = [] 
)

Execute a shell command, returning both stdout and stderr.

Convenience function, as all the arguments to wfShellExec can become unwieldy.

Note
This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
Parameters
string|string[]$cmd If string, a properly shell-escaped command line, or an array of unescaped arguments, in which case each value will be escaped Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
null | mixed&$retvalOptional, will receive the program's exit code. (non-zero is usually failure)
array$environOptional environment variables which should be added to the executed command environment.
array$limitsOptional array with limits(filesize, memory, time, walltime) this overwrites the global wgMaxShell* limits.
Returns
string Collected stdout and stderr as a string
Deprecated:
since 1.30 use class MediaWiki\Shell\Shell

Definition at line 2221 of file GlobalFunctions.php.

References wfGetCaller(), and wfShellExec().

Referenced by UploadBase\detectVirus(), TransformationalImageHandler\getMagickVersion(), SvgHandler\rasterize(), JpegHandler\rotate(), BitmapHandler\rotate(), JpegHandler\swapICCProfile(), BitmapHandler\transformCustom(), and BitmapHandler\transformImageMagick().

◆ wfShellWikiCmd()

wfShellWikiCmd (   $script,
array  $parameters = [],
array  $options = [] 
)

Generate a shell-escaped command line string to run a MediaWiki cli script.

Note that $parameters should be a flat array and an option with an argument should consist of two consecutive items in the array (do not use "--option value").

Deprecated:
since 1.31, use Shell::makeScriptCommand()
Parameters
string$scriptMediaWiki cli script path
array$parametersArguments and options to the script
array$optionsAssociative array of options: 'php': The path to the php executable 'wrapper': Path to a PHP wrapper to handle the maintenance script
Returns
string

Definition at line 2240 of file GlobalFunctions.php.

References $options, $wgPhpCli, and Hooks\run().

Referenced by CleanupSpam\execute(), and GlobalTest\testWfShellWikiCmd().

◆ wfShorthandToInteger()

wfShorthandToInteger (   $string = '',
  $default = -1 
)

Converts shorthand byte notation to integer form.

Parameters
string$string
int$defaultReturned if $string is empty
Returns
int

Definition at line 2932 of file GlobalFunctions.php.

References $last.

Referenced by Installer\envCheckMemory(), UploadBase\getMaxPhpUploadSize(), WebRequestUpload\isIniSizeOverflow(), WfShorthandToIntegerTest\testWfShorthandToInteger(), GlobalTest\testWfShorthandToInteger(), and wfMemoryLimit().

◆ wfShowingResults()

wfShowingResults (   $offset,
  $limit 
)
Todo:
document
Parameters
int$offset
int$limit
Returns
string

Definition at line 1527 of file GlobalFunctions.php.

References wfMessage().

◆ wfSplitWikiID()

wfSplitWikiID (   $wiki)

Split a wiki ID into DB name and table prefix.

Parameters
string$wiki
Returns
array
Deprecated:
1.32

Definition at line 2619 of file GlobalFunctions.php.

◆ wfStringToBool()

wfStringToBool (   $val)

Convert string value to boolean, when the following are interpreted as true:

  • on
  • true
  • yes
  • Any number, except 0 All other strings are interpreted as false.
Parameters
string$val
Returns
bool
Since
1.31

Definition at line 2120 of file GlobalFunctions.php.

Referenced by WfStringToBoolTest\testStr2Bool(), and wfIniGetBool().

◆ wfStripIllegalFilenameChars()

wfStripIllegalFilenameChars (   $name)

Replace all invalid characters with '-'.

Additional characters can be defined in $wgIllegalFileChars (see T22489). By default, $wgIllegalFileChars includes ':', '/', '\'.

Parameters
string$nameFilename to process
Returns
string

Definition at line 2865 of file GlobalFunctions.php.

References $name, $wgIllegalFileChars, Title\legalChars(), and wfBaseName().

Referenced by UploadBase\getTitle(), and MovePage\isValidFileMove().

◆ wfSuppressWarnings()

wfSuppressWarnings (   $end = false)

Reference-counted warning suppression.

Deprecated:
since 1.26, use Wikimedia\suppressWarnings() directly
Parameters
bool$end

Definition at line 1892 of file GlobalFunctions.php.

◆ wfTempDir()

wfTempDir ( )

Tries to get the system directory for temporary files.

First $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP environment variables are then checked in sequence, then sys_get_temp_dir(), then upload_tmp_dir from php.ini.

NOTE: When possible, use instead the tmpfile() function to create temporary files to avoid race conditions on file creation, etc.

Returns
string

Definition at line 1989 of file GlobalFunctions.php.

References $wgTmpDirectory, and TempFSFile\getUsableTempDirectory().

Referenced by UIDGenerator\__construct(), UploadFromChunks\concatenateChunks(), FileBackendGroup\config(), ParserTestRunner\createRepoGroup(), MockFileBackend\doGetLocalCopyMulti(), FileBackendTest\doTestDoOperationsPipeline(), SvgHandler\doTransform(), ImportableUploadRevisionImporter\downloadSource(), WikiImporter\dumpTemp(), ApiImageRotate\execute(), HHVMMakeRepo\execute(), MediaWikiShell\execute(), MWDocGen\execute(), MockLocalRepo\getLocalCopy(), MockLocalRepo\getLocalReference(), MediaWikiTestCase\getNewTempFile(), ParserEditTests\getOutputFileName(), UIDGenerator\getSequentialPerNodeIDs(), TextSlotDiffRenderer\getTextDiffInternal(), FileBackendGroup\guessMimeInternal(), JobRunner\loadBackoffs(), UploadFromUrl\makeTemporaryFile(), File\makeTransformTmpFile(), ClassicInterwikiLookupTest\populateCDB(), FileBackendTest\provider_testStore(), ParserTestPrinter\quickDiff(), ResourceLoaderImage\rasterize(), CheckStorage\restoreText(), WebPHandlerTest\setUp(), MigrateFileRepoLayoutTest\setUp(), GitInfoTest\setUpBeforeClass(), JobRunner\syncBackoffDeltas(), CSSMinTest\testGetMimeType(), wfDiff(), and wfMerge().

◆ wfThumbIsStandard()

wfThumbIsStandard ( File  $file,
array  $params 
)

Returns true if these thumbnail parameters match one that MediaWiki requests from file description pages and/or parser output.

$params is considered non-standard if they involve a non-standard width or any non-default parameters aside from width and page number. The number of possible files with standard parameters is far less than that of all combinations; rate-limiting for them can thus be more generious.

Parameters
File$file
array$params
Returns
bool
Since
1.24 Moved from thumb.php to GlobalFunctions in 1.25

Definition at line 3155 of file GlobalFunctions.php.

References $handler, $value, $wgImageLimits, $wgResponsiveImages, $wgThumbLimits, as, File\getHandler(), and use.

Referenced by WfThumbIsStandardTest\testIsStandard(), and wfStreamThumb().

◆ wfTimestamp()

wfTimestamp (   $outputtype = TS_UNIX,
  $ts = 0 
)

Get a timestamp string in one of various formats.

Parameters
mixed$outputtypeA timestamp in one of the supported formats, the function will autodetect which format is supplied and act accordingly.
mixed$tsOptional timestamp to convert, default 0 for the current time
Returns
string|bool String / false The same date in the format specified in $outputtype or false

Definition at line 1912 of file GlobalFunctions.php.

References $ret, and wfDebug().

Referenced by Revision\RevisionStoreRecord\__construct(), Revision\RevisionArchiveRecord\__construct(), Block\__construct(), OutputPage\adaptCdnTTL(), DumpCategoriesAsRdf\addDumpHeader(), UserRightsProxy\addGroup(), User\addGroup(), LinkCache\addLinkObj(), ApiMain\addRequestedFields(), ApiQuerySiteinfo\appendExtensions(), ApiQuerySiteinfo\appendGeneralInfo(), ChangesListSpecialPage\buildQuery(), ApiStashEdit\buildStashValue(), FileCacheBase\cacheTimestamp(), ApiStashEdit\checkCache(), ApiMain\checkConditionalRequestHeaders(), AjaxResponse\checkLastModified(), OutputPage\checkLastModified(), WikiPage\commitRollback(), User\confirmationToken(), FileBackendMultiWrite\consistencyCheck(), LanguageWa\date(), Language\date(), DifferenceEngine\debug(), JobRunner\debugCallback(), LocalFile\decodeRow(), SqlBagOStuff\deleteObjectsExpiringBefore(), SpecialUndelete\diffHeader(), MemoryFileBackend\doCopyInternal(), MemoryFileBackend\doCreateInternal(), ApiBaseTest\doGetParameterFromSettings(), DBFileJournal\doLogChangeBatch(), MysqlUpdater\doSchemaRestructuring(), ApiStashEditTest\doStashOld(), MemoryFileBackend\doStoreInternal(), FileBackendTest\doTestGetFileStat(), DefaultPreferencesFactoryTest\emailAuthenticationProvider(), ApiProtect\execute(), ApiUndelete\execute(), ApiMergeHistory\execute(), ApiEditPage\execute(), ApiSetNotificationTimestamp\execute(), ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), SpecialExport\execute(), ApiQueryFilearchive\execute(), RemoveUnusedAccounts\execute(), ApiQueryAllUsers\execute(), ApiQueryImageInfo\execute(), CleanupUploadStash\execute(), FixTimestamps\execute(), ApiFeedWatchlist\execute(), ImportTextFiles\execute(), PurgeParserCache\execute(), UpdateSearchIndex\execute(), BenchmarkParse\execute(), ApiQueryUsers\execute(), GenerateSitemap\execute(), LocalFileRestoreBatch\execute(), JobRunner\executeJob(), UserrightsPage\expiryToTimestamp(), ApiQueryWatchlist\extractOutputData(), ApiQueryInfo\extractPageInfo(), ApiQueryRevisionsBase\extractRevisionInfo(), ApiQueryLogEvents\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), ApiQueryUserContribs\extractRowInfo(), HistoryAction\feedEmpty(), MediaWiki\Logger\LegacyLogger\formatAsWfDebugLog(), FeedUtils\formatDiff(), ApiResult\formatExpiry(), Language\formatExpiry(), SpecialUndelete\formatFileRow(), LogFormatter\formatParameterValueForApi(), SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), RSSFeed\formatTime(), AtomFeed\formatTime(), ImageListPager\formatValue(), BlockListPagerTest\formatValueDefaultProvider(), BlockListPagerTest\formatValueEmptyProvider(), GenerateSitemap\generateLimit(), RevDelArchivedFileItem\getApiData(), RevDelRevisionItem\getApiData(), RevDelFileItem\getApiData(), Block\getAutoblockExpiry(), ApiQueryUserInfo\getBlockInfo(), NewUsersLogFormatter\getComment(), ApiQueryUserInfo\getCurrentUserInfo(), LocalFile\getDescriptionTouched(), User\getExperienceLevel(), ProtectionForm\getExpiry(), FormatMetadata\getExtendedMetadataFromFile(), ApiQueryRecentChangesIntegrationTest\getExternalRC(), ApiQueryWatchlistIntegrationTest\getExternalRC(), User\getFirstEditTimestamp(), ApiQueryImageInfo\getInfo(), SpecialActiveUsers\getIntroText(), LogFormatter\getIRCActionText(), OutputPage\getJSVars(), MachineReadableRCFeedFormatter\getLine(), BlockLogFormatter\getMessageParameters(), PNGMetadataExtractor\getMetadata(), SpecialRandomInCategory\getMinAndMaxForCat(), ApiParamInfo\getModuleInfo(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getNewPasswordExpiry(), BlockLogFormatter\getParametersForApi(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\getPasswordResetData(), PageArchive\getPreviousRevision(), NewFilesPager\getQueryInfo(), ActiveUsersPager\getQueryInfo(), ContribsPager\getQueryInfo(), RawAction\getRawText(), Parser\getRevisionTimestampSubstring(), ApiQuerySearch\getSearchResultData(), ImageHistoryList\getThumbForLine(), MockFSFile\getTimestamp(), FSFile\getTimestamp(), RevisionItemBase\getTimestamp(), ForeignAPIFile\getTimestamp(), DatabaseLogEntry\getTimestamp(), RCDatabaseLogEntry\getTimestamp(), ArchivedFile\getTimestamp(), WikiPage\getTimestamp(), ManualLogEntry\getTimestamp(), FileJournal\getTimestampedUUID(), Revision\RevisionStore\getTimestampFromId(), WANCacheReapUpdate\getTitleChangeEvents(), ResourceLoaderWikiModule\getTitleInfo(), User\getTouched(), Parser\getVariableValue(), ApiQueryInfo\getVisitingWatcherInfo(), ForeignAPIRepo\httpGet(), ImageHistoryList\imageHistoryLine(), UserGroupMembership\initFromRow(), Block\initFromRow(), Language\internalUserTimeAndDate(), User\isEmailConfirmationPending(), SqlBagOStuff\isExpired(), RecentChange\isInRCLifespan(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\isTimestampValid(), User\loadDefaults(), ChangesFeed\loadFromCache(), LocalFile\loadFromCache(), User\loadFromCache(), MessageCache\loadFromDB(), WikiPage\loadFromRow(), RecentChange\loadFromRow(), User\loadFromRow(), SpecialUndelete\loadRequest(), GenerateSitemap\main(), FormatMetadata\makeFormattedData(), MediaWiki\Session\Token\match(), SpecialBlock\maybeAlterFormDefaults(), User\newTouchedTimestamp(), OutputPage\output(), InfoAction\pageCounts(), ApiStashEdit\parseAndStash(), SpecialBlock\parseExpiryInput(), TableCleanup\progress(), ImageBuilder\progress(), ApiMainTest\provideCheckConditionalRequestHeaders(), OutputPageTest\provideCheckLastModified(), ApiBaseTest\provideGetParameterFromSettings(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange(), LanguageTest\provideTranslateBlockExpiry(), LocalFile\publishTo(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), QueryPage\recache(), LocalFile\recordUpload2(), ManageJobs\repushAbandoned(), ApiQueryProtectedTitles\run(), ApiQueryCategories\run(), ApiQueryWatchlistRaw\run(), ApiQueryDuplicateFiles\run(), ApiQueryQueryPage\run(), ApiQueryCategoryMembers\run(), CategoryMembershipChangeJob\run(), RefreshLinksJob\runForTitle(), ChangesFeed\saveToCache(), ApiMain\sendCacheHeaders(), ResourceLoader\sendResponseHeaders(), Block\setCookie(), OutputPage\setLastModified(), Revision\MutableRevisionRecord\setTimestamp(), WikiRevision\setTimestamp(), WikiPage\setTimestamp(), UserGroupMembershipTest\setUp(), PageArchiveTestBase\setUp(), TextPassDumper\showReport(), BackupDumper\showReport(), UpdateLogging\sync(), BlockTest\testAppliesToTitleOnPartialBlock(), BlockTest\testAppliesToTitleReturnsTrueOnSitewideBlock(), UserTest\testAutoblockCookieInfiniteExpiry(), UserTest\testAutoblockCookies(), EditPageTest\testAutoMerge(), ApiBlockTest\testBlockWithExpiry(), ApiMainTest\testCheckConditionalRequestHeadersFailed(), ApiQueryInfoTest\testExecute(), RangeChronologicalPagerTest\testGetDateCond(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testGetNewPasswordExpiry(), PageArchiveTestBase\testGetPreviousRevision(), WfTimestampTest\testHttpDate(), RevisionDbTestBase\testInsertOn(), UserTest\testIpBlockCookieIgnoredWhenUserLoggedIn(), UserTest\testIpBlockCookieNotSet(), UserTest\testIpBlockCookieSet(), UserTest\testIsBlockedFrom(), WfTimestampTest\testNormalTimestamps(), WfTimestampTest\testOldTimestamps(), BlockListPagerTest\testPreprocessResults(), JobQueueTest\testRootDeduplication(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testSetPasswordResetFlag(), BlockTest\testT28425BlockTimestampDefaultsToTime(), WfTimestampTest\testTimestampParameter(), TitlePermissionTest\testUserBlock(), Language\time(), Language\timeanddate(), IPTC\timeHelper(), DatabaseOracle\timestamp(), MediaWiki\Session\Token\toString(), ApiUpload\transformWarnings(), ResourceLoader\tryRespondFromFileCache(), RecentChangesUpdateJob\updateActiveUsers(), WikiPage\updateIfNewerOn(), Block\updateTimestamp(), CategoryChangesAsRdf\updateTS(), ApiStructureTest\validateDefault(), ApiBase\validateTimestamp(), EditPage\wasDeletedSinceLastEdit(), wfStreamThumb(), wfTimestampOrNull(), and XmlDumpWriter\writeTimestamp().

◆ wfTimestampNow()

wfTimestampNow ( )

Convenience function; returns MediaWiki timestamp for the present time.

Returns
string

Definition at line 1941 of file GlobalFunctions.php.

Referenced by LinksDeletionUpdate\__construct(), CategoryMembershipChange\__construct(), EditPageTest\assertEdit(), User\confirmEmail(), MediaWiki\Preferences\DefaultPreferencesFactory\datetimePreferences(), Block\doAutoblock(), SpecialWatchlist\doHeader(), PoolWorkArticleView\doWork(), ApiProtect\execute(), ApiEditPage\execute(), SpecialExport\execute(), MigrateFileRepoLayout\execute(), ResetUserEmail\execute(), ApiUserrights\execute(), ImportTextFiles\execute(), UpdateSearchIndex\execute(), GenerateSitemap\execute(), PPFuzzTest\execute(), LogFormatterTestCase\expandDatabaseRow(), SqlBagOStuff\expireAll(), FormatMetadata\fetchExtendedMetadata(), Title\getCascadeProtectionSources(), MediaWiki\Preferences\DefaultPreferencesFactory\getDateOptions(), Parser\getRevisionTimestamp(), ManualLogEntry\getTimestamp(), ParserOptions\getTimestamp(), EditPage\importFormData(), Revision\RevisionStore\initializeMutableRevisionFromArray(), ManualLogEntry\insert(), HTMLCacheUpdateJob\invalidateTitles(), MessageCache\isCacheExpired(), UserGroupMembership\isExpired(), Block\isExpired(), Title\loadRestrictions(), Title\loadRestrictionsFromRows(), Revision\RevisionStore\newNullRevision(), Job\newRootJobParams(), SpecialLockdb\onSubmit(), SpecialRecentChanges\optionsPanel(), RSSFeed\outHeader(), AtomFeed\outHeader(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), SpecialBlock\processForm(), WikiImporter\processRevision(), ManageJobs\repushAbandoned(), ProtectionForm\save(), ParserCache\save(), LogPage\saveContent(), HTMLFileCache\saveToFileCache(), UserrightsPage\saveUserGroups(), AjaxResponse\storeInMemcached(), EditPageTest\testAutoMerge(), BlockTest\testBlockedUserCanNotCreateAccount(), EditPageTest\testCheckDirectEditingDisallowed_forNonTextContent(), BlockTest\testCrappyCrossWikiBlocks(), MessageTest\testExpiryParams(), RevisionDbTestBase\testGetTimestamp(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testNewNullRevision(), LanguageTest\testSprintfDateNoTtlIfNotNeeded(), BlockTest\testSystemBlocks(), and MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testUserWasLastToEdit_true().

◆ wfTimestampOrNull()

◆ wfTransactionalTimeLimit()

wfTransactionalTimeLimit ( )

Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit.

Returns
int Prior time limit
Since
1.26

Definition at line 2911 of file GlobalFunctions.php.

References $wgTransactionalTimeLimit.

Referenced by RollbackAction\onView(), Action\useTransactionalTimeLimit(), SpecialPage\useTransactionalTimeLimit(), and ApiBase\useTransactionalTimeLimit().

◆ wfUnpack()

wfUnpack (   $format,
  $data,
  $length = false 
)

Wrapper around php's unpack.

Parameters
string$formatThe format string (See php's docs)
string$dataA binary string of binary data
int | bool$lengthThe minimum length of $data or false. This is to prevent reading beyond the end of $data. false to disable the check.

Also be careful when using this function to read unsigned 32 bit integer because php might make it negative.

Exceptions
MWExceptionIf $data not long enough, or if unpack fails
Returns
array Associative array of the extracted data

Definition at line 3016 of file GlobalFunctions.php.

Referenced by JpegMetadataExtractor\doPSIR(), BmpHandler\getImageSize(), XCFHandler\getXCFMetaData(), JpegMetadataExtractor\jpegExtractMarker(), and JpegMetadataExtractor\segmentSplitter().

◆ wfUrlencode()

wfUrlencode (   $s)

We want some things to be included as literal characters in our title URLs for prettiness, which urlencode encodes by default.

According to RFC 1738, all of the following should be safe:

;:&=$-_.+!*'(),

RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved character which should not be encoded. More importantly, google chrome always converts %7E back to ~, and converting it in this function can cause a redirect loop (T105265).

But + is not safe because it's used to indicate a space; &= are only safe in paths and not in queries (and we don't distinguish here); ' seems kind of scary; and urlencode() doesn't touch -_. to begin with. Plus, although / is reserved, we don't care. So the list we unescape is:

;:$!*(),/~

However, IIS7 redirects fail when the url contains a colon (see T24709), so no fancy : for IIS7.

%2F in the page titles seems to fatally break for some reason.

Parameters
string$s
Returns
string

Definition at line 331 of file GlobalFunctions.php.

References $s.

Referenced by Title\__wakeup(), OutputPage\addHelpLink(), CoreParserFunctions\basepagenamee(), FileRepo\getDescriptionRenderUrl(), FileRepo\getDescriptionUrl(), WikiReference\getLocalUrl(), Title\getLocalURL(), MediaWikiSite\getPageUrl(), Title\getPrefixedURL(), LoginSignupSpecialPage\getReturnToQueryStringFragment(), Title\getSubpageUrlForm(), ParserOutput\getText(), Interwiki\getURL(), Parser\getVariableValue(), ApiBase\logFeatureUsage(), ApiMain\logRequest(), Title\makeTitle(), CoreParserFunctions\namespacee(), CoreParserFunctions\nse(), CoreParserFunctions\rootpagenamee(), Title\secureAndSplit(), CoreParserFunctions\speciale(), CoreParserFunctions\subjectspacee(), CoreParserFunctions\talkspacee(), GlobalTest\testUrlencode(), and WfUrlencodeTest\verifyEncodingFor().

◆ wfUrlProtocols()

wfUrlProtocols (   $includeProtocolRelative = true)

Returns a regular expression of url protocols.

Parameters
bool$includeProtocolRelativeIf false, remove '//' from the returned protocol list. DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
Returns
string

Definition at line 740 of file GlobalFunctions.php.

References $wgUrlProtocols, and as.

Referenced by Parser\__construct(), Skin\addToSidebarPlain(), ResourceLoaderStartUpModule\getConfigSettings(), Skin\makeInternalOrExternalUrl(), Sanitizer\safeEncodeAttribute(), Sanitizer\validateAttributes(), and wfUrlProtocolsWithoutProtRel().

◆ wfUrlProtocolsWithoutProtRel()

wfUrlProtocolsWithoutProtRel ( )

Like wfUrlProtocols(), but excludes '//' from the protocol list.

Use this if you need a regex that matches all URL protocols but does not match protocol- relative URLs

Returns
string

Definition at line 785 of file GlobalFunctions.php.

References wfUrlProtocols().

Referenced by Parser\doMagicLinks(), Language\markNoConversion(), and Parser\replaceExternalLinks().

◆ wfVarDump()

wfVarDump (   $var)

A wrapper around the PHP function var_export().

Either print it or add it to the regular output ($wgOut).

Parameters
mixed$varA PHP variable to dump.

Definition at line 1666 of file GlobalFunctions.php.

References $s, $wgOut, and print.

◆ wfWaitForSlaves()

wfWaitForSlaves (   $ifWritesSince = null,
  $wiki = false,
  $cluster = false,
  $timeout = null 
)

Waits for the replica DBs to catch up to the master position.

Use this when updating very large numbers of rows, as in maintenance scripts, to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.

By default this waits on the main DB cluster of the current wiki. If $cluster is set to "*" it will wait on all DB clusters, including external ones. If the lag being waiting on is caused by the code that does this check, it makes since to use $ifWritesSince, particularly if cluster is "*", to avoid excess overhead.

Never call this function after a big DB write that is still in a transaction. This only makes sense after the possible lag inducing changes were committed.

Parameters
float | null$ifWritesSinceOnly wait if writes were done since this UNIX timestamp
string | bool$wikiWiki identifier accepted by wfGetLB
string | bool$clusterCluster name accepted by LBFactory. Default: false.
int | null$timeoutMax wait time. Default: 60 seconds (cli), 1 second (web)
Returns
bool Success (able to connect and no timeouts reached)
Deprecated:
since 1.27 Use LBFactory::waitForReplication

Definition at line 2806 of file GlobalFunctions.php.

Referenced by NamespaceDupes\checkLinkTable(), CleanupUsersWithNoId\cleanup(), CleanupInvalidDbKeys\cleanupTable(), CompressOld\compressWithConcat(), RefreshLinks\deleteLinksFromNonexistent(), RefreshLinks\dfnCheckInterval(), PopulateRecentChangesSource\doDBUpdates(), MigrateActors\doDBUpdates(), PopulateBacklinkNamespace\doDBUpdates(), PopulateFilearchiveSha1\doDBUpdates(), PopulateParentId\doDBUpdates(), FixExtLinksProtocolRelative\doDBUpdates(), PopulateExternallinksIndex60\doDBUpdates(), PopulateArchiveRevId\doDBUpdates(), RefreshExternallinksIndex\doDBUpdates(), PopulateLogSearch\doDBUpdates(), PopulateImageSha1\doDBUpdates(), RefreshLinks\doRefreshLinks(), TidyUpT39714\execute(), RemoveInvalidEmails\execute(), FixUserRegistration\execute(), MakeTestEdits\execute(), DeleteDefaultMessages\execute(), UpdateRestrictions\execute(), InitEditCount\execute(), ConvertUserOptions\execute(), CleanupUploadStash\execute(), RunBatchedQuery\execute(), DeleteBatch\execute(), ResetUserTokens\execute(), MwSql\execute(), UpdateCollation\execute(), PopulateCategory\execute(), UpdateMediaWiki\execute(), RefreshImageMetadata\execute(), DeleteEqualMessages\execute(), ImportImages\execute(), FixDefaultJsonContentPages\handleRow(), MigrateComments\migrate(), MigrateActors\migrate(), MigrateActors\migrateLogSearch(), MigrateComments\migrateToTemp(), MigrateActors\migrateToTemp(), moveToExternal(), PopulateContentModel\populateRevisionOrArchive(), RefreshLinks\refreshCategory(), resolveStubs(), BackupReader\showReport(), UpdateLogging\sync(), TrackBlobs\trackOrphanText(), TrackBlobs\trackRevisions(), and PopulateContentModel\updatePageRows().

◆ wfWarn()

wfWarn (   $msg,
  $callerOffset = 1,
  $level = E_USER_NOTICE 
)

Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.

To log warnings in production, use wfLogWarning() instead.

Parameters
string$msgMessage to send
int$callerOffsetNumber of items to go back in the backtrace to find the correct caller (1 = function calling wfWarn, ...)
int$levelPHP error level; defaults to E_USER_NOTICE; only used when $wgDevelopmentWarnings is true

Definition at line 1090 of file GlobalFunctions.php.

References MWDebug\warning().

Referenced by DatabaseTestHelper\__construct(), TextContent\__construct(), Exif\__construct(), Action\__construct(), MediaWiki\Storage\SqlBlobStore\decompressData(), ApiEditPage\execute(), MediaWiki\Storage\SqlBlobStore\fetchBlob(), ForeignAPIRepo\fileExistsBatch(), Http\get(), MediaWiki\Special\SpecialPageFactory\getAliasList(), CacheHelper\getCachedValue(), WikiPage\getContentModel(), Action\getContext(), DifferenceEngine\getEngine(), ParserCache\getKey(), Revision\RevisionStore\getKnownCurrentRevision(), MediaWiki\Special\SpecialPageFactory\getLocalNameFor(), Language\getMagic(), Revision\SlotRoleRegistry\getRoleHandler(), ChangeTags\getSoftwareTags(), MediaWiki\initializeArticle(), Html\inlineScript(), ResourceLoader\isEmptyObject(), Linker\link(), Html\linkedScript(), Linker\makeBrokenImageLinkObj(), Revision\RevisionStore\newRevisionFromArchiveRow(), Revision\RevisionStore\newRevisionFromRow(), BacklinkJobUtils\partitionBacklinkJob(), Autopromote\recCheckCondition(), and EditPage\showEditForm().

◆ wfWikiID()

wfWikiID ( )

Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.

Returns
string

Definition at line 2602 of file GlobalFunctions.php.

References $wgDBname, and $wgDBprefix.

Referenced by ApiMain\__construct(), ApiQuerySiteinfo\appendGeneralInfo(), Revision\RevisionStore\checkDatabaseWikiId(), UserDupes\checkDupes(), FileBackendGroup\config(), ParserTestRunner\createRepoGroup(), WikiPage\doDeleteUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), InitEditCount\execute(), AttachLatest\execute(), CopyJobQueue\execute(), SyncFileBackend\execute(), CreateAndPromote\execute(), UpdateSearchIndex\execute(), CleanupInvalidDbKeys\execute(), UpdateMediaWiki\execute(), GenerateSitemap\execute(), FileBackendDBRepoWrapperTest\getMocks(), ApiMain\logRequest(), RecompressTracked\logToFile(), EnqueueJob\newFromLocalJobs(), JobQueueMemoryTest\newJobQueue(), TextPassDumper\openSpawn(), ClassicInterwikiLookupTest\populateHash(), TableCleanup\progress(), WikiMapTest\provideGetWikiIdFromDomain(), LocalFileTest\setUp(), MigrateFileRepoLayoutTest\setUp(), MediaWikiMediaTestCase\setUp(), StoreBatchTest\setUp(), UploadFromUrlTestSuite\setUp(), JobQueueTest\setUp(), FileBackendTest\setUp(), TextPassDumper\showReport(), BackupDumper\showReport(), RecompressTracked\startReplicaProcs(), ExternalStoreMwstore\store(), FileBackendTest\testAsyncWrites(), FileTest\testGenerateBucketsIfNeeded(), ResourceLoaderWikiModuleTest\testGetPreloadedTitleInfo(), FileTest\testGetThumbnailSource(), JobQueueTest\testGetWiki(), LocalIdLookupTest\testIsAttached(), WikiMapTest\testIsCurrentWikiDomain(), LBFactoryTest\testNiceDomains(), FileBackendTest\testReadAffinity(), LBFactoryTest\testRedefineLocalDomain(), and FileBackendTest\testSanitizeOpHeaders().