MediaWiki: includes/GlobalFunctions.php File Reference

MediaWiki: includes/GlobalFunctions.php File Reference
MediaWiki
master
Functions
GlobalFunctions.php File Reference
Global functions used everywhere.
More...
Go to the source code of this file.
Functions
wfAppendQuery
( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters already.
wfArrayInsertAfter
(array $array, array $insert, $after)
Insert an array into another array after the specified key.
wfArrayPlus2d
(array $baseArray, array $newValues)
Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
wfArrayToCgi
( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
wfBacktrace
( $raw=null)
Get a debug backtrace as a string.
wfBaseName
( $path, $suffix='')
Return the final portion of a pathname.
wfBoolToStr
( $value)
Convenience function converts boolean values into "true" or "false" (string) values.
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.
wfClientAcceptsGzip
( $force=false)
Whether the client accept gzip encoding.
wfDebug
( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfDebugBacktrace
( $limit=0)
Safety wrapper for debug_backtrace().
wfDebugLog
( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
wfDeprecated
( $function, $version=false, $component=false, $callerOffset=2)
Logs a warning that a deprecated feature was used.
wfDeprecatedMsg
( $msg, $version=false, $component=false, $callerOffset=2)
Log a deprecation warning with arbitrary message text.
wfEscapeShellArg
(... $args)
Locale-independent version of escapeshellarg()
wfEscapeWikiText
( $input)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
wfFormatStackFrame
( $frame)
Return a string representation of frame.
wfGetAllCallers
( $limit=3)
Return a string consisting of callers in the stack.
wfGetCaller
( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the
wfGetCaller()
call (ie.
wfGetNull
()
Get a platform-independent path to the null file, e.g.
wfGetUrlUtils
()
wfHostname
()
Get host name of the current machine, for use in error reporting.
wfHttpError
( $code, $label, $desc)
Provide a simple HTTP error.
wfIniGetBool
( $setting)
Safety wrapper around ini_get() for boolean settings.
wfIsDebugRawPage
()
Returns true if debug logging should be suppressed if $wgDebugRawPage = false.
wfIsInfinity
( $str)
Determine input string is represents as infinity.
wfLoadExtension
( $ext, $path=null)
Load an extension.
wfLoadExtensions
(array $exts)
Load multiple extensions at once.
wfLoadSkin
( $skin, $path=null)
Load a skin.
wfLoadSkins
(array $skins)
Load multiple skins at once.
wfLogDBError
( $text, array $context=[])
Log for database errors.
wfLogWarning
( $msg, $callerOffset=1, $level=E_USER_WARNING)
Send a warning as a PHP error and the debug log.
wfMemoryLimit
( $newLimit)
Raise PHP's memory limit (if needed).
wfMerge
(string $old, string $mine, string $yours, ?string &$simplisticMergeAttempt, ?string &$mergeLeftovers=null)
wfMerge attempts to merge differences between three texts.
wfMessage
( $key,... $params)
This is the function for getting translated interface messages.
wfMessageFallback
(... $keys)
This function accepts multiple message keys and returns a message instance for the first message which is non-empty.
wfMkdirParents
( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
wfMsgReplaceArgs
( $message, $args)
Replace message parameter keys on the given formatted output.
wfObjectToArray
( $objOrArray, $recursive=true)
Recursively converts the parameter (an object) to an array with the same data.
wfPercent
( $nr, int $acc=2, bool $round=true)
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.
wfRandomString
( $length=32)
Get a random string containing a number of pseudo-random hex characters.
wfRecursiveRemoveDir
( $dir)
Remove a directory and all its content.
wfRelativePath
( $path, $from)
Generate a relative path name to the given file.
wfResetOutputBuffers
( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
wfScript
( $script='index')
Get the URL path to a
MediaWiki
entry point.
wfSetBit
(&$dest, $bit, $state=true)
As for wfSetVar except setting a bit.
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.
wfShellExec
( $cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported.
wfShellExecWithStderr
( $cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
wfShellWikiCmd
( $script, array $parameters=[], array $options=[])
Generate a shell-escaped command line string to run a
MediaWiki
cli script.
wfShorthandToInteger
(?string $string='', int $default=-1)
Converts shorthand byte notation to integer form.
wfStringToBool
( $val)
Convert string value to boolean, when the following are interpreted as true:
wfStripIllegalFilenameChars
( $name)
Replace all invalid characters with '-'.
wfTempDir
()
Tries to get the system directory for temporary files.
wfThumbIsStandard
File
$file, array $params)
Returns true if these thumbnail parameters match one that
MediaWiki
requests from file description pages and/or parser output.
wfTimestamp
( $outputtype=TS::UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfTimestampNow
()
Convenience function; returns
MediaWiki
timestamp for the present time.
wfTimestampOrNull
( $outputtype=TS::UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
wfTransactionalTimeLimit
()
Raise the request time limit to $wgTransactionalTimeLimit.
wfUrlencode
( $s)
We want some things to be included as literal characters in our title URLs for prettiness, which urlencode encodes by default.
wfVarDump
( $var)
A wrapper around the PHP function var_export().
wfWarn
( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
Detailed Description
Global functions used everywhere.
Note
GPL-2.0-or-later
Definition in file
GlobalFunctions.php
Function Documentation
wfAppendQuery()
wfAppendQuery
$url
$query
Append a query string to an existing URL, which may or may not already have query string parameters already.
If so, they will be combined.
Parameters
string
$url
string | array
$query
String or associative array
Returns
string
Definition at line
334
of file
GlobalFunctions.php
References
$url
, and
wfArrayToCgi()
Referenced by
MediaWiki\SpecialPage\SpecialPage\addFeedLinks()
MediaWiki\FileRepo\File\File\appendRequestProvenance()
MediaWiki\Specials\SpecialRedirect\dispatchLog()
MediaWiki\Specials\SpecialRedirect\dispatchPage()
MediaWiki\Specials\SpecialRedirect\dispatchRevision()
MediaWiki\SpecialPage\ContributionsSpecialPage\execute()
MediaWiki\Specials\SpecialApiHelp\execute()
MediaWiki\SpecialPage\LoginSignupSpecialPage\execute()
MediaWiki\SpecialPage\RedirectSpecialPage\execute()
MediaWiki\Specials\SpecialRecentChanges\execute()
MediaWiki\Api\ApiEntryPoint\execute()
ImportSiteScripts\execute()
MediaWiki\Api\ApiHelp\fixHelpLinks()
MediaWiki\FileRepo\FileRepo\getDescriptionRenderUrl()
MediaWiki\Output\OutputPage\getHeadLinksArray()
MediaWiki\Title\Title\getLocalURL()
MediaWiki\Media\ImageHandler\getScriptedTransform()
MediaWiki\Linker\Linker\getUploadUrl()
MediaWiki\ResourceLoader\Image\getUrl()
MediaWiki\FileRepo\ForeignAPIRepo\httpGetCached()
MediaWiki\Linker\Linker\makeThumbLink2()
MediaWiki\FileRepo\FileRepo\makeUrl()
MediaWiki\FileRepo\File\File\modifyClientThumbUrl()
MediaWiki\Import\ImportStreamSource\newFromInterwiki()
, and
MediaWiki\Site\MediaWikiPageNameNormalizer\normalizePageName()
wfArrayInsertAfter()
wfArrayInsertAfter
array
$array
array
$insert
$after
Insert an array into another array after the specified key.
If the key is not present in the input array, it is returned without modification.
Parameters
array
$array
array
$insert
The array to insert.
mixed
$after
The key to insert after.
Returns
array
Deprecated
since 1.46, use ArrayUtils::insertAfter
Definition at line
113
of file
GlobalFunctions.php
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
$baseArray
The array where you want to add the values of $newValues to
array
$newValues
An array with new values
Returns
array The combined array
Since
1.26
Deprecated
since 1.46, use ArrayUtils::arrayPlus2d
Definition at line
1806
of file
GlobalFunctions.php
wfArrayToCgi()
wfArrayToCgi
$array1
$array2
null
$prefix
''
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
"days=7&limit=100". Options in the first array override options in the second. Options set to null or false will not be output.
Parameters
array
$array1
( String|Array )
array | null
$array2
( String|Array )
string
$prefix
Returns
string
Definition at line
242
of file
GlobalFunctions.php
References
wfArrayToCgi()
Referenced by
MediaWiki\Request\WebRequest\appendQueryArray()
MediaWiki\SpecialPage\SpecialPage\checkLoginSecurityLevel()
MediaWiki\Specials\SpecialNewPages\execute()
PopulateInterwiki\fetchLinks()
MediaWiki\Specials\Pager\AllMessagesTablePager\formatValue()
MediaWiki\Title\Title\getCanonicalURL()
MediaWiki\Media\MediaTransformOutput\getDescLinkAttribs()
MediaWiki\SpecialPage\LoginSignupSpecialPage\getFieldDefinitions()
MediaWiki\Actions\FormAction\getForm()
MediaWiki\SpecialPage\FormSpecialPage\getForm()
MediaWiki\Title\Title\getFullURL()
MediaWiki\Title\Title\getInternalURL()
MediaWiki\Title\Title\getLocalURL()
MediaWiki\Specials\SpecialRunJobs\getQuerySignature()
MediaWiki\Skin\Components\SkinComponentUtils\getReturnToParam()
MediaWiki\Installer\WebInstaller\getUrl()
MediaWiki\SpecialPage\AuthManagerSpecialPage\handleReauthBeforeExecute()
MediaWiki\Exception\UserNotLoggedIn\report()
MediaWiki\Actions\PurgeAction\show()
MediaWiki\Output\OutputPage\showPermissionStatus()
MediaWiki\SpecialPage\ChangesListSpecialPage\validateOptions()
wfAppendQuery()
, and
wfArrayToCgi()
wfBacktrace()
wfBacktrace
$raw
null
Get a debug backtrace as a string.
Parameters
bool | null
$raw
If true, the return value is plain text. If false, HTML. Defaults to true if MW_ENTRY_POINT is 'cli', otherwise false.
Returns
string
Since
1.25 Supports $raw parameter.
Definition at line
718
of file
GlobalFunctions.php
References
MW_ENTRY_POINT
, and
wfDebugBacktrace()
wfBaseName()
wfBaseName
$path
$suffix
''
Return the final portion of a pathname.
Reimplemented because PHP5's "basename()" is buggy with multibyte text.
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
$suffix
String to remove if present
Returns
string
Definition at line
1490
of file
GlobalFunctions.php
References
$matches
, and
$path
Referenced by
MediaWiki\Media\Exif\__construct()
FileOpPerfTest\doPerfTest()
MediaWiki\FileRepo\AuthenticatedFileEntryPoint\execute()
ImportImages\execute()
wfRelativePath()
, and
wfStripIllegalFilenameChars()
wfBoolToStr()
wfBoolToStr
$value
Convenience function converts boolean values into "true" or "false" (string) values.
Parameters
bool
$value
Returns
string
Definition at line
1577
of file
GlobalFunctions.php
Referenced by
MediaWiki\Api\ApiRsd\formatRsdApiList()
, and
MediaWiki\Cache\FileCacheBase\isCacheGood()
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
$query
Query string
Returns
string[] Array version of input
Definition at line
287
of file
GlobalFunctions.php
Referenced by
MediaWiki\FileRepo\File\File\appendRequestProvenance()
MediaWiki\Linker\Linker\makeBrokenImageLinkObj()
MediaWiki\Specials\SpecialChangeEmail\onSuccess()
MediaWiki\Output\OutputPage\returnToMain()
MediaWiki\Specials\Helpers\LoginHelper\showReturnToPage()
MediaWiki\Linker\Linker\specialLink()
MediaWiki\Storage\SqlBlobStore\splitBlobAddress()
, and
MediaWiki\Specials\SpecialCreateAccount\successfulAction()
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
$force
Forces another check even if we already have a cached result.
Returns
bool
Definition at line
804
of file
GlobalFunctions.php
References
wfDebug()
Referenced by
MediaWiki\Cache\HTMLFileCache\loadFromFileCache()
, and
MediaWiki\Cache\HTMLFileCache\saveToFileCache()
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
$dest
Destination 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
$context
Additional logging context data
Definition at line
414
of file
GlobalFunctions.php
References
$wgDebugLogPrefix
$wgDebugRawPage
, and
wfIsDebugRawPage()
Referenced by
MediaWiki\Api\ApiMain\__construct()
MediaWiki\Diff\DifferenceEngine\__construct()
MediaWiki\Upload\UploadStashFile\__construct()
MediaWiki\Skin\QuickTemplate\__construct()
MediaWiki\Upload\UploadFromStash\__construct()
MediaWiki\Parser\ParserFactory\__construct()
MediaWiki\Upload\UploadFromChunks\__construct()
MediaWiki\StubObject\StubObject\_unstub()
MediaWiki\Logging\LogPage\actionText()
MediaWiki\Gallery\ImageGalleryBase\add()
MediaWiki\Media\MediaHandler\addMeta()
MediaWiki\Skin\Skin\afterContentHook()
MediaWiki\Linker\Linker\blockLink()
MediaWiki\Output\OutputPage\checkLastModified()
MediaWiki\JobQueue\JobQueueDB\claimOldest()
MediaWiki\FileRepo\LocalRepo\cleanupDeletedBatch()
MediaWiki\Upload\UploadBase\cleanupTempFile()
MediaWiki\Upload\UploadStash\clear()
MediaWiki\MediaWikiEntryPoint\commitMainTransaction()
MediaWiki\Storage\SqlBlobStore\compressData()
MediaWiki\Upload\UploadBase\createFromRequest()
MediaWiki\Import\WikiImporter\debug()
MediaWiki\Export\BaseDump\debug()
RecompressTracked\debug()
MediaWiki\Upload\UploadVerification\detectScript()
MediaWiki\Upload\UploadVerification\detectVirus()
MediaWiki\JobQueue\JobQueueDB\doBatchPushInternal()
MediaWiki\Page\WikiFilePage\doPurge()
MediaWiki\Media\DjVuHandler\doTransform()
MediaWiki\Media\TransformationalImageHandler\doTransform()
MediaWiki\Storage\DerivedPageDataUpdater\doUpdates()
MediaWiki\EditPage\EditPage\edit()
MediaWiki\Specials\SpecialUpload\execute()
MediaWiki\FileRepo\File\LocalFileRestoreBatch\execute()
MediaWiki\Page\Article\fetchRevisionRecord()
MediaWiki\Import\WikiImporter\finishImportPage()
MediaWiki\Media\FormatMetadata\flattenArrayReal()
MediaWiki\FileRepo\FileRepo\freeTemp()
MediaWiki\FileRepo\File\File\generateAndSaveThumb()
MediaWiki\Language\LCStoreCDB\get()
MediaWiki\PoolCounter\PoolCounterConnectionManager\get()
MediaWiki\Context\ContextSource\getContext()
MediaWiki\SpecialPage\SpecialPage\getContext()
MediaWiki\Specials\SpecialVersion\getCreditsForExtension()
MediaWiki\FileRepo\File\File\getDescriptionText()
MediaWiki\FileRepo\File\ForeignDBFile\getDescriptionText()
MediaWiki\Upload\UploadStash\getFile()
MediaWiki\JobQueue\Jobs\DoubleRedirectJob\getFinalDestination()
MediaWiki\Page\WikiFilePage\getForeignCategories()
MediaWiki\Cache\GenderCache\getGenderOf()
MediaWiki\Specials\SpecialUpload\getInitialPageText()
MediaWiki\Media\TransformationalImageHandler\getMagickVersion()
MediaWiki\Context\RequestContext\getMainAndWarn()
MediaWiki\Media\GIFMetadataExtractor\getMetadata()
MediaWiki\Media\PNGMetadataExtractor\getMetadata()
MediaWiki\Request\WebRequestUpload\getName()
MediaWiki\Title\Title\getNsText()
MediaWiki\Media\GIFHandler\getSizeAndMetadata()
MediaWiki\Media\JpegHandler\getSizeAndMetadata()
MediaWiki\Media\PNGHandler\getSizeAndMetadata()
MediaWiki\Media\SvgHandler\getSizeAndMetadata()
MediaWiki\Media\TiffHandler\getSizeAndMetadata()
MediaWiki\Media\DjVuHandler\getSizeAndMetadata()
MediaWiki\FileRepo\ForeignAPIRepo\getThumbError()
MediaWiki\Upload\UploadStashFile\getThumbUrl()
MediaWiki\FileRepo\ForeignAPIRepo\getThumbUrlFromCache()
MediaWiki\Title\Title\getTitleValue()
MediaWiki\FileRepo\File\File\getViewURL()
MediaWiki\Output\OutputPage\haveCacheVaryCookies()
MediaWiki\JobQueue\Jobs\ThumbnailRenderJob\hitThumbUrl()
MediaWiki\FileRepo\ForeignAPIRepo\httpGet()
MediaWiki\EditPage\EditPage\importFormData()
MediaWiki\Import\WikiRevision\importLogItem()
MediaWiki\Cache\FileCacheBase\isCacheGood()
MediaWiki\Shell\Shell\isDisabled()
MediaWiki\Media\DjVuHandler\isEnabled()
MediaWiki\Media\SvgHandler\isEnabled()
MediaWiki\Block\DatabaseBlock\isExpired()
FileDependency\isExpired()
MediaWiki\Media\ExifBitmapHandler\isFileMetadataValid()
MediaWiki\Media\GIFHandler\isFileMetadataValid()
MediaWiki\Media\PNGHandler\isFileMetadataValid()
MediaWiki\Media\WebPHandler\isFileMetadataValid()
MediaWiki\Page\MovePage\isValidMoveTarget()
MediaWiki\SiteStats\SiteStats\loadAndLazyInit()
MediaWiki\User\User\loadFromCache()
MediaWiki\Cache\HTMLFileCache\loadFromFileCache()
MediaWiki\Linker\Linker\makeExternalImage()
MediaWiki\Linker\LinkRenderer\makeExternalLink()
MediaWiki\Linker\Linker\makeImageLink()
MediaWiki\Linker\Linker\makeMediaLinkFile()
MediaWiki\Import\ImportStreamSource\newFromURL()
MediaWiki\Import\WikiImporter\notice()
MediaWiki\Actions\RawAction\onView()
MediaWiki\FileRepo\File\LocalFile\purgeThumbList()
MediaWiki\Media\SvgHandler\rasterize()
MediaWiki\Maintenance\TextPassDumper\readDump()
MediaWiki\Upload\UploadStash\removeFileNoAuth()
MediaWiki\Page\WikiPage\replaceSectionAtRev()
MediaWiki\MediaWikiEntryPoint\restInPeace()
MediaWiki\Media\DjVuImage\retrieveMetaData()
MediaWiki\Media\BitmapHandler\rotate()
MediaWiki\JobQueue\Jobs\DoubleRedirectJob\run()
MediaWiki\Cache\FileCacheBase\saveText()
MediaWiki\Cache\HTMLFileCache\saveToFileCache()
MediaWiki\Media\JpegMetadataExtractor\segmentSplitter()
MediaWiki\Mail\UserMailer\send()
MediaWiki\Output\OutputPage\sendCacheControl()
MediaWiki\Mail\UserMailer\sendInternal()
MediaWiki\Mail\UserMailer\sendWithPear()
MediaWiki\Api\ApiMain\setCacheMode()
MediaWiki\Actions\ViewAction\show()
MediaWiki\FileRepo\LocalRepo\skipWriteOperationIfSha1()
MediaWiki\Upload\UploadStash\stashFile()
MediaWiki\FileRepo\FileRepo\storeBatch()
MediaWiki\Import\WikiImporter\throwXmlError()
MediaWiki\Tidy\RemexDriver\tidy()
MediaWiki\FileRepo\File\File\transform()
MediaWiki\Media\BitmapHandler\transformCustom()
MediaWiki\Media\BitmapHandler\transformGd()
MediaWiki\Media\BitmapHandler\transformImageMagick()
MediaWiki\Media\BitmapHandler\transformImageMagickExt()
MediaWiki\Language\LocalisationCacheBulkLoad\trimCache()
MediaWiki\Page\Article\tryFileCache()
MediaWiki\FileRepo\File\LocalFile\upgradeRow()
MediaWiki\FileRepo\File\OldLocalFile\upgradeRow()
MediaWiki\Revision\RevisionRecord\userCanBitfield()
MediaWiki\Linker\Linker\userLink()
MediaWiki\Linker\Linker\userTalkLink()
MediaWiki\Linker\Linker\userToolLinks()
MediaWiki\Upload\UploadVerification\verifyExtension()
MediaWiki\Upload\UploadVerification\verifyFile()
MediaWiki\Upload\UploadBase\verifyMimeType()
MediaWiki\Api\ApiUpload\verifyUpload()
MediaWiki\Page\Article\view()
MediaWiki\Import\WikiImporter\warn()
wfClientAcceptsGzip()
wfDebugBacktrace()
wfMemoryLimit()
wfMkdirParents()
, and
wfTimestamp()
wfDebugBacktrace()
wfDebugBacktrace
$limit
Safety wrapper for debug_backtrace().
Will return an empty array if debug_backtrace is disabled, otherwise the output from debug_backtrace() (trimmed).
Parameters
int
$limit
This parameter can be used to limit the number of stack frames returned
Returns
array Array of backtrace information
Definition at line
690
of file
GlobalFunctions.php
References
wfDebug()
Referenced by
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
$dest
Destination 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
$context
Additional logging context data
Definition at line
478
of file
GlobalFunctions.php
Referenced by
MediaWiki\MediaWikiEntryPoint\commitMainTransaction()
MediaWiki\Upload\UploadFromChunks\concatenateChunks()
MediaWiki\Media\WebPHandler\decodeLosslessChunkHeader()
MediaWiki\Media\WebPHandler\decodeLossyChunkHeader()
MediaWiki\JobQueue\JobQueueRedis\doAck()
MediaWiki\JobQueue\JobQueueRedis\doBatchPush()
MediaWiki\JobQueue\JobQueueRedis\doPop()
MediaWiki\Media\DjVuHandler\doTransform()
MediaWiki\Media\SvgHandler\doTransform()
MediaWiki\Media\TransformationalImageHandler\doTransform()
MediaWiki\FileRepo\AuthenticatedFileEntryPoint\execute()
CheckUsernames\execute()
MediaWiki\Media\WebPHandler\extractMetadata()
MediaWiki\Media\WebPHandler\extractMetadataFromChunks()
MediaWiki\Message\Message\formatListParam()
MediaWiki\Media\IPTC\getCharset()
MediaWiki\Request\WebResponse\header()
MediaWiki\Media\MediaHandler\logErrorForExternalProcess()
MediaWiki\JobQueue\JobQueueFederated\logException()
MediaWiki\Api\ApiBase\logFeatureUsage()
MediaWiki\Api\ApiMain\logRequest()
MediaWiki\Actions\ActionEntryPoint\maybeDoHttpsRedirect()
MediaWiki\FileRepo\File\LocalFile\move()
MediaWiki\Site\MediaWikiPageNameNormalizer\normalizePageName()
MediaWiki\Media\IPTC\parse()
MediaWiki\Deferred\CdnCacheUpdate\purge()
MediaWiki\Upload\UploadFromUrl\reallyFetchFile()
MediaWiki\Media\MediaHandler\removeBadFile()
MediaWiki\Upload\UploadFromUrl\saveTempFileChunk()
MediaWiki\Request\WebResponse\setCookie()
, and
MediaWiki\Request\WebResponse\statusHeader()
wfDeprecated()
wfDeprecated
$function
$version
false
$component
false
$callerOffset
Logs a warning that a deprecated feature was used.
To write a custom deprecation message, use
wfDeprecatedMsg()
instead.
Parameters
string
$function
Feature that is deprecated.
string | false
$version
Version of
MediaWiki
that the feature was deprecated in (Added in 1.19).
string | bool
$component
Component to which the feature belongs. If false, it is assumed the function is in
MediaWiki
core (Added in 1.19).
int
$callerOffset
How far up the call stack is the original caller. 2 = function that called the function that called wfDeprecated (Added in 1.20).
Exceptions
InvalidArgumentException
If the
MediaWiki
version number specified by $version is neither a string nor false.
Definition at line
517
of file
GlobalFunctions.php
Referenced by
MediaWiki\Search\SearchResultSet\__construct()
MediaWiki\SpecialPage\UnlistedSpecialPage\__construct()
MediaWiki\SpecialPage\IncludableSpecialPage\__construct()
MediaWiki\SpecialPage\SpecialPage\__construct()
MediaWiki\Rest\Handler\Helper\HtmlMessageOutputHelper\__construct()
MediaWiki\Collation\CollationCkb\__construct()
MediaWiki\Rest\Handler\Helper\HtmlOutputRendererHelper\__construct()
MediaWiki\SpecialPage\ContributionsSpecialPage\__construct()
MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper\__construct()
MediaWiki\Search\Entity\SearchResultThumbnail\__construct()
Wikimedia\Message\ListParam\__construct()
Wikimedia\Message\ScalarParam\__construct()
MediaWiki\Specials\Helpers\ImportReporter\__construct()
MediaWiki\Debug\__get()
MediaWiki\User\User\__get()
MediaWiki\Debug\__isset()
MediaWiki\Debug\__set()
MediaWiki\User\User\__set()
MediaWiki\StubObject\DeprecatedGlobal\_newObject()
MediaWiki\Api\ApiModuleManager\addModule()
MediaWiki\Output\OutputPage\addParserOutput()
MediaWiki\Output\OutputPage\addParserOutputContent()
MediaWiki\Output\OutputPage\addParserOutputText()
MediaWiki\ChangeTags\ChangeTags\addTags()
MediaWiki\Xml\Xml\attrib()
MediaWiki\Xml\Xml\buildForm()
MediaWiki\User\TempUser\Pattern\buildLike()
MediaWiki\Html\Html\buttonAttributes()
MediaWiki\User\User\canSendEmail()
MediaWiki\User\ActorMigrationBase\checkDeprecation()
MediaWiki\Feed\FeedUtils\checkFeedOutput()
MediaWiki\Parser\Parsoid\Config\PageConfigFactory\create()
MediaWiki\Search\SearchEngine\defaultNearMatcher()
MediaWiki\ChangeTags\ChangeTags\defineTag()
MediaWiki\ChangeTags\ChangeTags\deleteTagEverywhere()
MediaWiki\Upload\UploadBase\detectScript()
MediaWiki\Upload\UploadBase\detectVirus()
MediaWiki\MediaWikiServices\disableStorageBackend()
MediaWiki\Block\DatabaseBlock\doAutoblock()
MediaWiki\Page\WikiPage\doEditUpdates()
MediaWiki\Language\Language\emphasize()
MediaWiki\Languages\LanguageJa\emphasize()
MediaWiki\Maintenance\Maintenance\error()
MediaWiki\Config\SiteConfiguration\extractAllGlobals()
MediaWiki\Xml\Xml\fieldset()
MediaWiki\Output\OutputPage\forceHideNewSectionLink()
MediaWiki\Config\SiteConfiguration\get()
MediaWiki\Logging\Pager\LogPager\getAction()
MediaWiki\Deferred\LinksUpdate\LinksUpdate\getAddedLinks()
MediaWiki\Config\SiteConfiguration\getAll()
MediaWiki\Profiler\Profiler\getAllowOutput()
MediaWiki\Block\DatabaseBlock\getAutoblockExpiry()
MediaWiki\Page\WikiPage\getAutoDeleteReason()
MediaWiki\Content\ContentHandler\getAutoDeleteReason()
MediaWiki\Block\DatabaseBlock\getBlocksForIPList()
MediaWiki\Config\SiteConfiguration\getBool()
MediaWiki\RecentChanges\RecentChange\getCharacterDifference()
MediaWiki\Logging\LogFormatter\getCommentFormatter()
MediaWiki\Search\SearchEngineConfig\getConfig()
MediaWiki\Logging\LogFormatter\getContentLanguage()
MediaWiki\Request\WebRequest\getCrossSiteCookie()
MediaWiki\Logging\Pager\LogPager\getDay()
Wikimedia\Rdbms\DBAccessObjectUtils\getDBOptions()
MediaWiki\HTMLForm\Field\HTMLFormFieldCloner\getDefault()
MediaWiki\RecentChanges\EnhancedChangesList\getDiffHistLinks()
MediaWiki\Language\Language\getDirMarkEntity()
MediaWiki\ChangeTags\ChangeTags\getDisplayTableName()
MediaWiki\ExternalLinks\ExternalLinksLookup\getExternalLinksForPage()
MediaWiki\Parser\Parsoid\Config\DataAccess\getExternalUrlInfo()
MediaWiki\Parser\ParserOutput\getFileSearchOptions()
MediaWiki\Specials\SpecialVersion\getGitHeadSha1()
MediaWiki\Parser\MagicWord\getId()
MediaWiki\Deferred\LinksUpdate\LinksUpdate\getImages()
MediaWiki\Parser\ParserOutput\getImages()
MediaWiki\User\User\getInstanceForUpdate()
MediaWiki\Parser\ParserOutput\getInterwikiLinks()
MediaWiki\Parser\ParserOutput\getLanguageLinks()
MediaWiki\Logging\LogFormatter\getLinkRenderer()
MediaWiki\Parser\ParserOutput\getLinks()
MediaWiki\Parser\ParserOutput\getLinksSpecial()
MediaWiki\Output\OutputPage\getModules()
MediaWiki\Output\OutputPage\getModuleStyles()
MediaWiki\Logging\Pager\LogPager\getMonth()
MediaWiki\Content\AbstractContent\getNativeData()
MediaWiki\Content\FallbackContent\getNativeData()
MediaWiki\Content\TextContent\getNativeData()
MediaWiki\Logging\Pager\LogPager\getPage()
MediaWiki\Parser\Parser\getPage()
MediaWiki\Title\Title\getPageViewLanguage()
MediaWiki\Logging\Pager\LogPager\getPattern()
MediaWiki\Skin\BaseTemplate\getPersonalTools()
MediaWiki\SpecialPage\AuthManagerSpecialPage\getPreservedParams()
MediaWiki\FileRepo\File\LocalFile\getQueryInfo()
MediaWiki\FileRepo\File\OldLocalFile\getQueryInfo()
Wikimedia\Rdbms\Platform\SQLPlatform\getQueryVerb()
MediaWiki\Content\WikitextContent\getRedirectTargetAndText()
MediaWiki\Deferred\LinksUpdate\LinksUpdate\getRemovedLinks()
MediaWiki\Revision\RevisionStore\getRevisionByTitle()
MediaWiki\Linker\Linker\getRollbackEditCount()
Wikimedia\ObjectCache\BagOStuff\getSegmentationSize()
Wikimedia\ObjectCache\MediumSpecificBagOStuff\getSegmentationSize()
Wikimedia\ObjectCache\BagOStuff\getSegmentedValueMaxSize()
Wikimedia\ObjectCache\MediumSpecificBagOStuff\getSegmentedValueMaxSize()
MediaWiki\Content\ContentHandler\getSlotDiffRendererWithOptions()
MediaWiki\ChangeTags\ChangeTags\getSoftwareTags()
MediaWiki\Logging\Pager\LogPager\getTagInvert()
MediaWiki\ChangeTags\ChangeTags\getTags()
MediaWiki\ChangeTags\ChangeTags\getTagsWithData()
MediaWiki\Parser\ParserOutput\getTemplateIds()
MediaWiki\Parser\ParserOutput\getTemplates()
MediaWiki\User\UserNameUtils\getTempPlaceholder()
MediaWiki\Html\Html\getTextInputAttributes()
MediaWiki\Parser\ParserOutput\getTimestamp()
MediaWiki\Deferred\LinksUpdate\TitleLinksTable\getTitleArray()
MediaWiki\Parser\PPFrame_Hash\getTTL()
MediaWiki\Logging\Pager\LogPager\getType()
MediaWiki\Block\BlockManager\getUserBlock()
MediaWiki\Logging\LogFormatter\getUserEditTracker()
MediaWiki\Specials\SpecialVersion\getVersionLinked()
MediaWiki\Import\WikiImporterFactory\getWikiImporter()
MediaWiki\Logging\Pager\LogPager\getYear()
MediaWiki\Parser\CoreTagHooks\html()
MediaWiki\Feed\ChannelFeed\httpHeaders()
MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper\init()
MediaWiki\Rest\Handler\Helper\HtmlOutputRendererHelper\init()
MediaWiki\User\User\isBlockedFromEmailuser()
MediaWiki\Block\DatabaseBlock\isExemptedFromAutoblocks()
MediaWiki\SpecialPage\SpecialPage\isIncludable()
MediaWiki\Request\WebRequest\isSafeRequest()
MediaWiki\Upload\UploadBase\isThrottled()
MediaWiki\Xml\Xml\label()
MediaWiki\ChangeTags\ChangeTags\listDefinedTags()
MediaWiki\Xml\Xml\listDropdown()
MediaWiki\Xml\Xml\listDropdownOptions()
MediaWiki\Xml\Xml\listDropdownOptionsOoui()
MediaWiki\ChangeTags\ChangeTags\listExplicitlyDefinedTags()
MediaWiki\Message\Message\listParam()
Wikimedia\Message\MessageValue\listParamsOfType()
MediaWiki\ChangeTags\ChangeTags\listSoftwareActivatedTags()
MediaWiki\ChangeTags\ChangeTags\listSoftwareDefinedTags()
MediaWiki\Api\ApiBase\makeMessage()
MediaWiki\ChangeTags\ChangeTags\makeTagSummarySubquery()
MediaWiki\Request\WebRequest\markAsSafeRequest()
MediaWiki\ChangeTags\ChangeTags\modifyDisplayQuery()
MediaWiki\Logging\LogFormatter\newFromEntry()
MediaWiki\Block\DatabaseBlock\newFromID()
MediaWiki\Block\DatabaseBlock\newFromRow()
MediaWiki\Logging\LogFormatter\newFromRow()
MediaWiki\Block\DatabaseBlock\newFromTarget()
MediaWiki\Rest\Handler\Helper\PageRestHelperFactory\newHtmlInputTransformHelper()
MediaWiki\Rest\Handler\Helper\PageRestHelperFactory\newHtmlMessageOutputHelper()
MediaWiki\Rest\Handler\Helper\PageRestHelperFactory\newHtmlOutputRendererHelper()
MediaWiki\Block\DatabaseBlock\newListFromTarget()
MediaWiki\RecentChanges\RecentChange\newLogEntry()
MediaWiki\Search\BaseSearchResultSet\next()
MediaWiki\RecentChanges\RecentChange\notifyEdit()
MediaWiki\RecentChanges\RecentChange\notifyNew()
MediaWiki\Xml\Xml\option()
MediaWiki\Feed\ChannelFeed\outFooter()
MediaWiki\Feed\ChannelFeed\outHeader()
MediaWiki\Feed\ChannelFeed\outItem()
MediaWiki\Feed\ChannelFeed\outXmlHeader()
MediaWiki\Storage\PageEditStash\parseAndCache()
MediaWiki\RecentChanges\RecentChange\parseFromRCType()
MediaWiki\Output\OutputPage\parserOptions()
MediaWiki\RecentChanges\RecentChange\parseToRCType()
MediaWiki\ChangeTags\ChangeTags\purgeTagCacheAll()
MediaWiki\Parser\CoreTagHooks\register()
MediaWiki\RenameUser\RenameuserSQL\rename()
MediaWiki\Parser\Parser\replaceLinkHolders()
MediaWiki\Search\BaseSearchResultSet\rewind()
MediaWiki\Maintenance\Maintenance\runChild()
MediaWiki\Parser\CacheTime\setCacheTime()
MediaWiki\Output\OutputPage\setCategoryLinks()
MediaWiki\Search\setExtensionData()
MediaWiki\Gallery\ImageGalleryBase\setHeights()
MediaWiki\Output\OutputPage\setIndexPolicy()
MediaWiki\Diff\TextSlotDiffRenderer\setLanguage()
MediaWiki\Parser\ParserOutput\setLanguageLinks()
MediaWiki\Output\OutputPage\setLanguageLinks()
MediaWiki\Parser\ParserOutput\setOutputFlag()
MediaWiki\Profiler\Profiler\setProfileID()
MediaWiki\Autoload\AutoloadGenerator\setPsr4Namespaces()
MediaWiki\Output\OutputPage\setRevisionTimestamp()
MediaWiki\Diff\TextSlotDiffRenderer\setStatsdDataFactory()
MediaWiki\Parser\ParserOptions\setSuppressTOC()
MediaWiki\Parser\ParserOutput\setText()
MediaWiki\Parser\ParserOutput\setTimestamp()
MediaWiki\Parser\PPFrame_Hash\setTTL()
MediaWiki\Parser\PPTemplateFrame_Hash\setTTL()
MediaWikiShell\setupLogging()
MediaWiki\Gallery\ImageGalleryBase\setWidths()
MediaWiki\Parser\ParserOptions\setWrapOutputClass()
MediaWiki\Output\OutputPage\showNewSectionLink()
MediaWiki\Cache\UserCache\singleton()
MediaWiki\Config\SiteConfiguration\siteFromDB()
MediaWiki\ChangeTags\ChangeTags\tagUsageStatistics()
Wikimedia\Message\MessageValue\textParamsOfType()
MediaWiki\Output\OutputPage\transformCssMedia()
MediaWiki\Json\JsonCodec\unserialize()
MediaWiki\ChangeTags\ChangeTags\updateTags()
MediaWiki\Block\DatabaseBlock\updateTimestamp()
MediaWiki\Parser\Sanitizer\validateAttributes()
MediaWiki\Rest\Validator\Validator\validateBody()
MediaWiki\Parser\Parsoid\Config\SiteConfig\variants()
MediaWiki\Upload\UploadBase\verifyExtension()
MediaWiki\Output\OutputPage\wrapWikiTextAsInterface()
, and
MediaWiki\Session\PHPSessionHandler\write()
wfDeprecatedMsg()
wfDeprecatedMsg
$msg
$version
false
$component
false
$callerOffset
Log a deprecation warning with arbitrary message text.
A caller description will be appended. If the message has already been sent for this caller, it won't be sent again.
Although there are component and version parameters, they are not automatically appended to the message. The message text should include information about when the thing was deprecated. The component and version are just used to implement $wgDeprecationReleaseLimit.
Since
1.35
Parameters
string
$msg
The message
string | false
$version
Version of
MediaWiki
that the function was deprecated in.
string | bool
$component
Component to which the function belongs. If false, it is assumed the function is in
MediaWiki
core.
int | false
$callerOffset
How far up the call stack is the original caller. 2 = function that called the function that called us. If false, the caller description will not be appended.
Definition at line
548
of file
GlobalFunctions.php
Referenced by
MediaWiki\HTMLForm\HTMLFormField\__construct()
MediaWiki\Api\ApiOptions\__construct()
MediaWiki\Rest\Validator\JsonBodyValidator\__construct()
MediaWiki\Block\AbstractBlock\__construct()
MediaWiki\ChangeTags\ChangeTags\buildTagFilterSelector()
MediaWiki\Block\BlockPermissionChecker\checkBlockPermissions()
MediaWiki\Upload\UploadBase\checkWarnings()
MediaWiki\Watchlist\WatchlistManager\clearTitleUserNotifications()
MediaWiki\DAO\deprecateInvalidCrossWiki()
MediaWiki\Page\WikiPage\doViewUpdates()
MediaWiki\RecentChanges\ChangesList\flag()
MediaWiki\ChangeTags\ChangeTags\formatSummaryRow()
MediaWiki\User\User\getActorId()
MediaWiki\RecentChanges\RecentChange\getAttribute()
MediaWiki\FileRepo\File\File\getDescriptionText()
MediaWiki\FileRepo\File\ForeignDBFile\getDescriptionText()
MediaWiki\FileRepo\File\LocalFile\getDescriptionText()
MediaWiki\FileRepo\File\File\getDimensionsString()
MediaWiki\Site\MediaWikiSite\getFileUrl()
MediaWiki\SpecialPage\ContributionsSpecialPage\getForm()
MediaWiki\Media\MediaHandler\getGeneralLongDesc()
MediaWiki\Media\MediaHandler\getGeneralShortDesc()
MediaWiki\MediaWikiServices\getInstance()
MediaWiki\Media\MediaHandler\getLanguage()
MediaWiki\FileRepo\File\File\getLongDesc()
MediaWiki\HTMLForm\Field\HTMLInfoField\getOOUI()
MediaWiki\MediaWikiServices\getService()
MediaWiki\FileRepo\File\File\getShortDesc()
MediaWiki\Revision\RevisionStore\getTitle()
MediaWiki\SpecialPage\SpecialPageFactory\getUsablePages()
MediaWiki\FileRepo\File\LocalFile\loadFromRow()
MediaWiki\HTMLForm\HTMLForm\loadInputFromParameters()
MediaWiki\User\User\newSystemUser()
MediaWiki\Deferred\LinksUpdate\LinksUpdate\queueRecursiveJobsForTable()
MediaWiki\Api\ApiBase\requirePostedParameters()
MediaWiki\Search\SearchWidgets\DidYouMeanWidget\rewrittenHtml()
MediaWiki\Skin\SkinTemplate\runOnSkinTemplateNavigationHooks()
MediaWiki\Block\AbstractBlock\setTarget()
MediaWiki\RecentChanges\ChangesList\showCharacterDifference()
MediaWiki\Search\SearchWidgets\DidYouMeanWidget\suggestionHtml()
, and
MediaWiki\RecentChanges\ChangesList\userCan()
wfEscapeShellArg()
wfEscapeShellArg
$args
Locale-independent version of escapeshellarg()
Originally, this fixed the incorrect use of single quotes on Windows (
) and the locale problems on Linux in PHP 5.2.6+ (
). The second bug is still open as of 2021.
Parameters
string|string[]
...$args strings to escape and glue together, or a single array of strings parameter
Returns
string
Deprecated
since 1.30 use
MediaWiki
\Shell\Shell::escape()
Definition at line
1269
of file
GlobalFunctions.php
wfEscapeWikiText()
wfEscapeWikiText
$input
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, "" is not used.
Parameters
string | null | false
$input
Text to be escaped
Returns
string
Definition at line
838
of file
GlobalFunctions.php
References
$wgEnableMagicLinks
, and
$wgUrlProtocols
Referenced by
MediaWiki\Title\MalformedTitleException\__construct()
MediaWiki\SpecialPage\ContributionsSpecialPage\addContributionsSubWarning()
MediaWiki\Media\MediaHandler\addMeta()
MediaWiki\Parser\CoreParserFunctions\basepagename()
MediaWiki\Parser\CoreParserFunctions\basepagenamee()
MediaWiki\Specials\SpecialPageLanguage\changePageLanguage()
MediaWiki\Api\ApiMain\checkAsserts()
MediaWiki\EditPage\Constraint\RedirectConstraint\checkConstraint()
MediaWiki\Api\ApiQueryImageInfo\checkParameterNormalise()
MediaWiki\Parser\CoreParserFunctions\contentmodel()
MediaWiki\Api\ApiMain\createPrinterByName()
MediaWiki\Parser\CoreParserFunctions\defaultsort()
MediaWiki\Parser\CoreParserFunctions\displaytitle()
MediaWiki\Page\WikiPage\doDeleteArticleReal()
MediaWiki\Api\ApiMain\errorMessagesFromException()
MediaWiki\Specials\SpecialAuthenticationPopupSuccess\execute()
MediaWiki\Specials\SpecialFileDuplicateSearch\execute()
MediaWiki\Specials\SpecialMergeHistory\execute()
MediaWiki\Specials\SpecialUnblock\execute()
MediaWiki\Api\ApiAMCreateAccount\execute()
MediaWiki\Api\ApiClientLogin\execute()
MediaWiki\Api\ApiComparePages\execute()
MediaWiki\Api\ApiEditPage\execute()
MediaWiki\Api\ApiEmailUser\execute()
MediaWiki\Api\ApiExpandTemplates\execute()
MediaWiki\Api\ApiLinkAccount\execute()
MediaWiki\Api\ApiMergeHistory\execute()
MediaWiki\Api\ApiMove\execute()
MediaWiki\Api\ApiOptionsBase\execute()
MediaWiki\Api\ApiParse\execute()
MediaWiki\Api\ApiProtect\execute()
MediaWiki\Api\ApiQueryAllMessages\execute()
MediaWiki\Api\ApiQueryLogEvents\execute()
MediaWiki\Api\ApiQueryUserContribs\execute()
MediaWiki\Api\ApiUndelete\execute()
MediaWiki\Api\ApiUserrights\execute()
MediaWiki\Api\ApiValidatePassword\execute()
MediaWiki\Api\ApiBase\extractRequestParams()
MediaWiki\Parser\CoreParserFunctions\fullpagename()
MediaWiki\Parser\CoreParserFunctions\fullpagenamee()
MediaWiki\ChangeTags\ChangeTags\getChangeTagList()
MediaWiki\Api\ApiErrorFormatter\getMessageFromException()
MediaWiki\Api\ApiBase\getModuleFromPath()
MediaWiki\Api\ApiBase\getTitleFromTitleOrPageId()
MediaWiki\Api\ApiBase\getTitleOrPageId()
MediaWiki\Api\ApiBase\getWatchlistUser()
MediaWiki\Actions\RollbackAction\handleRollbackRequest()
MediaWiki\EditPage\EditPage\importFormData()
MediaWiki\Specials\SpecialBlock\maybeAlterFormDefaults()
MediaWiki\Api\ApiQueryImageInfo\mergeThumbParams()
MediaWiki\Parser\PPFrame_Hash\newChild()
MediaWiki\Specials\SpecialPasswordReset\onSubmit()
MediaWiki\Specials\SpecialRandomInCategory\onSubmit()
MediaWiki\Specials\SpecialBlock\onSuccess()
MediaWiki\Page\ImagePage\openShowImage()
MediaWiki\Specials\Pager\ImageListPager\outputUserDoesNotExist()
MediaWiki\Parser\CoreParserFunctions\pagename()
MediaWiki\Parser\CoreParserFunctions\pagenamee()
MediaWiki\Api\ApiQueryBase\parsePrefixedTitlePart()
MediaWiki\Specials\SpecialBlock\postHtml()
MediaWiki\Api\ApiMain\reportUnusedParams()
MediaWiki\Parser\CoreParserFunctions\rootpagename()
MediaWiki\Parser\CoreParserFunctions\rootpagenamee()
MediaWiki\Api\ApiQueryRecentChanges\run()
MediaWiki\Api\ApiQueryRevisions\run()
MediaWiki\Api\ApiMain\setupModule()
MediaWiki\Specials\SpecialSearch\showCreateLink()
MediaWiki\Specials\SpecialUndelete\showHistory()
MediaWiki\Page\Article\showMissingArticle()
MediaWiki\Specials\SpecialSearch\showResults()
MediaWiki\SpecialPage\LoginSignupSpecialPage\showSuccessPage()
MediaWiki\EditPage\EditPage\spamPageWithContent()
MediaWiki\Parser\CoreParserFunctions\subjectpagename()
MediaWiki\Parser\CoreParserFunctions\subjectpagenamee()
MediaWiki\Parser\CoreParserFunctions\subpagename()
MediaWiki\Parser\CoreParserFunctions\subpagenamee()
MediaWiki\Parser\CoreParserFunctions\talkpagename()
MediaWiki\Parser\CoreParserFunctions\talkpagenamee()
MediaWiki\Actions\DeleteAction\tempDelete()
MediaWiki\Api\ApiQueryBase\titlePartToKey()
MediaWiki\HTMLForm\Field\HTMLUserTextField\validate()
MediaWiki\Block\UserBlockTarget\validateForCreation()
MediaWiki\Api\ApiFileRevert\validateParameters()
, and
MediaWiki\Preferences\SignatureValidator\validateSignature()
wfFormatStackFrame()
wfFormatStackFrame
$frame
Return a string representation of frame.
Typically, the returned value will be in one of these formats:
method
Fully\Qualified\method
Fully\Qualified\Class->method
Fully\Qualified\Class::method
Parameters
array
$frame
Returns
string
Definition at line
786
of file
GlobalFunctions.php
Referenced by
wfGetAllCallers()
, and
wfGetCaller()
wfGetAllCallers()
wfGetAllCallers
$limit
Return a string consisting of callers in the stack.
Useful sometimes for profiling specific points.
Parameters
int | false
$limit
The maximum depth of the stack frame to return, or false for the entire stack.
Returns
string
Definition at line
767
of file
GlobalFunctions.php
References
wfDebugBacktrace()
, and
wfFormatStackFrame()
Referenced by
MediaWiki\Session\SessionBackend\addData()
MediaWiki\Session\SessionBackend\dirty()
, and
MediaWiki\Session\SessionBackend\renew()
wfGetCaller()
wfGetCaller
$level
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.
The format will be the same as for {
See also
wfFormatStackFrame()
}.
Parameters
int
$level
Returns
string function name or 'unknown'
Definition at line
751
of file
GlobalFunctions.php
References
wfDebugBacktrace()
, and
wfFormatStackFrame()
Referenced by
MediaWiki\StubObject\StubObject\_unstub()
MediaWiki\Deferred\DeferredUpdates\addCallableUpdate()
Wikimedia\Rdbms\DBConnRef\ensureConnection()
MediaWiki\Debug\MWDebug\log()
MediaWiki\Request\HeaderCallback\warnIfHeadersSent()
wfShellExec()
, and
wfShellExecWithStderr()
wfGetNull()
wfGetNull
Get a platform-independent path to the null file, e.g.
/dev/null
Returns
string
Definition at line
1586
of file
GlobalFunctions.php
References
wfIsWindows()
wfGetUrlUtils()
wfGetUrlUtils
Deprecated
since 1.43; get a UrlUtils from services, or construct your own. Warnings since 1.46.
Access: internal
Returns
UrlUtils from services if initialized, otherwise make one from globals
Definition at line
368
of file
GlobalFunctions.php
wfHostname()
wfHostname
Get host name of the current machine, for use in error reporting.
This helps to know which machine in a data center generated the current page.
Returns
string
Definition at line
670
of file
GlobalFunctions.php
References
$wgOverrideHostname
Referenced by
MediaWiki\Logger\Monolog\WikiProcessor\__invoke()
MediaWiki\Api\ApiMain\addRequestedFields()
MediaWiki\Diff\DifferenceEngine\debug()
MediaWiki\Media\DjVuHandler\doTransform()
MediaWiki\Media\SvgHandler\doTransform()
MediaWiki\Media\TransformationalImageHandler\doTransform()
MediaWiki\Logger\LegacyLogger\formatAsWfDebugLog()
MediaWiki\Logger\LegacyLogger\formatAsWfLogDBError()
MediaWiki\Output\OutputPage\getBottomScripts()
MediaWiki\Media\MediaHandler\logErrorForExternalProcess()
MediaWiki\Parser\Parser\makeLimitReport()
, and
MediaWiki\FileRepo\ThumbnailEntryPoint\thumbError()
wfHttpError()
wfHttpError
$code
$label
$desc
Provide a simple HTTP error.
Parameters
int | string
$code
string
$label
string
$desc
Definition at line
989
of file
GlobalFunctions.php
References
$wgOut
Referenced by
MediaWiki\Specials\SpecialJavaScriptTest\execute()
MediaWiki\Specials\SpecialRunJobs\execute()
, and
MediaWiki\Actions\RawAction\getRawText()
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
1231
of file
GlobalFunctions.php
References
wfStringToBool()
Referenced by
MediaWiki\Http\HttpRequestFactory\canMakeRequests()
MediaWiki\Http\MWHttpRequest\canMakeRequests()
MediaWiki\Upload\UploadBase\isEnabled()
, and
MediaWiki\Installer\WebInstaller\startSession()
wfIsDebugRawPage()
wfIsDebugRawPage
Returns true if debug logging should be suppressed if $wgDebugRawPage = false.
Returns
bool
Definition at line
436
of file
GlobalFunctions.php
References
MW_ENTRY_POINT
Referenced by
MediaWiki\Logger\LegacyLogger\__construct()
, and
wfDebug()
wfIsInfinity()
wfIsInfinity
$str
Determine input string is represents as infinity.
Parameters
string
$str
The string to determine
Returns
bool
Since
1.25
Definition at line
1701
of file
GlobalFunctions.php
Referenced by
MediaWiki\Api\ApiQueryBlocks\execute()
MediaWiki\User\UserGroupAssignmentServiceBase\expiryToTimestamp()
MediaWiki\Api\ApiResult\formatExpiry()
MediaWiki\Logging\BlockLogFormatter\getParametersForApi()
MediaWiki\Actions\WatchAction\makeSuccessMessage()
MediaWiki\Specials\SpecialBlock\setParameter()
, and
MediaWiki\Language\Language\translateBlockExpiry()
wfLoadExtension()
wfLoadExtension
$ext
$path
null
Load an extension.
This queues an extension to be loaded through the ExtensionRegistry system.
Parameters
string
$ext
Name of the extension to load
string | null
$path
Absolute path of where to find the extension.json file
Since
1.25
Definition at line
43
of file
GlobalFunctions.php
References
$path
, and
$wgExtensionDirectory
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
64
of file
GlobalFunctions.php
References
$wgExtensionDirectory
wfLoadSkin()
wfLoadSkin
$skin
$path
null
Load a skin.
See also
wfLoadExtension
Parameters
string
$skin
Name of the extension to load
string | null
$path
Absolute path of where to find the skin.json file
Since
1.25
Definition at line
80
of file
GlobalFunctions.php
References
$path
, and
$wgStyleDirectory
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
95
of file
GlobalFunctions.php
References
$wgStyleDirectory
wfLogDBError()
wfLogDBError
$text
array
$context
[]
Log for database errors.
Since
1.25 support for additional context data
Parameters
string
$text
Database error message.
array
$context
Additional logging context data
Definition at line
496
of file
GlobalFunctions.php
wfLogWarning()
wfLogWarning
$msg
$callerOffset
$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
$msg
Message to send
int
$callerOffset
Number of items to go back in the backtrace to find the correct caller (1 = function calling wfLogWarning, ...)
int
$level
PHP error level; defaults to E_USER_WARNING
Definition at line
576
of file
GlobalFunctions.php
Referenced by
MediaWiki\User\User\__get()
MediaWiki\User\User\__set()
MediaWiki\RecentChanges\ChangesListFilterGroupContainer\areFiltersInConflict()
MediaWiki\Storage\SqlBlobStore\compressData()
MediaWiki\Language\Language\convertGrammar()
MediaWiki\Linker\Linker\emailLink()
MediaWiki\Media\FormatMetadata\flattenArrayReal()
MediaWiki\Logging\LogFormatter\formatParametersForApi()
MediaWiki\SpecialPage\SpecialPageFactory\getPage()
MediaWiki\Html\Html\inlineScript()
MediaWiki\Parser\Sanitizer\normalizeSectionNameWhitespace()
, and
MediaWiki\Output\OutputPage\transformFilePath()
wfMemoryLimit()
wfMemoryLimit
$newLimit
Raise PHP's memory limit (if needed).
Access: internal
For use by
Setup.php
Parameters
int
$newLimit
Definition at line
1617
of file
GlobalFunctions.php
References
wfDebug()
, and
wfShorthandToInteger()
wfMerge()
wfMerge
string
$old
string
$mine
string
$yours
?string &
$simplisticMergeAttempt
?string &
$mergeLeftovers
null
wfMerge attempts to merge differences between three texts.
Parameters
string
$old
Common base revision
string
$mine
The edit we wish to store but which potentially conflicts with another edit which happened since we started editing.
string
$yours
The most recent stored revision of the article. Note that "mine" and "yours" might have another meaning depending on the specific use case.
string | null
&$simplisticMergeAttempt
Automatically merged text, with overlapping edits falling back to "my" text.
string | null
&$mergeLeftovers
Optional out parameter containing an "ed" script with the remaining bits of "your" text that could not be merged into $simplisticMergeAttempt. The "ed" file format is documented here:
Returns
bool true for a clean merge and false for failure or a conflict.
Definition at line
1401
of file
GlobalFunctions.php
Referenced by
MediaWiki\Content\TextContentHandler\merge3()
wfMessage()
wfMessage
$key
$params
This is the function for getting translated interface messages.
See also
Message class for documentation how to use them.
This function replaces all old wfMsg* functions.
When the MessageSpecifier object is an instance of Message, a clone of the object is returned. This is unlike the
new Message( … )
constructor, which returns a new object constructed from scratch with the same key. This difference is mostly relevant when the passed object is an instance of a subclass like RawMessage or ApiMessage.
Parameters
string | string[] | MessageSpecifier
$key
Message key, or array of keys, or a MessageSpecifier
MessageParam|MessageSpecifier|string|int|float|list
...$params See Message::params()
Returns
Message
Since
1.17
See also
Message::__construct
Definition at line
602
of file
GlobalFunctions.php
References
wfMessageFallback()
Referenced by
MediaWiki\Title\MalformedTitleException\__construct()
MediaWiki\Media\MediaTransformError\__construct()
MediaWiki\Diff\IncompatibleDiffTypesException\__construct()
MediaWiki\HTMLForm\Field\HTMLAutoCompleteSelectField\__construct()
MediaWiki\Media\TransformParameterError\__construct()
MediaWiki\Media\TransformTooBigImageAreaError\__construct()
MediaWiki\Upload\UploadStashFile\__construct()
MediaWiki\HTMLForm\CollapsibleFieldsetLayout\__construct()
MediaWiki\Widget\DateInputWidget\__construct()
MediaWiki\Widget\SizeFilterWidget\__construct()
MediaWiki\Upload\Exception\UploadChunkVerificationException\__construct()
MediaWiki\Logging\LogPage\actionText()
MediaWiki\Media\MediaHandler\addMeta()
MediaWiki\Content\WikitextContent\addSectionHeader()
MediaWiki\Content\JsonContent\arrayTable()
MediaWiki\Specials\SpecialVersion\arrayToString()
MediaWiki\Auth\AuthManager\beginAccountCreation()
MediaWiki\Auth\AuthManager\beginAccountLink()
MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\beginLinkAttempt()
MediaWiki\Linker\Linker\blockLink()
MediaWiki\Output\OutputPage\buildBacklinkSubtitle()
MediaWiki\Xml\Xml\buildForm()
MediaWiki\RecentChanges\ChangesFeed\buildItems()
MediaWiki\Watchlist\buildTools()
MediaWiki\SpecialPage\SpecialPage\checkLoginSecurityLevel()
MediaWiki\Upload\UploadStash\clear()
MediaWiki\Auth\AuthManager\continueAccountCreation()
MediaWiki\Auth\AuthManager\continueAccountLink()
MediaWiki\Auth\AuthManager\continueAuthentication()
MediaWiki\Upload\UploadFromChunks\continueChunks()
MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\continueLinkAttempt()
MediaWiki\Session\SessionProvider\describe()
MediaWiki\Auth\PasswordAuthenticationRequest\describeCredentials()
MediaWiki\Auth\PasswordDomainAuthenticationRequest\describeCredentials()
MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\describeCredentials()
MediaWiki\Session\SessionProvider\describeMessage()
MediaWiki\Upload\UploadVerification\detectVirus()
MediaWiki\Content\ContentModelChange\doContentModelChange()
MediaWiki\Page\File\FileDeleteForm\doDelete()
MediaWiki\Media\DjVuHandler\doTransform()
MediaWiki\Media\SvgHandler\doTransform()
MediaWiki\Media\TransformationalImageHandler\doTransform()
MediaWiki\Linker\Linker\emailLink()
MediaWiki\Installer\WebInstallerPage\endForm()
MediaWiki\Installer\WebInstallerInstall\endStage()
MediaWiki\Installer\Installer\envCheckDB()
MediaWiki\Maintenance\Maintenance\error()
MediaWiki\Installer\WebInstallerComplete\execute()
MediaWiki\Installer\WebInstallerDBConnect\execute()
MediaWiki\Installer\WebInstallerExistingWiki\execute()
MediaWiki\Installer\WebInstallerInstall\execute()
MediaWiki\Installer\WebInstallerName\execute()
MediaWiki\Installer\WebInstallerRestart\execute()
MediaWiki\Installer\WebInstallerUpgrade\execute()
MediaWiki\Installer\WebInstallerWelcome\execute()
CleanupSpam\execute()
DemoteIneligibleUsers\execute()
DumpIterator\execute()
DumpMessages\execute()
RenameUser\execute()
DumpRenderer\execute()
MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\failResponse()
MediaWiki\ResourceLoader\MessageBlobStore\fetchMessage()
DeleteEqualMessages\fetchMessageInfo()
MediaWiki\Content\FallbackContentHandler\fillParserOutput()
MediaWiki\Content\JsonContentHandler\fillParserOutput()
MediaWiki\RecentChanges\ChangesList\flag()
MediaWiki\Logging\BlockLogFormatter\formatBlockFlag()
MediaWiki\Logging\BlockLogFormatter\formatBlockFlags()
MediaWiki\Feed\FeedUtils\formatDiff()
MediaWiki\Feed\FeedUtils\formatDiffRow2()
MediaWiki\Languages\LanguageZh_hans\formatDuration()
MediaWiki\Page\WikiPage\formatExpiry()
MediaWiki\Linker\Linker\formatHiddenCategories()
MediaWiki\Linker\Linker\formatRevisionSize()
MediaWiki\FileRepo\File\File\generateAndSaveThumb()
MediaWiki\Upload\UploadFromUrl\getAllowedHosts()
MediaWiki\Content\ContentHandler\getAutoDeleteReason()
MediaWiki\Content\ContentHandler\getAutosummary()
MediaWiki\Installer\WebInstaller\getCheckBox()
MediaWiki\Specials\SpecialVersion\getCopyrightAndAuthorList()
MediaWiki\Installer\Task\Task\getDescription()
MediaWiki\Interwiki\Interwiki\getDescription()
MediaWiki\Logging\LogPage\getDescription()
MediaWiki\Config\ConfigRepository\getDescriptionOf()
MediaWiki\Feed\FeedUtils\getDiffLink()
MediaWiki\Media\ImageHandler\getDimensionsString()
MediaWiki\Language\ConverterRule\getDisplay()
MediaWiki\Title\Title\getEditNotices()
MediaWiki\Specials\SpecialUpload\getExistsWarning()
MediaWiki\Specials\SpecialVersion\getExtensionTypes()
MediaWiki\Auth\ConfirmLinkAuthenticationRequest\getFieldInfo()
MediaWiki\Auth\CreationReasonAuthenticationRequest\getFieldInfo()
MediaWiki\Auth\PasswordAuthenticationRequest\getFieldInfo()
MediaWiki\Auth\PasswordDomainAuthenticationRequest\getFieldInfo()
MediaWiki\Auth\RememberMeAuthenticationRequest\getFieldInfo()
MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\getFieldInfo()
MediaWiki\Auth\UserDataAuthenticationRequest\getFieldInfo()
MediaWiki\Auth\UsernameAuthenticationRequest\getFieldInfo()
MediaWiki\Installer\WebInstallerPage\getFieldsetStart()
MediaWiki\Upload\UploadStash\getFile()
MediaWiki\Installer\WebInstallerDocument\getFileContents()
MediaWiki\Upload\UploadBase\getFilenamePrefixBlacklist()
MediaWiki\Collation\IcuCollation\getFirstLetter()
MediaWiki\Collation\NumericUppercaseCollation\getFirstLetter()
MediaWiki\Media\MediaHandler\getGeneralLongDesc()
MediaWiki\User\UserGroupMembership\getGroupPage()
MediaWiki\Installer\WebInstaller\getHelpBox()
MediaWiki\Installer\MysqlConnectForm\getHtml()
MediaWiki\Installer\PostgresConnectForm\getHtml()
MediaWiki\Installer\WebInstaller\getInfoBox()
MediaWiki\Specials\SpecialUpload\getInitialPageText()
MediaWiki\Installer\DatabaseConnectForm\getInstallUserBox()
MediaWiki\Logging\LogFormatter\getIRCActionComment()
MediaWiki\Logging\LogFormatter\getIRCActionText()
MediaWiki\Content\ContentHandler\getLocalizedName()
MediaWiki\Media\ImageHandler\getLongDesc()
MediaWiki\Media\SvgHandler\getLongDesc()
MediaWiki\Media\GIFHandler\getLongDesc()
MediaWiki\Media\PNGHandler\getLongDesc()
MediaWiki\Specials\FormFields\Licenses\getMessageFromParams()
MediaWiki\Exception\ErrorPageError\getMessageObject()
MediaWiki\Title\MalformedTitleException\getMessageObject()
MediaWiki\Installer\CliInstaller\getMessageText()
MediaWiki\Interwiki\Interwiki\getName()
MediaWiki\Logging\LogPage\getName()
MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider\getPasswordResetData()
MediaWiki\EditPage\EditPage\getPreviewLimitReport()
MediaWiki\Installer\WebInstaller\getRadioElements()
MediaWiki\Logging\LogPage\getRcComment()
MediaWiki\Logging\LogPage\getRcCommentIRC()
MediaWiki\Installer\DatabaseInstaller\getReadableName()
MediaWiki\Block\DatabaseBlock\getRedactedName()
MediaWiki\Utils\MWTimestamp\getRelativeTimestamp()
MediaWiki\User\User\getRightDescription()
MediaWiki\User\User\getRightDescriptionHtml()
MediaWiki\Media\ImageHandler\getShortDesc()
MediaWiki\Utils\MWTimestamp\getTimezoneMessage()
MediaWiki\Specials\SpecialVersion\getVersion()
MediaWiki\Media\FormatMetadata\getVisibleFields()
MediaWiki\Installer\DatabaseSettingsForm\getWebUserBox()
MediaWiki\LinkedData\PageDataRequestHandler\handleRequest()
MediaWiki\Title\Title\hasSourceText()
MediaWiki\Skin\QuickTemplate\haveMsg()
MediaWiki\LinkedData\PageDataRequestHandler\httpContentNegotiation()
MediaWiki\Upload\UploadStash\initFile()
MediaWiki\Upload\UploadFromStash\initialize()
MediaWiki\Page\WikiPage\insertNullProtectionRevision()
MediaWiki\Diff\DifferenceEngine\intermediateEditsMsg()
MediaWiki\Parser\Parser\interwikiTransclude()
MediaWiki\Parser\CoreParserFunctions\intFunction()
MediaWiki\Page\MovePage\isValidMove()
MediaWiki\Installer\WebInstaller\label()
MediaWiki\Upload\UploadStash\listFiles()
MediaWiki\User\BotPassword\login()
MediaWiki\Linker\LinkRenderer\makeBrokenLink()
MediaWiki\Linker\Linker\makeImageLink()
MediaWiki\Api\ApiBase\makeMessage()
MediaWiki\Linker\LinkRenderer\makeRedirectHeader()
MediaWiki\Linker\Linker\makeThumbLink2()
MediaWiki\Page\MergeHistory\merge()
MediaWiki\Exception\MWException\msg()
MediaWiki\Context\DerivativeContext\msg()
MediaWiki\Context\RequestContext\msg()
MediaWiki\HTMLForm\HTMLFormField\msg()
MediaWiki\Skin\QuickTemplate\msg()
MediaWiki\Search\SearchEngineConfig\namespacesAsText()
MediaWiki\Html\Html\namespaceSelectorOptions()
MediaWiki\Title\Title\newMainPage()
MediaWiki\Import\WikiImporter\notice()
MediaWiki\Content\JsonContent\objectTable()
MediaWiki\Actions\RawAction\onView()
MediaWiki\Installer\WebInstallerOutput\outputFooter()
MediaWiki\Installer\WebInstallerOutput\outputTitle()
MediaWiki\Search\SearchEngine\parseNamespacePrefixes()
MediaWiki\Page\WikiPage\protectDescription()
MediaWiki\Maintenance\TextPassDumper\readDump()
MediaWiki\Language\LanguageConverter\recursiveConvertRule()
MediaWiki\Upload\UploadStash\removeFile()
MediaWiki\Content\WikitextContent\replaceSection()
MediaWiki\Linker\Linker\revDeleteLink()
MediaWiki\Linker\Linker\revDeleteLinkDisabled()
MediaWiki\Linker\Linker\revUserLink()
MediaWiki\Linker\Linker\revUserTools()
MediaWiki\JobQueue\Jobs\DoubleRedirectJob\run()
MediaWiki\Storage\PageUpdater\saveRevision()
MediaWiki\User\User\sendMail()
MediaWiki\Import\WikiImporter\setTargetRootPage()
MediaWiki\Installer\WebInstaller\showError()
MediaWiki\Installer\WebInstallerExistingWiki\showKeyForm()
MediaWiki\Installer\WebInstaller\showMessage()
MediaWiki\Installer\WebInstaller\showSuccess()
MediaWiki\Installer\WebInstaller\showWarning()
MediaWiki\Linker\Linker\specialLink()
MediaWiki\Installer\WebInstallerInstall\startStage()
MediaWiki\Upload\UploadStash\stashFile()
MediaWiki\Parser\Parser\statelessFetchTemplate()
MediaWiki\Installer\WebInstallerName\submit()
MediaWiki\Installer\WebInstallerOptions\submit()
MediaWiki\Auth\ThrottlePreAuthenticationProvider\testForAccountCreation()
MediaWiki\Auth\ThrottlePreAuthenticationProvider\testForAuthentication()
MediaWiki\Gallery\TraditionalImageGallery\toHTML()
MediaWiki\FileRepo\File\File\transform()
MediaWiki\FileRepo\File\File\transformErrorOutput()
MediaWiki\Media\BitmapHandler\transformGd()
MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\tryReset()
MediaWiki\Storage\PageUpdater\updateRevision()
MediaWiki\Linker\Linker\userLink()
MediaWiki\Linker\Linker\userTalkLink()
MediaWiki\Linker\Linker\userToolLinks()
MediaWiki\Page\Article\view()
MediaWiki\Session\CookieSessionProvider\whyNoSession()
MediaWiki\Session\ImmutableSessionProviderWithCookie\whyNoSession()
, and
MediaWiki\CommentFormatter\CommentFormatter\wrapCommentWithBlock()
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 last message key is returned.
Parameters
string
...$keys Message keys
Returns
Message
Since
1.18
See also
Message::newFallbackSequence
Definition at line
630
of file
GlobalFunctions.php
Referenced by
MediaWiki\FileRepo\FileRepo\getDisplayName()
MediaWiki\Page\ImagePage\openShowImage()
MediaWiki\Skin\SkinTemplate\tabAction()
, and
wfMessage()
wfMkdirParents()
wfMkdirParents
$dir
$mode
null
$caller
null
Make directory, and make all parent directories if they don't exist.
Parameters
string
$dir
Full path to directory to create. Callers should make sure this is not a storage path.
int | null
$mode
Chmod value to use, default is $wgDirectoryMode
string | null
$caller
Optional caller param for debugging.
Returns
bool
Definition at line
1143
of file
GlobalFunctions.php
References
$wgDirectoryMode
, and
wfDebug()
Referenced by
MediaWiki\Cache\FileCacheBase\checkCacheDirs()
MediaWiki\Media\DjVuHandler\doTransform()
MediaWiki\Media\SvgHandler\doTransform()
MediaWiki\Media\TransformationalImageHandler\doTransform()
GenerateSitemap\execute()
MediaWiki\Utils\GitInfo\precomputeValues()
MediaWiki\Language\LCStoreCDB\startWrite()
, and
MediaWiki\Language\LCStoreStaticArray\startWrite()
wfMsgReplaceArgs()
wfMsgReplaceArgs
$message
$args
Replace message parameter keys on the given formatted output.
Parameters
string
$message
array
$args
Returns
string
Access: internal
Definition at line
642
of file
GlobalFunctions.php
Referenced by
MediaWiki\Exception\MWException\msg()
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
125
of file
GlobalFunctions.php
References
wfObjectToArray()
Referenced by
wfObjectToArray()
wfPercent()
wfPercent
$nr
int
$acc
bool
$round
true
Parameters
float | int
$nr
The number to format
int
$acc
The number of digits after the decimal point, default 2
bool
$round
Whether or not to round the value, default true
Returns
string
Definition at line
1202
of file
GlobalFunctions.php
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
151
of file
GlobalFunctions.php
Referenced by
CompareParserCache\execute()
ResetPageRandom\execute()
MediaWiki\Specials\SpecialRandomInCategory\getRandomTitle()
MediaWiki\Specials\SpecialRandomPage\getRandomTitle()
MediaWiki\Page\WikiPage\insertOn()
MediaWiki\Title\Title\invalidateCache()
, and
MediaWiki\Api\ApiQueryRandom\run()
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
$length
The length of the string to generate
Returns
string
Since
1.20
Definition at line
169
of file
GlobalFunctions.php
Referenced by
MediaWiki\JobQueue\JobQueueDB\doPop()
MediaWiki\Media\SvgHandler\doTransform()
BenchmarkLruHash\execute()
BenchmarkSanitizer\execute()
MakeTestEdits\execute()
MediaWiki\Http\Telemetry\getRequestId()
BenchmarkTitleValue\randomize()
, and
MediaWiki\Import\UploadSourceAdapter\registerSource()
wfRecursiveRemoveDir()
wfRecursiveRemoveDir
$dir
Remove a directory and all its content.
Does not hide error.
Parameters
string
$dir
Definition at line
1179
of file
GlobalFunctions.php
References
wfRecursiveRemoveDir()
Referenced by
wfRecursiveRemoveDir()
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
$path
Absolute destination path including target filename
string
$from
Absolute source path, directory only
Returns
string
Definition at line
1514
of file
GlobalFunctions.php
References
$path
, and
wfBaseName()
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. 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.
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
1033
of file
GlobalFunctions.php
Referenced by
MediaWiki\Api\ApiMain\checkConditionalRequestHeaders()
MediaWiki\Output\OutputPage\checkLastModified()
MediaWiki\Specials\SpecialExport\execute()
MediaWiki\Output\StreamFile\stream()
, and
MediaWiki\ResourceLoader\ResourceLoader\tryRespondNotModified()
wfScript()
wfScript
$script
'index'
Get the URL path to a
MediaWiki
entry point.
This is a wrapper to respect $wgScript and $wgLoadScript overrides.
See also
MW_ENTRY_POINT
Parameters
string
$script
Name of entrypoint, without
.php
extension.
Returns
string
Definition at line
1559
of file
GlobalFunctions.php
References
$wgLoadScript
$wgScript
, and
$wgScriptPath
Referenced by
MediaWiki\SpecialPage\SpecialPage\addFeedLinks()
MediaWiki\Specials\SpecialRedirect\dispatchLog()
MediaWiki\Specials\SpecialRedirect\dispatchPage()
MediaWiki\Specials\SpecialRedirect\dispatchRevision()
MediaWiki\Specials\SpecialRecentChanges\doHeader()
MediaWiki\Specials\SpecialWatchlist\doHeader()
MediaWiki\SpecialPage\ContributionsSpecialPage\execute()
MediaWiki\Specials\SpecialApiHelp\execute()
MediaWiki\SpecialPage\RedirectSpecialPage\execute()
MediaWiki\Specials\SpecialRecentChanges\execute()
MediaWiki\Api\ApiEntryPoint\execute()
MediaWiki\Api\ApiHelp\fixHelpLinks()
MediaWiki\Specials\SpecialVersion\getEntryPointInfo()
MediaWiki\SpecialPage\ContributionsSpecialPage\getForm()
MediaWiki\Output\OutputPage\getHeadLinksArray()
MediaWiki\Pager\TablePager\getLimitForm()
MediaWiki\Api\ApiOpenSearch\getOpenSearchTemplate()
MediaWiki\Api\ApiRsd\getRsdApiList()
MediaWiki\Actions\Pager\HistoryPager\getStartBody()
MediaWiki\Actions\HistoryAction\onView()
MediaWiki\Search\SearchWidgets\SearchFormWidget\render()
MediaWiki\Api\ApiMain\substituteResultWithError()
, and
MediaWiki\Specials\SpecialUserRights\switchForm()
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
954
of file
GlobalFunctions.php
wfSetVar()
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.
Parameters
mixed
&$dest
mixed
$source
bool
$force
Returns
mixed
Definition at line
937
of file
GlobalFunctions.php
References
$source
Referenced by
MediaWiki\SpecialPage\SpecialPage\including()
MediaWiki\Block\DatabaseBlock\isAutoblocking()
MediaWiki\Block\AbstractBlock\isUsertalkEditAllowed()
MediaWiki\Output\OutputPage\setFileVersion()
MediaWiki\Import\WikiImporter\setNoticeCallback()
MediaWiki\Parser\ParserOptions\setOptionLegacy()
MediaWiki\Output\OutputPage\setRevisionId()
MediaWiki\Parser\ParserOutput\setTimestamp()
MediaWiki\Parser\ParserOptions\setTimestamp()
, and
MediaWiki\Parser\ParserOutput\setTitleText()
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
&$retval
Optional, 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
$environ
Optional environment variables which should be added to the executed command environment.
array
$limits
Optional array with limits(filesize, memory, time, walltime) this overwrites the global wgMaxShell* limits.
array
$options
Array 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
1297
of file
GlobalFunctions.php
References
wfGetCaller()
Referenced by
MediaWiki\Media\DjVuHandler\doTransform()
MediaWiki\Media\DjVuImage\retrieveMetaData()
, and
wfShellExecWithStderr()
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
&$retval
Optional, will receive the program's exit code. (non-zero is usually failure)
array
$environ
Optional environment variables which should be added to the executed command environment.
array
$limits
Optional 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
1350
of file
GlobalFunctions.php
References
wfGetCaller()
, and
wfShellExec()
Referenced by
MediaWiki\Upload\UploadVerification\detectVirus()
MediaWiki\Media\TransformationalImageHandler\getMagickVersion()
MediaWiki\Media\SvgHandler\rasterize()
MediaWiki\Media\BitmapHandler\rotate()
MediaWiki\Media\BitmapHandler\transformCustom()
, and
MediaWiki\Media\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
$script
MediaWiki
cli script path
array
$parameters
Arguments and options to the script
array
$options
Associative 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
1370
of file
GlobalFunctions.php
References
$wgPhpCli
Referenced by
CleanupSpam\execute()
wfShorthandToInteger()
wfShorthandToInteger
?string
$string
''
int
$default
-1
Converts shorthand byte notation to integer form.
Parameters
null | string
$string
int
$default
Returned if $string is empty
Returns
int
Definition at line
1670
of file
GlobalFunctions.php
Referenced by
MediaWiki\Installer\Installer\envCheckMemory()
MediaWiki\Upload\UploadBase\getMaxPhpUploadSize()
MediaWiki\Api\ApiUpload\getMinUploadChunkSize()
MediaWiki\Request\WebRequestUpload\isIniSizeOverflow()
RunJobs\memoryLimit()
MediaWiki\Api\ApiMain\setupExternalResponse()
, and
wfMemoryLimit()
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
1247
of file
GlobalFunctions.php
Referenced by
wfIniGetBool()
wfStripIllegalFilenameChars()
wfStripIllegalFilenameChars
$name
Replace all invalid characters with '-'.
Additional characters can be defined in $wgIllegalFileChars (see T22489). By default, $wgIllegalFileChars includes ':', '/', '\'.
Parameters
string
$name
Filename to process
Returns
string
Definition at line
1598
of file
GlobalFunctions.php
References
$wgIllegalFileChars
, and
wfBaseName()
Referenced by
MediaWiki\Upload\UploadBase\getTitle()
, and
MediaWiki\Page\MovePage\isValidFileMove()
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
1125
of file
GlobalFunctions.php
References
$wgTmpDirectory
Referenced by
MediaWiki\Media\SvgHandler\doTransform()
MWDocGen\execute()
MediaWikiShell\execute()
, and
MediaWiki\ResourceLoader\Image\rasterize()
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 generous.
Parameters
File
$file
array
$params
Returns
bool
Since
1.24 Moved from
thumb.php
to GlobalFunctions in 1.25
Definition at line
1720
of file
GlobalFunctions.php
References
$wgImageLimits
$wgResponsiveImages
$wgThumbLimits
, and
MediaWiki\FileRepo\File\File\getHandler()
wfTimestamp()
wfTimestamp
$outputtype
TS::UNIX
$ts
Get a timestamp string in one of various formats.
Parameters
int | TS
$outputtype
Output format, one of the TS::* constants. Defaults to Unix timestamp.
mixed
$ts
A timestamp in any supported format. The function will autodetect which format is supplied and act accordingly. Use 0 or omit to use current time
Returns
string|false The date in the specified format, or false on error.
Definition at line
1078
of file
GlobalFunctions.php
References
wfDebug()
Referenced by
MediaWiki\Block\AbstractBlock\__construct()
MediaWiki\Output\OutputPage\adaptCdnTTL()
DumpCategoriesAsRdf\addDumpHeader()
MediaWiki\Api\ApiMain\addRequestedFields()
MediaWiki\SpecialPage\ChangesListSpecialPage\buildQuery()
MediaWiki\Cache\FileCacheBase\cacheTimestamp()
MediaWiki\Api\ApiMain\checkConditionalRequestHeaders()
MediaWiki\Output\OutputPage\checkLastModified()
MediaWiki\User\User\confirmEmail()
MediaWiki\Language\Language\date()
MediaWiki\Languages\LanguageWa\date()
MediaWiki\Specials\SpecialExport\execute()
MediaWiki\Api\ApiEditPage\execute()
MediaWiki\Api\ApiFeedWatchlist\execute()
MediaWiki\Api\ApiQueryAllUsers\execute()
MediaWiki\Api\ApiQueryBlocks\execute()
MediaWiki\Api\ApiQueryDeletedrevs\execute()
MediaWiki\Api\ApiQueryFilearchive\execute()
MediaWiki\Api\ApiQueryImageInfo\execute()
MediaWiki\Api\ApiSetNotificationTimestamp\execute()
MediaWiki\Api\ApiUndelete\execute()
MediaWiki\FileRepo\File\LocalFileRestoreBatch\execute()
BenchmarkParse\execute()
CleanupUploadStash\execute()
FixTimestamps\execute()
GenerateSitemap\execute()
ImportTextFiles\execute()
RemoveUnusedAccounts\execute()
TestCompression\execute()
UpdateSearchIndex\execute()
MediaWiki\User\UserGroupAssignmentServiceBase\expiryToTimestamp()
MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo()
MediaWiki\Api\ApiQueryRecentChanges\extractRowInfo()
MediaWiki\FileRepo\RepoGroup\findFile()
MediaWiki\Feed\FeedUtils\formatDiff()
MediaWiki\Language\Language\formatExpiry()
MediaWiki\Api\ApiResult\formatExpiry()
MediaWiki\Logging\LogFormatter\formatParameterValueForApi()
MediaWiki\Specials\SpecialUndelete\formatRevisionRow()
MediaWiki\Specials\Pager\MergeHistoryPager\formatRow()
MediaWiki\Specials\Pager\ImageListPager\formatValue()
MediaWiki\RevisionDelete\RevDelArchivedFileItem\getApiData()
MediaWiki\RevisionDelete\RevDelFileItem\getApiData()
MediaWiki\RevisionDelete\RevDelRevisionItem\getApiData()
MediaWiki\Block\DatabaseBlockStore\getAutoblockExpiry()
MediaWiki\Api\ApiBlockInfoHelper\getBlockDetails()
MediaWiki\Logging\NewUsersLogFormatter\getComment()
MediaWiki\FileRepo\File\LocalFile\getDescriptionTouched()
MediaWiki\User\User\getExperienceLevel()
MediaWiki\Media\FormatMetadata\getExtendedMetadataFromFile()
MediaWiki\Api\ApiQueryImageInfo\getInfo()
MediaWiki\Specials\SpecialActiveUsers\getIntroText()
MediaWiki\Logging\LogFormatter\getIRCActionText()
MediaWiki\Output\OutputPage\getJSVars()
MediaWiki\RCFeed\MachineReadableRCFeedFormatter\getLine()
MediaWiki\Logging\BlockLogFormatter\getMessageParameters()
MediaWiki\Media\PNGMetadataExtractor\getMetadata()
MediaWiki\Specials\SpecialRandomInCategory\getMinAndMaxForCat()
MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getNewPasswordExpiry()
MediaWiki\Logging\BlockLogFormatter\getParametersForApi()
MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\getPasswordResetData()
MediaWiki\Actions\RawAction\getRawText()
MediaWiki\Diff\DifferenceEngine\getRevisionHeader()
MediaWiki\Page\ImageHistoryList\getThumbForLine()
MediaWiki\FileRepo\ForeignAPIRepo\getThumbUrlFromCache()
MediaWiki\FileRepo\File\ArchivedFile\getTimestamp()
MediaWiki\FileRepo\File\ForeignAPIFile\getTimestamp()
MediaWiki\Logging\DatabaseLogEntry\getTimestamp()
MediaWiki\Logging\ManualLogEntry\getTimestamp()
MediaWiki\Logging\RCDatabaseLogEntry\getTimestamp()
MediaWiki\RevisionList\RevisionItemBase\getTimestamp()
MediaWiki\User\User\getTouched()
MediaWiki\Page\SitemapGenerator\getXml()
MediaWiki\FileRepo\ForeignAPIRepo\httpGet()
MediaWiki\Page\ImageHistoryList\imageHistoryLine()
MediaWiki\JobQueue\Jobs\HTMLCacheUpdateJob\invalidateTitles()
MediaWiki\User\User\isEmailConfirmationPending()
MediaWiki\RecentChanges\RecentChange\isInRCLifespan()
MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider\isTimestampValid()
MediaWiki\User\User\loadDefaults()
MediaWiki\User\User\loadFromCache()
MediaWiki\RecentChanges\RecentChange\loadFromRow()
MediaWiki\User\User\loadFromRow()
MediaWiki\FileRepo\File\LocalFile\loadFromRow()
MediaWiki\Media\FormatMetadata\makeFormattedData()
MediaWiki\Specials\SpecialBlock\maybeAlterFormDefaults()
MediaWiki\Output\OutputPage\output()
MediaWiki\Specials\SpecialRecentChanges\outputChangesList()
MediaWiki\Storage\PageEditStash\parseAndCache()
TableCleanup\progress()
MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange()
MediaWiki\SpecialPage\QueryPage\recache()
MediaWiki\Api\ApiQueryQueryPage\run()
MediaWiki\RecentChanges\CategoryMembershipChangeJob\run()
MediaWiki\Api\ApiMain\sendCacheHeaders()
MediaWiki\Output\OutputPage\setLastModified()
MediaWiki\Import\WikiRevision\setTimestamp()
MediaWiki\Maintenance\BackupDumper\showReport()
MediaWiki\Maintenance\TextPassDumper\showReport()
MediaWiki\Language\Language\time()
MediaWiki\Language\Language\timeanddate()
MediaWiki\Api\ApiUpload\transformWarnings()
MediaWiki\RecentChanges\RecentChangesUpdateJob\updateActiveUsers()
MediaWiki\Block\DatabaseBlockStore\updateBlock()
MediaWiki\Block\DatabaseBlockStore\updateTimestamp()
CategoryChangesAsRdf\updateTS()
wfTimestampOrNull()
, and
MediaWiki\Export\XmlDumpWriter\writeTimestamp()
wfTimestampNow()
wfTimestampNow
Convenience function; returns
MediaWiki
timestamp for the present time.
Returns
string TS::MW timestamp
Definition at line
1110
of file
GlobalFunctions.php
Referenced by
MediaWiki\Deferred\LinksUpdate\LinksDeletionUpdate\__construct()
MediaWiki\User\UserGroupMembership\__construct()
MediaWiki\RecentChanges\CategoryMembershipChange\__construct()
MediaWiki\User\User\confirmEmail()
MediaWiki\Preferences\DefaultPreferencesFactory\datetimePreferences()
MediaWiki\Block\DatabaseBlockStore\doAutoblock()
MediaWiki\Specials\SpecialWatchlist\doHeader()
MediaWiki\Specials\SpecialExport\execute()
MediaWiki\Api\ApiEditPage\execute()
MediaWiki\Api\ApiPurge\execute()
MediaWiki\Api\ApiUserrights\execute()
GenerateSitemap\execute()
ImportTextFiles\execute()
MigrateFileRepoLayout\execute()
ResetUserEmail\execute()
UpdateSearchIndex\execute()
MediaWiki\Media\FormatMetadata\fetchExtendedMetadata()
MediaWiki\Preferences\DefaultPreferencesFactory\getDateOptions()
MediaWiki\Logging\ManualLogEntry\getTimestamp()
MediaWiki\Parser\ParserOptions\getTimestamp()
MediaWiki\EditPage\EditPage\importFormData()
MediaWiki\Logging\ManualLogEntry\insert()
MediaWiki\Block\DatabaseBlock\isExpired()
MediaWiki\JobQueue\Job\newRootJobParams()
MediaWiki\Specials\SpecialLockdb\onSubmit()
MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider\providerChangeAuthenticationData()
MediaWiki\SpecialPage\UserGroupsSpecialPage\readGroupsForm()
MediaWiki\Logging\LogPage\saveContent()
MediaWiki\Cache\HTMLFileCache\saveToFileCache()
MediaWiki\Session\MultiBackendSessionStore\shutdown()
, and
MediaWiki\Session\SingleBackendSessionStore\shutdown()
wfTimestampOrNull()
wfTimestampOrNull
$outputtype
TS::UNIX
$ts
null
Return a formatted timestamp, or null if input is null.
For dealing with nullable timestamp columns in the database.
Parameters
mixed
$outputtype
mixed | null
$ts
Returns
string|false|null Null if called with null, otherwise the result of
wfTimestamp()
Definition at line
1097
of file
GlobalFunctions.php
References
wfTimestamp()
Referenced by
MediaWiki\User\UserRequirementsConditionEvaluator\checkCondition()
MediaWiki\Api\ApiQueryUsers\execute()
ResetPageRandom\execute()
MediaWiki\User\Registration\LocalUserRegistrationProvider\fetchRegistration()
MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModifiedTimes()
MediaWiki\Watchlist\NoWriteWatchedItemStore\getLatestNotificationTimestamp()
MediaWiki\Watchlist\WatchedItemStore\getLatestNotificationTimestamp()
MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\getPasswordResetData()
MediaWiki\JobQueue\Job\getQueuedTimestamp()
MediaWiki\JobQueue\Job\getReleaseTimestamp()
MediaWiki\JobQueue\JobSpecification\getReleaseTimestamp()
MediaWiki\JobQueue\Jobs\HTMLCacheUpdateJob\invalidateTitles()
MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider\isTimestampValid()
, and
MediaWiki\User\User\loadFromRow()
wfTransactionalTimeLimit()
wfTransactionalTimeLimit
Raise the request time limit to $wgTransactionalTimeLimit.
Returns
int Prior time limit
Since
1.26
Definition at line
1640
of file
GlobalFunctions.php
References
$wgTransactionalTimeLimit
Referenced by
MediaWiki\Actions\Action\useTransactionalTimeLimit()
MediaWiki\Api\ApiBase\useTransactionalTimeLimit()
, and
MediaWiki\SpecialPage\SpecialPage\useTransactionalTimeLimit()
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
204
of file
GlobalFunctions.php
Referenced by
MediaWiki\Title\Title\__wakeup()
MediaWiki\Output\OutputPage\addHelpLink()
MediaWiki\Parser\CoreParserFunctions\basepagenamee()
MediaWiki\FileRepo\FileRepo\getDescriptionRenderUrl()
MediaWiki\FileRepo\FileRepo\getDescriptionUrl()
MediaWiki\Title\Title\getLocalURL()
MediaWiki\Site\MediaWikiSite\getPageUrl()
MediaWiki\Title\TitleFormatter\getPrefixedURL()
MediaWiki\Title\Title\getPrefixedURL()
MediaWiki\Title\Title\getSubpageUrlForm()
MediaWiki\Interwiki\Interwiki\getURL()
MediaWiki\Api\ApiBase\logFeatureUsage()
MediaWiki\Api\ApiMain\logRequest()
MediaWiki\Title\Title\makeTitle()
MediaWiki\Parser\CoreParserFunctions\namespacee()
MediaWiki\Parser\CoreParserFunctions\nse()
MediaWiki\Parser\CoreParserFunctions\rootpagenamee()
MediaWiki\Parser\CoreParserFunctions\speciale()
MediaWiki\Parser\CoreParserFunctions\subjectspacee()
MediaWiki\Parser\CoreParserFunctions\talkspacee()
, and
MediaWiki\OutputTransform\Stages\DeduplicateStyles\transformText()
wfVarDump()
wfVarDump
$var
A wrapper around the PHP function var_export().
Either print it or add it to the regular output ($wgOut).
Parameters
mixed
$var
A PHP variable to dump.
Definition at line
972
of file
GlobalFunctions.php
References
$wgOut
wfWarn()
wfWarn
$msg
$callerOffset
$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
$msg
Message to send
int
$callerOffset
Number of items to go back in the backtrace to find the correct caller (1 = function calling wfWarn, ...)
int
$level
PHP error level; defaults to E_USER_NOTICE; only used when $wgDevelopmentWarnings is true
Definition at line
563
of file
GlobalFunctions.php
Referenced by
MediaWiki\Media\Exif\__construct()
MediaWiki\Content\TextContent\__construct()
MediaWiki\Html\Html\addClass()
MediaWiki\Storage\SqlBlobStore\decompressData()
MediaWiki\Api\ApiEditPage\execute()
MediaWiki\FileRepo\ForeignAPIRepo\fileExistsBatch()
MediaWiki\SpecialPage\SpecialPageFactory\getAliasList()
MediaWiki\Specials\Pager\ContribsPager\getExtraSortFields()
MediaWiki\Specials\Pager\ContribsPager\getIndexField()
MediaWiki\SpecialPage\SpecialPageFactory\getLocalNameFor()
MediaWiki\Language\Language\getMagic()
MediaWiki\Revision\SlotRoleRegistry\getRoleHandler()
MediaWiki\Actions\ActionEntryPoint\initializeArticle()
MediaWiki\Linker\Linker\link()
MediaWiki\Html\Html\linkedScript()
MediaWiki\Linker\Linker\makeBrokenImageLinkObj()
MediaWiki\Html\Html\openElement()
, and
MediaWiki\JobQueue\Utils\BacklinkJobUtils\partitionBacklinkJob()
includes
GlobalFunctions.php
Generated on Fri Apr 24 2026 09:29:41 for MediaWiki by
1.10.0