Manual:GlobalFunctions.php
| MediaWiki file: GlobalFunctions.php | |
|---|---|
| Location: | includes/ |
| Source code: | master • 1.42.3 • 1.41.4 • 1.39.10 |
| Classes: | Find code • Find documentation |
GlobalFunctions.php is a file that contains global functions, including such important functions as wfMessage, which is used for internationalisation.
- wfMessage (replaces the now deprecated wfMsg and wfMsgExt)
- wfRunHooks(), called Hooks:run() which was later replaced by HookContainer.
Functions
[edit]wfFindFile()
[edit]| MediaWiki version: | ≤ 1.38 |
(deprecated in 1.34)
(removed in 1.39)
Use MediaWikiServices::getInstance()->getRepoGroup()->findFile() instead.
Passing a string (with a file name) or a Title object, returns a File object, or false if the file does not exist.
It's a shortcut for RepoGroup::singleton()->findFile().
Use RepoGroup::singleton()->getLocalRepo()->findFile() if you need to get files only from the local repository.
wfRunHooks()
[edit]| MediaWiki version: | ≤ 1.32 |
(removed in 1.32) wfRunHooks() example usage, from WikiPage:doEditContent():
$hook_args = array( &$this, &$user, $content, $summary,
$flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $baseRevId );
ContentHandler::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
wfRunHooks( 'PageContentSaveComplete', $hook_args );
wfRandom()
[edit]wfRandom() is used to populate page.page_random.
wfBaseConvert()
[edit](deprecated in 1.27)
(removed in 1.31)
Use Wikimedia\base_convert() directly.
The function used to generate the base-36 SHA-1 text content hash in revision.rev_sha1 is wfBaseConvert( sha1( $text ), 16, 36, 31 ).
API modules like ApiQueryRevisions use wfBaseConvert( $revision->getSha1(), 36, 16, 40 ).
wfTempDir()
[edit]This function attempts to get the system directory for temporary files.
wfIsCLI()
[edit]| MediaWiki version: | ≥ 1.31 Gerrit change 401682 |
Returns true if the code is being run from the command line.