Manual:GlobalFunctions.php

From MediaWiki.org
Jump to: navigation, search
Translate this page; This page contains changes which are not marked for translation.

Other languages:
Deutsch • ‎English • ‎español • ‎日本語 • ‎polski • ‎português • ‎português do Brasil

GlobalFunctions.php is a file that contains global functions, including such important functions as wfMsgExt, which is used for internationalisationinternationalisation.

Functions[edit]

wfFindFile()[edit]

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]

wfRunHooks() example usage, from WikiPage:doEditContent()Manual:WikiPage.php:

$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]

This function is deprecated since 1.27. 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 ApiQueryRevisionsAPI:Revisions use wfBaseConvert( $revision->getSha1(), 36, 16, 40 ).

wfTempDir()[edit]

This function attempts to get the system directory for temporary files.

See also[edit]