Typedefs
using	$result = The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML)

using	myext.tests = array('script'=> 'extension/myext/tests.js', 'dependencies'=>< any module dependency you might have >)

Functions
the	array () calling protocol came about after MediaWiki 1.4rc1.
	List of Api Query prop modules. More...

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect to be fed to an HTMLForm object and populate $result with the reason in the form of	array (messagename, param1, param2,...). For consistency

the other converts the title to all uppercase letters in MediaWiki we would handle this as	follows (note:not real code, here)

as a message key or array as accepted by ApiBase::dieUsageMsg after processing request parameters Return false to let the request returning an error message or an< edit result="Failure"> tag if $resultArr was filled which will be used in the intoken parameter and in the and a callback function which should return the or false if the user isn t allowed to obtain it The prototype of the callback function is	func ($pageid, $title)

	if ($wgReverseTitle)

function	ldapLogin ($username, $password)

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing	options (say) and put it in one place. Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle

as a message key or array as accepted by ApiBase::dieUsageMsg after processing request parameters Return false to let the request returning an error message or an< edit result="Failure"> tag if $resultArr was filled which will be used in the intoken parameter and in the	output (actiontoken="...")

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables default is conds Array Extra conditions for the	query (e.g. "log_action != 'revision'") - showIfEmpty boolean Set to false if you don 't want any output in case the loglist is empty if set to true(default)

processing should stop and the error should be shown to the user if you wanted to authenticate users to a custom	system (LDAP, another PHP program, whatever)

Returning false makes less sense for events where the action is and will normally be ignored Note that none of the examples made use of create_function() as a way to attach a function to a hook. This is known to cause problems(notably with Special this is a necessary inconvenience to make it possible to pass reference	values (that can be changed) into the hook code. Also note that earlier versions of wfRunHooks took a variable number of arguments

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with	wfMessage () -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt

Variables
set to $title object and return false for a match for latest after cache objects are set use the ContentHandler facility to handle CSS and JavaScript	! $text

please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete &	$abortMsg

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller which means it s potentially called dozens or hundreds of times You may want to cache the results of non trivial operations in your hook function for this reason change this to override email change this to override email authentication timestamp whether or not the user is blocked from that page &	$allowUsertalk

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function array	$article

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing &	$attribs

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id &	$colours

return false to override stock group removal can be modified modifiable will be added to $_SESSION &	$cookies

null means default &	$customAttribs

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller which means it s potentially called dozens or hundreds of times You may want to cache the results of non trivial operations in your hook function for this reason &	$defaultOptions

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections &	$editor

as a message key or array as accepted by ApiBase::dieUsageMsg after processing request parameters Return false to let the request returning an error message or an< edit result="Failure"> tag if $resultArr was filled	$editPage

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle() will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage(). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable() always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable(). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage() 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime etc Preferred in most cases over UploadVerification object with all info about the upload string as detected by MediaWiki Handlers will typically only apply for specific mime types object &	$error

return true to allow those checks to and false if checking is done use this to change the tables headers &	$extTypes

it s the revision text itself In either if gzip is the revision text is gzipped	$flags

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle() will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage(). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable() always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable(). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage() 'TitleMove' use UploadVerification and UploadVerifyFile instead	$form

see documentation in includes Linker php for Linker::makeImageLink &	$handlerParams

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks &	$hash

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses &	$html

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled	$incrBy

occurs before session is loaded can be modified etc	$inject_html

processing should stop and the error should be shown to the user if you wanted to authenticate users to a custom you could	$ldapServer

set to $title object and return false for a match for latest after cache objects are set use the ContentHandler facility to handle CSS and JavaScript for highlighting &	$link

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks	$linksUpdate

namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable(). 'NewRevisionFromEditComplete' if it s text intended for display in a monospaced font	$localize

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle() will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage(). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable() always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable(). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage() 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime etc Preferred in most cases over UploadVerification object with all info about the upload string	$mime

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist but no entry for that model exists in $wgContentHandlers	$modeName

Allows to change the fields on the form that will be generated	$name

namespace and then decline to actually register it &	$namespaces

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect	$newtalks

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped &	$options

&	$output

do that in ParserLimitReportFormat instead	$parser

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method &	$password

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc &	$personal_urls

return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped	$pre

return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify	$query

see documentation in includes Linker php for Linker::makeImageLink or false for current &	$res

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled also a ContextSource error or success such as when responding to a resource loader request or generating HTML output &	$resourceLoader

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses &	$ret

please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity &	$retval

presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc	$rev

div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LoginAuthenticateAudit' this hook is for auditing only etc create2 Corresponds to logging log_action database field and which is displayed in the UI &	$revert

return false if a UserGetRights hook might remove the named right	$right

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty &	$sectionContent

set to $title object and return false for a match for latest after cache objects are set use the ContentHandler facility to handle CSS and JavaScript for highlighting or change the value of $siteNotice and return false to alter it &	$siteNotice

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned	$skin

namespace and then decline to actually register it RecentChangesLinked and Watchlist	$special

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff &	$tabindex

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist &	$tables

the value to return A Title object or null whereas SearchGetNearMatch runs after	$term

see documentation in includes Linker php for Linker::makeImageLink &	$time

presenting them properly to the user as errors is done by the caller	$title

static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place change it to the message you want to define which works for all SkinTemplate type skins	$tools

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle() will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage(). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable() always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable(). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage() 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime etc Preferred in most cases over UploadVerification object	$upload

please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account	$user

static configuration should be added through ResourceLoaderGetConfigVars instead &	$vars

An extension or a will often add custom code to the function with or without a global variable For someone wanting email notification when an article is shown may	$wgCapitalizeTitle

	$wgHooks ['ArticleShow'][] = 'reverseArticleTitle'

An extension or a will often add custom code to the function with or without a global variable For someone wanting email notification when an article is shown may	$wgNotifyArticle

please add to it if you re going to add events to the MediaWiki code	AbortAutoAccount

An extension or a will often add custom code to the function with or without a global variable For someone wanting email notification when an article is shown may	add

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In	addition

An extension or a	admin

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. Handler functions that modify $result should generally return false to further attempts at conversion. 'ContribsPager you ll need to handle error etc yourself	Alternatively

as a message key or array as accepted by ApiBase::dieUsageMsg	APIEditBeforeSave

and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and administrators to define code that will be run at certain points in the mainline and to modify the data run by that mainline code Hooks can keep mainline code and make it easier to write extensions Hooks are a principled alternative to patches for two options in MediaWiki One reverses the order of a title before displaying the	article

and how to run hooks for an and one after Each event has a preferably in CamelCase For	ArticleSave

and how to run hooks for an and one after Each event has a preferably in CamelCase For	ArticleSaveComplete

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero	based

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function	becomes

div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LoginAuthenticateAudit' this hook is for auditing only etc	block

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect to be fed to an HTMLForm object and populate $result with the reason in the form of error messages should be plain text with no special	bolding

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped	broken

it s the revision text itself In either	case

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff overridable Default is either copyrightwarning or copyrightwarning2 overridable Default is editpage tos summary such as anonymity and the real	check

and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and administrators to define code that will be run at certain points in the mainline	code

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect to be fed to an HTMLForm object and populate $result with the reason in the form of error messages should be plain text with no special	coloring

Returning false makes less sense for events where the action is	complete

and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and administrators to define code that will be run at certain points in the mainline and to modify the data run by that mainline code Hooks can keep mainline code and make it easier to write extensions Hooks are a principled alternative to patches	Consider

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist but no entry for that model exists in $wgContentHandlers if desired	ContentModelCanBeUsedOn

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok	ConvertContent

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled also a ContextSource error or success such as when responding to a resource loader request or generating HTML output included in	core

the other converts the title to all uppercase letters	Currently

and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of	data

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing	deleteAnArticle

processing should stop and the error should be shown to the user if you wanted to authenticate users to a custom you could	do

in this case you re responsible for computing and outputting the entire conflict i	e

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff overridable Default is either copyrightwarning or copyrightwarning2	EditPageGetDiffText

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff overridable Default is either copyrightwarning or copyrightwarning2 overridable Default is editpage tos summary	EmailConfirmed

return true to allow those checks to and false if checking is done	EmailUser

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect to be fed to an HTMLForm object and populate $result with the reason in the form of error messages should be plain text with no special etc to show that they re	errors

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing	etc

how to add hooks for an	event

and how to run hooks for an and one after Each event has a preferably in CamelCase For	example

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing	exportArticle

as a message key or array as accepted by ApiBase::dieUsageMsg after processing request parameters Return false to let the request	fail

processing should stop and the error should be shown to the user *	false

return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone	FetchChangesList

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension	file

return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used	FileDeleteComplete

null means default in associative array	form

if the prop value should be in the metadata multi language array	format

For QUnit	framework

return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options	GetCanonicalURL

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys	GetLocalURL

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify	GetLogTypesOnUser

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect to be fed to an HTMLForm object	GetRelativeTimestamp

presenting them properly to the user as errors is done by the caller return true	getUserPermissionsErrorsExpensive

presenting them properly to the user as errors is done by the caller return true	GitViewers

	gzip

they could be provided by a third party developer or written by the admin him	herself

and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a	hook

Using a hook running we can avoid having all this option specific stuff in our mainline code Using	hooks

occurs before session is loaded can be modified	ID

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form	imagelinks

see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false	ImageOpenShowImageInlineBefore

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and	insert

you don t have to do a grep find to see where the $wgReverseTitle variable is say If the code is well enough	isolated

presenting them properly to the user as errors is done by the caller return true but is called only if expensive checks are enabled Add a permissions error when permissions errors are checked for Return false if the user can t do	it

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message	key

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections	Live

div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LoginAuthenticateAudit' this hook is for auditing only etc	LoginPasswordResetMessage

div &	lt

static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title	MarkPatrolled

hooks txt This document describes how event hooks work in	MediaWiki

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a	message

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. Handler functions that modify $result should generally return false to further attempts at conversion. 'ContribsPager you ll need to handle error	messages

and how to run hooks for an and one after Each event has a	name

static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place change it to the message you want to define which works for all SkinTemplate type skins see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array	NamespaceIsMovable

return true to allow those checks to	occur

When an event	occurs

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going	on

	otherwise

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk	page

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form	pagelinks

namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable(). 'NewRevisionFromEditComplete' if it s text intended for display in a monospaced font $report should be output in English	ParserLimitReportPrepare

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values	ParserTestTables

in this case you re responsible for computing and outputting the entire conflict	part

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc etc	PingLimiter

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections	Preview

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after	processing

div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LoginAuthenticateAudit' this hook is for auditing only etc create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment this hook should only be used to add variables that depend on the current page	request

For QUnit the mediawiki tests qunit testrunner dependency will be added to any module	RevisionInsertComplete

presenting them properly to the user as errors is done by the caller return true use this to change the list i e	rollback

This code would result in ircNotify being run twice when an article is	saved

set to $title object and return false for a match for latest	SearchableNamespaces

the value to return A Title object or null	SearchAfterNoDirectMatch

set to $title object and return false for a match	SearchGetNearMatch

external	SearchGetNearMatchBefore

set to $title object and return false for a match	SearchGetNearMatchComplete

it s the revision text itself In either if gzip is	set

set to $title object and return false for a match for latest after cache objects are set	ShowMissingArticle

and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and administrators to define code that will be run at certain points in the mainline and to modify the data run by that mainline code Hooks can keep mainline code	simple

return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify	source

For QUnit the mediawiki tests qunit testrunner dependency will be added to any module it s the URL of the revision text in external	storage

Using a hook running	strategy

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle() will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage(). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known	TitleIsMovable

as a message key or array as accepted by ApiBase::dieUsageMsg after processing request parameters Return false to let the request returning an error message or an< edit result="Failure"> tag if $resultArr was filled which will be used in the intoken parameter and in the and a callback function which should return the	token

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return	true

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle() will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage(). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable() always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable(). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage() 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime	type

Having all this code related to the title reversion option in one place means that it s easier to read and	understand

presenting them properly to the user as errors is done by the caller return true use this to change the list i e	undo

static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set	up

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle() will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage(). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable() always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable(). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage() 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime etc Preferred in most cases over UploadVerification object with all info about the upload string as detected by MediaWiki Handlers will typically only apply for specific mime types object an indexed array representing the problem with the where the first element is the message key and the remaining elements are used as parameters to the message	UploadComplete

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle() will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage(). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable() always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable(). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage() 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message	UploadVerifyFile

you don t have to do a grep find to see where the $wgReverseTitle variable is	used

return false to override stock group addition can be modified	UserArrayFromResult

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code	UserCanSendEmail

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output	UserClearNewTalkNotification

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid	UserCreateForm

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash	UserEffectiveGroups

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to	UserGetDefaultOptions

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller which means it s potentially called dozens or hundreds of times You may want to cache the results of non trivial operations in your hook function for this reason change this to override email	UserGetEmailAuthenticationTimestamp

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller which means it s potentially called dozens or hundreds of times You may want to cache the results of non trivial operations in your hook function for this reason change this to override email change this to override email authentication timestamp	UserGetImplicitGroups

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller which means it s potentially called dozens or hundreds of times You may want to cache the results of non trivial operations in your hook function for this reason change this to override email change this to override email authentication timestamp whether or not the user is blocked from that page whether or not the block allows users to edit their own user talk pages	UserIsBlockedGlobally

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller which means it s potentially called dozens or hundreds of times You may want to cache the results of non trivial operations in your hook function for this reason change this to override email change this to override email authentication timestamp whether or not the user is blocked from that page whether or not the block allows users to edit their own user talk pages to be modified by the hook	UserIsEveryoneAllowed

and how to run hooks for an and one after Each event has a preferably in CamelCase For	UserLogin

occurs before session is loaded can be modified	UserLoginComplete

return false to override stock group removal can be modified	UserRights

return false to override stock group removal can be modified modifiable	UserSetCookies

return false to override stock group removal can be modified modifiable will be added to $_SESSION change this to override new email address	UserSetEmailAuthenticationTimestamp

return false to override stock group removal can be modified modifiable will be added to $_SESSION change this to override new email address change this to override email authentication timestamp	UserToolLinksEdit

This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible	values

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller	Warning

We ve cleaned up the code here by removing clumps of	weird

An extension	writer

div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LoginAuthenticateAudit' this hook is for auditing only	WRONG_PASS

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled also a ContextSource	wrongpassword

Typedef Documentation

◆ $result

using $result = The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item. $reader: XMLReader object $logInfo: Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag': When parsing a XML tag in a page. $reader: XMLReader object $pageInfo: Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision. $reader: XMLReader object $pageInfo: Array of page information $revisionInfo: Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag': When parsing a top level XML tag. $reader: XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload. $reader: XMLReader object $revisionInfo: Array of information Return false to stop further processing of the tag 'InfoAction': When building information to display on the action=info page. $context: IContextSource object &$pageInfo: Array of information 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect. $title: Title object for the current page $request: WebRequest $ignoreRedirect: boolean to skip redirect check $target: Title/string of redirect target $article: Article object 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix: interwiki prefix we are looking for. &$iwData: output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize': during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/ includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. &$parser: Parser object &$text: string containing partially parsed text &$stripState: Parser's internal StripState object 'InternalParseBeforeLinks': during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. &$parser: Parser object &$text: string containing partially parsed text &$stripState: Parser's internal StripState object 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully. $user: user (object) whose email is being invalidated 'IRCLineURL': When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query &$url: URL to index.php &$query: Query string $rc: RecentChange object that triggered url generation 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true) $article: article (object) being checked 'IsTrustedProxy': Override the result of wfIsTrustedProxy() $ip: IP being check $result: Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl() $url: URL used to upload from &$allowed: Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn't match your organization. $addr: The e-mail address entered by the user &$result: Set this and return false to override the internal checks 'isValidPassword': Override the result of User::isValidPassword() $password: The password entered by the user &$result: Set this and return false to override the internal checks $user: User the password is being validated for 'Language::getMessagesFileName': $code: The language code or the language we're looking for a messages file for &$file: The messages file path, you can override this to change the location. 'LanguageGetNamespaces': Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. &$namespaces: Array of namespaces indexed by their numbers 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions: associative array of magic words synonyms $lang: language code (string) 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases: associative array of magic words synonyms $lang: language code (string) 'LanguageGetTranslatedLanguageNames': Provide translated language names. &$names: array of language code => language name $code language of the preferred translations 'LanguageLinks': Manipulate a page's language links. This is called in various places to allow extensions to define the effective language links for a page. $title: The page's Title. &$links: Associative array mapping language codes to prefixed links of the form "language:title". &$linkFlags: Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin': Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin: the Skin object $target: the Title that the link is pointing to &$html: the contents that the <a> tag should have (raw HTML)

Definition at line 1528 of file hooks.txt.

◆ myext.tests

using myext.tests = array( 'script' => 'extension/myext/tests.js', 'dependencies' => <any module dependency you might have> )

Definition at line 2106 of file hooks.txt.

Function Documentation

◆ array() [1/2]

PurgeChangedFiles::array ( )

List of Api Query prop modules.

Mapping from type option to log type and actions.

Map converting from the abbrevation to the full form.

Each op type has three characters: left operand type, right operand type and result type.

Cache for language fallbacks.

Known database types.

List of Api Query meta modules.

List of Api Query list modules.

These correspond to the class names <type>Installer, and are also MediaWiki database types valid for $wgDBtype.

To add a new type, create a <type>Installer class and a Database<type> class, and add a config-type-<type> message to MessagesEn.php.

Since: 1.20

See also: Language::getFallbacksIncludingSiteLanguage

Since: 1.21

b = boolean n = number r = range

A number is a kind of range.

Examples: /src/includes/rcfeed/RedisPubSubFeedEngine.php, and /src/tests/phpunit/MediaWikiTestCase.php.

◆ array() [2/2]

presenting them properly to the user as errors is done by the caller return true but is called only if expensive checks are enabled Add a permissions error when permissions errors are checked for Return false if the user can t do and populate $result with the reason in the form of array	(	messagename	,
		param1	,
		param2	,
			...
	)

◆ follows()

the other converts the title to all uppercase letters in MediaWiki we would handle this as follows	(	note:not real	code,
		here
	)

Definition at line 35 of file hooks.txt.

References $article, $wgCapitalizeTitle, and global.

◆ func()

as a message key or array as accepted by ApiBase::dieUsageMsg after processing request parameters Return false to let the request returning an error message or an<edit result="Failure"> tag if $resultArr was filled which will be used in the intoken parameter and in the and a callback function which should return the or false if the user isn t allowed to obtain it The prototype of the callback function is func	(	$pageid,
		$title
	)

◆ if()

if ( $wgReverseTitle )

Definition at line 58 of file hooks.txt.

References $article.

◆ ldapLogin()

function ldapLogin	(	$username,
		$password
	)

Definition at line 193 of file hooks.txt.

◆ options()

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options ( say )

Referenced by PopulateCategory::__construct(), RedirectSpecialArticle::__construct(), FormOptions::add(), ApiQueryBase::addOption(), ApiQueryBase::addWhereRange(), CompareParsers::checkOptions(), ApiQueryBase::checkRowCount(), FormOptions::consumeValue(), FormOptions::consumeValues(), FormOptions::delete(), SpecialBlockList::execute(), FormOptions::fetchValuesFromRequest(), FormOptions::getAllValues(), FormOptions::getChangedValues(), FormOptions::getUnconsumedValues(), FormOptions::getValue(), MediaWikiPHPUnitCommand::handleArguments(), FormOptions::offsetExists(), CompareParsers::processRevision(), FormOptions::reset(), ApiQueryBase::resetQueryParams(), ApiQueryBase::select(), ExtraParserTest::setUp(), FormOptions::setValue(), showHelp(), SpecialBlockList::showList(), showUsage(), UserOptions::showUsageAndExit(), ExtraParserTest::testGetPreloadText(), ExtraParserTest::testParse(), ExtraParserTest::testPreprocess(), ExtraParserTest::testPreSaveTransform(), XmlSelectTest::testSetDefaultAfterAddingOptions(), ExtraParserTest::testTrackingCategory(), ExtraParserTest::testTrackingCategorySpecial(), FormOptions::validateBounds(), and FormOptions::validateName().

◆ output()

as a message key or array as accepted by ApiBase::dieUsageMsg after processing request parameters Return false to let the request returning an error message or an<edit result="Failure"> tag if $resultArr was filled which will be used in the intoken parameter and in the output ( actiontoken = "..." )

◆ query()

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an<a> element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables default is conds Array Extra conditions for the query ( )

◆ system()

processing should stop and the error should be shown to the user if you wanted to authenticate users to a custom system	(	LDAP	,
		another PHP	program,
		whatever
	)

Referenced by MWDocGen::execute().

◆ values()

Returning false makes less sense for events where the action is and will normally be ignored Note that none of the examples made use of create_function () as a way to attach a function to a hook. This is known to cause problems (notably with Special this is a necessary inconvenience to make it possible to pass reference values ( that can be changed )

◆ wfMessage()

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an<a> element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage ( ) -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt

Referenced by HTMLSelectOrOtherField::__construct(), HTMLSelectAndOtherField::__construct(), ErrorPageError::__construct(), MessageContent::__construct(), Licenses::__construct(), HTMLFormField::__construct(), MediaTransformError::__construct(), TransformParameterError::__construct(), LogPage::actionText(), MediaHandler::addMeta(), WikitextContent::addSectionHeader(), Skin::addToSidebar(), CologneBlueTemplate::afterContent(), SpecialVersion::arrayToString(), CologneBlueTemplate::beforeContent(), Linker::blockLink(), ProtectionForm::buildCleanupScript(), AllmessagesTablePager::buildForm(), ProtectionForm::buildForm(), ChangesFeed::buildItems(), ChangeTags::buildTagFilterSelector(), SpecialEditWatchlist::buildTools(), Title::checkSpecialsAndNSPermissions(), CleanupSpam::cleanupArticle(), CategoryViewer::columnList(), Language::commaList(), Linker::commentBlock(), WikiPage::commitRollback(), EmailNotification::composeCommonMailtext(), Article::confirmDelete(), Installer::createMainpage(), MonoBookTemplate::customBox(), Xml::dateMenu(), CoreParserFunctions::defaultsort(), Article::delete(), UploadBase::detectVirus(), Block::doAutoblock(), FileDeleteForm::doDelete(), Article::doDelete(), Skin::doEditSectionLink(), ImagePage::doRenderLangOpt(), ApiQueryTags::doTag(), BitmapHandler::doTransform(), DjVuHandler::doTransform(), SvgHandler::doTransform(), WebInstaller::downloadLinkHook(), Linker::emailLink(), Installer::envCheckDB(), ApiEditPage::execute(), ApiQueryAllMessages::execute(), DumpMessages::execute(), UsercreateTemplate::execute(), ApiFeedContributions::execute(), CleanupSpam::execute(), ApiImageRotate::execute(), ApiFeedWatchlist::execute(), MoveBatch::execute(), FileDeleteForm::execute(), ApiFeedContributions::feedItemDesc(), DeleteEqualMessages::fetchMessageInfo(), ChangesList::flag(), Linker::formatAutocommentsCallback(), LogPage::formatBlockFlag(), LogPage::formatBlockFlags(), FeedUtils::formatDiff(), FeedUtils::formatDiffRow(), LanguageZh_hans::formatDuration(), Language::formatDuration(), HTMLForm::formatErrors(), ResourceLoader::formatException(), WikiPage::formatExpiry(), Linker::formatHiddenCategories(), Linker::formatRevisionSize(), ApiRevisionDelete::formatStatusMessages(), ChangeTags::formatSummaryRow(), Linker::formatTemplates(), Language::formatTimePeriod(), MessageBlobStore::generateMessageBlob(), ContentHandler::getAutoDeleteReason(), ContentHandler::getAutosummary(), User::getBlockedStatus(), Skin::getCategoryLinks(), WebInstaller::getCheckBox(), OracleInstaller::getConnectForm(), PostgresInstaller::getConnectForm(), MssqlInstaller::getConnectForm(), MysqlInstaller::getConnectForm(), SpecialVersion::getCopyrightAndAuthorList(), Title::getDefaultMessageText(), Interwiki::getDescription(), LogPage::getDescription(), FeedUtils::getDiffLink(), ImageHandler::getDimensionsString(), SpecialUpload::getDupeWarning(), Title::getEditNotices(), Status::getErrorMessage(), SpecialUpload::getExistsWarning(), SpecialVersion::getExtensionTypes(), UploadBase::getFilenamePrefixBlacklist(), MediaHandler::getGeneralLongDesc(), User::getGroupMember(), User::getGroupName(), User::getGroupPage(), WebInstaller::getHelpBox(), Language::getHumanTimestamp(), WebInstaller::getInfoBox(), SpecialUpload::getInitialPageText(), Licenses::getInputHTML(), DatabaseInstaller::getInstallUserBox(), LogFormatter::getIRCActionComment(), LogFormatter::getIRCActionText(), SkinTemplate::getLanguages(), ContentHandler::getLocalizedName(), PNGHandler::getLongDesc(), GIFHandler::getLongDesc(), ImageHandler::getLongDesc(), SvgHandler::getLongDesc(), MediaHandler::getLongDesc(), SpecialVersion::getMediaWikiCredits(), Status::getMessage(), Language::getMessageFromDB(), GenerateJqueryMsgData::getMessagesAndTests(), Interwiki::getName(), LogPage::getName(), ProtectionForm::getOptionLabel(), WebInstaller::getPageListItem(), ApiCreateAccount::getPossibleErrors(), WebInstaller::getRadioSet(), LogPage::getRcComment(), LogPage::getRcCommentIRC(), DatabaseInstaller::getReadableName(), Block::getRedactedName(), MWTimestamp::getRelativeTimestamp(), User::getRightDescription(), DatabaseSqlite::getServerInfo(), MssqlInstaller::getSettingsForm(), MysqlInstaller::getSettingsForm(), ImageHandler::getShortDesc(), SpecialBlock::getSuggestedDurations(), LogPage::getTitleLink(), DoubleRedirectJob::getUser(), Language::getVariantname(), SpecialVersion::getVersion(), SpecialVersion::getVersionLinkedSvn(), FormatMetadata::getVisibleFields(), DatabaseInstaller::getWebUserBox(), Status::getWikiText(), Title::hasSourceText(), ImagePage::imageDupes(), ImagePage::imageLinks(), WikiPage::insertProtectNullRevision(), DifferenceEngine::intermediateEditsMsg(), CoreParserFunctions::intFunction(), User::isUsableName(), Block::isWhitelistedFromAutoblocks(), WebInstaller::label(), Xml::languageSelector(), ApiParse::languagesHtml(), UploadFromUrlJob::leaveMessage(), Linker::linkAttribs(), SpecialUpload::loadRequest(), LogPage::logHeader(), LogPage::logName(), Skin::makeI18nUrl(), ImagePage::makeMetadataTable(), BaseTemplate::makeSearchInput(), ImagePage::makeSizeLink(), Linker::makeThumbLink2(), Xml::monthSelector(), Title::moveTo(), Title::moveToInternal(), MWException::msg(), SearchEngine::namespacesAsText(), Html::namespaceSelector(), Title::newMainPage(), WikiImporter::notice(), Language::numLink(), ImagePage::openShowImage(), CologneBlueTemplate::otherLanguages(), WebInstallerOutput::outputFooter(), WebInstallerOutput::outputTitle(), ConverterRule::parse(), Language::pipeList(), FileDeleteForm::prepareMessage(), ImagePage::printSharedImageText(), CologneBlueTemplate::processBottomLink(), WikiPage::protectDescription(), CologneBlueTemplate::quickBar(), TextPassDumper::readDump(), AllmessagesTablePager::reallyDoQuery(), MessageBlobStore::reencodeBlob(), VectorTemplate::renderPortal(), SearchEngine::replacePrefixes(), WikitextContent::replaceSection(), SpecialPageTest::requireLoginAnonProvider(), Linker::revComment(), Linker::revDeleteLink(), Linker::revDeleteLinkDisabled(), Linker::revUserLink(), Linker::revUserTools(), UploadFromUrlJob::run(), DoubleRedirectJob::run(), ProtectionForm::save(), CologneBlueTemplate::searchForm(), Language::semicolonList(), User::sendConfirmationMail(), EmailNotification::sendImpersonal(), User::sendMail(), FileDeleteForm::setHeaders(), Article::setOldSubtitle(), User::setPassword(), WikiImporter::setTargetRootPage(), ProtectionForm::show(), Article::showDiffPage(), WebInstaller::showError(), ImagePage::showError(), FileDeleteForm::showForm(), WebInstaller::showMessage(), Article::showMissingArticle(), Article::showNamespaceHeader(), Article::showPatrolFooter(), Article::showRedirectedFromHeader(), SpecialEditWatchlist::showTitles(), ImagePage::showTOC(), SpecialVersion::softwareInformation(), Linker::specialLink(), Language::specialList(), WebInstaller::startPageWrapper(), UploadStash::stashFile(), SpecialEmailUser::submit(), CologneBlueTemplate::sysLinks(), ChangeTags::tagDescription(), CoreParserFunctions::tagObj(), MessageTest::testExists(), MessageTest::testInContentLanguageDisabled(), MessageTest::testInContentLanguageEnabled(), MessageTest::testInLanguage(), MessageTest::testInLanguageThrows(), MessageTest::testKey(), XmlTest::testLanguageSelector(), LogFormatterTest::testLogParamsTypeMsg(), LogFormatterTest::testLogParamsTypeMsgContent(), MessageTest::testMessageParams(), MessageTest::testMessageParamSubstitution(), ExtraParserTest::testTrackingCategory(), Linker::tocList(), File::transformErrorOutput(), BitmapHandler::transformGd(), MediaWiki_I18N::translate(), Language::truncate(), Language::truncateHtml(), PageArchive::undelete(), StripState::unstripCallback(), ImagePage::uploadLinksBox(), Linker::userTalkLink(), Linker::userToolLinks(), ImagePage::view(), Article::view(), Language::viewPrevNext(), Article::viewRedirect(), and wfStreamThumb().

Variable Documentation

◆ ! $text

set to $title object and return false for a match for latest after cache objects are set use the ContentHandler facility to handle CSS and JavaScript ! $text

Definition at line 2149 of file hooks.txt.

◆ $abortMsg

please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete& $abortMsg

Definition at line 237 of file hooks.txt.

Referenced by SpecialChangePassword::attemptReset().

◆ $allowUsertalk

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller which means it s potentially called dozens or hundreds of times You may want to cache the results of non trivial operations in your hook function for this reason change this to override email change this to override email authentication timestamp whether or not the user is blocked from that page& $allowUsertalk

Definition at line 2697 of file hooks.txt.

Referenced by Block::__construct(), and User::isBlockedFrom().

◆ $article

return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file $article

Initial value:

{
 
            wfRunHooks('ArticleShowComplete', array(&$article))

Definition at line 78 of file hooks.txt.

Referenced by ProtectionForm::__construct(), HistoryPage::__construct(), Orphans::checkSeparation(), CategoryViewer::columnList(), ApiParse::execute(), RebuildFileCache::execute(), follows(), ParserCache::get(), ParserCache::getDirty(), ParserCache::getETag(), ParserCache::getKey(), ParserCache::getOptionsKey(), ParserCache::getParserOutputKey(), ListredirectsPage::getRedirectTarget(), if(), MediaWiki::initializeArticle(), Article::newFromWikiPage(), MediaWiki::performRequest(), DifferenceEngine::renderNewRevision(), DoubleRedirectJob::run(), and PageArchive::undeleteRevisions().

◆ $attribs

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an<a> element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing& $attribs

Definition at line 1530 of file hooks.txt.

Referenced by PPNode_Hash_Tree::__toString(), OutputPage::addElement(), HTMLForm::addHiddenField(), ProtectionForm::buildForm(), ProtectionForm::buildSelector(), Xml::check(), Xml::checkLabel(), UploadBase::checkSvgScriptCallback(), Sanitizer::decodeTagAttributes(), HTMLForm::displaySection(), XMPReader::doAttribs(), WebInstaller::docLink(), Skin::doEditSectionLink(), Html::dropDefaults(), Xml::element(), Html::element(), Xml::elementClean(), XmlTypeCheck::elementClose(), XmlTypeCheck::elementOpen(), Xml::expandAttributes(), Html::expandAttributes(), Xml::fieldset(), CategoryViewer::formatList(), HTMLMultiSelectField::formatOptions(), HTMLRadioField::formatOptions(), SpecialUndelete::formatRevisionRow(), HTMLForm::getButtons(), DatabaseInstaller::getCheckBox(), MediaTransformOutput::getDescLinkAttribs(), HTMLForm::getHiddenFields(), HTMLTextField::getInputHTML(), HTMLTextAreaField::getInputHTML(), HTMLCheckMatrix::getInputHTML(), Licenses::getInputHTML(), UploadSourceField::getLabelHtml(), TablePager::getLimitSelect(), IRCColourfulRCFeedFormatter::getLine(), DatabaseInstaller::getPasswordBox(), LogFormatter::getRestrictedElement(), DatabaseInstaller::getTextBox(), Html::hidden(), HistoryPager::historyLine(), Html::htmlHeader(), Xml::input(), Html::input(), Xml::inputLabel(), Xml::inputLabelSep(), Xml::label(), Linker::link(), Linker::linkAttribs(), Xml::listDropDown(), RCCacheEntryFactoryTest::makeDeletedEditRecentChange(), RCCacheEntryFactoryTest::makeEditRecentChange(), Linker::makeExternalLink(), Linker::makeKnownLinkObj(), RCCacheEntryFactoryTest::makeLogRecentChange(), RCCacheEntryFactoryTest::makeRecentChange(), Revision::newFromArchiveRow(), Xml::openElement(), Html::openElement(), Xml::option(), Licenses::outputOption(), Xml::password(), CoreTagHooks::pre(), SpecialChangeEmail::pretty(), Xml::radio(), Xml::radioLabel(), Html::rawElement(), LinkHolderArray::replaceInternal(), XmlTypeCheck::rootElementOpen(), Sanitizer::safeEncodeTagAttributes(), RecentChange::setAttribs(), ImageGalleryBase::setAttributes(), Xml::span(), TextPassDumper::startElement(), XMPReader::startElement(), XMPReader::startElementModeInitial(), XMPReader::startElementModeLi(), XMPReader::startElementModeLiLang(), XMPReader::startElementModeSimple(), XMPReader::startElementModeStruct(), LogFormatter::styleRestricedElement(), Xml::submitButton(), Xml::tags(), SideBarTest::testRespectExternallinktarget(), SideBarTest::testRespectWgnofollowlinks(), SideBarTest::testTestAttributesAssertionHelper(), Xml::textarea(), Html::textarea(), TraditionalImageGallery::toHTML(), ThumbnailImage::toHtml(), Linker::tooltipAndAccesskeyAttribs(), Linker::userToolLinks(), Sanitizer::validateAttributes(), Sanitizer::validateTagAttributes(), Xml::wrapClass(), and HTMLForm::wrapForm().

◆ $colours

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id& $colours

Definition at line 1230 of file hooks.txt.

Referenced by LinkHolderArray::doVariants(), LinkHolderArray::replace(), and LinkHolderArray::replaceInternal().

◆ $cookies

return false to override stock group removal can be modified modifiable will be added to $_SESSION& $cookies

Definition at line 2838 of file hooks.txt.

Referenced by OutputPage::getCacheVaryCookies(), CookieJar::serializeToHttpRequest(), and User::setCookies().

◆ $customAttribs

null means default& $customAttribs

Definition at line 1530 of file hooks.txt.

Referenced by Linker::link(), and Linker::linkKnown().

◆ $defaultOptions

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller which means it s potentially called dozens or hundreds of times You may want to cache the results of non trivial operations in your hook function for this reason& $defaultOptions

Definition at line 2697 of file hooks.txt.

Referenced by Preferences::getPreferences(), User::resetOptions(), HtmlCheckMatrixTest::testInstantiationWithMinimumRequiredParameters(), HtmlCheckMatrixTest::testValidateAcceptsPartialTagList(), HtmlCheckMatrixTest::testValidateAllowsOnlyKnownTags(), HtmlCheckMatrixTest::testValidateCallsUserDefinedValidationCallback(), HtmlCheckMatrixTest::testValidateRequiresArrayInput(), HtmlCheckMatrixTest::testValuesForcedOffRemainOff(), HtmlCheckMatrixTest::testValuesForcedOnRemainOn(), UserOptions::USAGER(), and HtmlCheckMatrixTest::validate().

◆ $editor

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections& $editor

Definition at line 1038 of file hooks.txt.

Referenced by ConfEditorParseError::__construct(), EnotifNotifyJob::run(), RecentChange::save(), and EditAction::show().

◆ $editPage

as a message key or array as accepted by ApiBase::dieUsageMsg after processing request parameters Return false to let the request returning an error message or an<edit result="Failure"> tag if $resultArr was filled $editPage

Definition at line 375 of file hooks.txt.

◆ $error

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle () will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage (). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable () always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable (). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage () 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime etc Preferred in most cases over UploadVerification object with all info about the upload string as detected by MediaWiki Handlers will typically only apply for specific mime types object& $error

Definition at line 2573 of file hooks.txt.

Referenced by DBError::__construct(), LoginForm::addNewAccount(), LoginForm::addNewAccountMailPassword(), lessc::assertColor(), lessc::assertNumber(), SpecialPasswordReset::checkExecutePermissions(), ApiResult::convertStatusToArray(), UploadBase::convertVerifyErrorToStatus(), DatabaseInstaller::createTables(), PostgresInstaller::createTables(), DatabaseBase::deadlockLoop(), ApiDelete::delete(), ApiUpload::dieRecoverableError(), FileDeleteForm::doDelete(), Article::doDelete(), Article::doDeleteArticle(), WikiPage::doDeleteArticle(), WikiPage::doDeleteArticleReal(), SquidPurgeClient::doReads(), MovePageForm::doSubmit(), SquidPurgeClient::doWrites(), ApiEmailUser::execute(), ApiUpload::execute(), ApiPurge::execute(), DeleteDefaultMessages::execute(), MwSql::execute(), RunJobs::execute(), DeleteBatch::execute(), RefreshImageMetadata::execute(), GenerateCollationData::execute(), DeleteEqualMessages::execute(), SpecialEmailUser::execute(), TitleTest::flattenErrorsArray(), HTMLFormField::formatErrors(), HTMLForm::formatErrors(), OutputPage::formatPermissionsErrorMessage(), DatabasePostgres::freeResult(), Status::getErrorMessage(), Status::getErrorsByType(), User::getPasswordValidity(), ApiCreateAccount::getPossibleErrors(), SquidPurgeClient::getSocket(), Status::getStatusArray(), Title::getUserPermissionsErrors(), UploadBase::getVerificationErrorCode(), Status::getWikiText(), Status::hasMessage(), ExternalStore::insertWithFallback(), DatabaseMysqlBase::lastError(), SpecialPasswordReset::onSubmit(), RollbackAction::onView(), DatabaseMysqlBase::open(), PostgresInstaller::openConnectionToAnyDB(), UploadFromChunks::outputChunk(), XMPReader::parse(), ApiUpload::performUpload(), LoginForm::processLogin(), SpecialUpload::processVerificationError(), ORMTable::rawSelect(), ZipDirectoryReaderTest::readZipAssertError(), Status::replaceMessage(), DatabaseBase::reportConnectionError(), DatabaseOracle::reportQueryError(), DatabaseBase::reportQueryError(), DatabaseBase::restoreErrorHandler(), OracleInstaller::setupUser(), WebInstaller::showStatusMessage(), DatabaseBase::sourceFile(), UploadStash::stashFile(), SpecialEmailUser::submit(), StatusTest::testGetErrorsByType(), TitleTest::testIsValidMoveOperation(), TemplateCategoriesTest::testTemplateCategories(), TitleTest::testWgWhitelistReadRegexp(), UploadBase::verifyPartialFile(), UploadBase::verifyUpload(), Article::view(), and wfHtmlValidationHandler().

◆ $extTypes

presenting them properly to the user as errors is done by the caller return true use this to change the list & $extTypes

Definition at line 1105 of file hooks.txt.

◆ $flags

it s the revision text itself In either if gzip is the revision text is gzipped $flags

Definition at line 2113 of file hooks.txt.

Referenced by GanConverter::__construct(), ZhConverter::__construct(), KkConverter::__construct(), GenericArrayObject::__construct(), ApiPageSet::__construct(), LanguageShi::__construct(), LanguageIu::__construct(), LanguageSr::__construct(), DatabaseBase::__construct(), DatabaseSqliteStandalone::__construct(), MWMemcached::_load_items(), MWMemcached::_set(), ApiResult::addValue(), JobQueue::batchPush(), SpecialBlock::blockLogFlags(), CheckStorage::check(), WikiPage::checkFlags(), TrackBlobs::checkIntegrity(), FileRepo::cleanupBatch(), WikiPage::commitRollback(), CompressOld::compressPage(), Revision::compressRevisionText(), FileRepo::concatenate(), Revision::decompressRevisionText(), StringUtils::delimiterReplace(), StringUtils::delimiterReplaceCallback(), JobQueueDB::doBatchPush(), JobQueueRedis::doBatchPush(), JobQueueFederated::doBatchPush(), JobQueueDB::doBatchPushInternal(), WikiPage::doEdit(), WikiPage::doEditContent(), MockBitmapHandler::doTransform(), MockSvgHandler::doTransform(), BitmapHandler::doTransform(), DjVuHandler::doTransform(), SvgHandler::doTransform(), SquidPurgeClient::doWrites(), StorageTypeStats::execute(), DumpRev::execute(), FixBug20757::execute(), RunJobs::execute(), PPFrame_Hash::expand(), PPFrame_DOM::expand(), Revision::fetchFromConds(), RepoGroup::findFiles(), LocalRepo::findFiles(), FileRepo::findFiles(), LogPage::formatBlockFlags(), ApiPurge::getAllowedParams(), ApiWatch::getAllowedParams(), ApiImageRotate::getAllowedParams(), ApiSetNotificationTimestamp::getAllowedParams(), ApiFeedWatchlist::getAllowedParams(), ApiQueryLogEvents::getAllowedParams(), ApiQuery::getAllowedParams(), ApiPageSet::getAllowedParams(), Title::getArticleID(), ContentHandler::getAutosummary(), Article::getAutosummary(), WikiPage::getAutosummary(), Title::getEarliestRevTime(), Title::getFirstRevision(), Title::getLatestRevID(), Title::getLength(), Title::getNextRevisionID(), Title::getPreviousRevisionID(), Revision::getRevisionText(), UIDGenerator::getSequentialPerNodeIDs(), HistoryBlobStub::getText(), SpecialVersion::getVersion(), PPFrame_Hash::implodeWithFlags(), PPFrame_DOM::implodeWithFlags(), CheckStorage::importRevision(), WikiRevision::importUpload(), FSFileBackendList::initIterator(), Revision::insertOn(), Title::isRedirect(), FixBug20757::isUnbrokenStub(), LocalFile::load(), Revision::loadFromConds(), WikiPage::loadLastEdit(), moveToExternal(), Revision::newFromConds(), Revision::newFromId(), Title::newFromID(), Revision::newFromPageId(), Revision::newFromTitle(), LBFactorySimple::newMainLB(), UIDGenerator::newRawUUIDv4(), UIDGenerator::newSequentialPerNodeID(), UIDGenerator::newSequentialPerNodeIDs(), UIDGenerator::newUUIDv4(), SpecialUploadStash::outputLocallyScaledThumb(), SpecialUploadStash::outputThumbFromStash(), ConverterRule::parse(), ConverterRule::parseFlags(), ShiConverter::parseManualRule(), SrConverter::parseManualRule(), IuConverter::parseManualRule(), KkConverter::parseManualRule(), JobQueueGroup::pop(), Preprocessor_Hash::preprocessToObj(), Preprocessor_DOM::preprocessToObj(), Preprocessor_DOM::preprocessToXml(), FileRepo::publish(), LocalFile::publish(), FileRepo::publishBatch(), LocalFile::publishTo(), JobQueue::push(), ChangesList::recentChangesFlags(), resolveStub(), ApiResult::setElement(), Parser_DiffTest::setFunctionHook(), FileRepo::store(), FileRepo::storeBatch(), StoreBatchTest::storeit(), MediaWikiParserTest::suite(), WikitextContentHandlerTest::testGetAutosummary(), File::thumbName(), ForeignAPIFile::transform(), File::transform(), File::transformErrorOutput(), JobQueueFederated::tryJobInsertions(), LocalFile::upload(), OldLocalFile::uploadOld(), and Linker::userToolLinks().

◆ $form

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle () will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage (). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable () always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable (). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage () 'TitleMove' use UploadVerification and UploadVerifyFile instead $form

Definition at line 2573 of file hooks.txt.

Referenced by ProtectedTitlesPager::__construct(), ProtectedPagesPager::__construct(), MergeHistoryPager::__construct(), NewPagesPager::__construct(), SpecialUnlockdb::alterForm(), SpecialLockdb::alterForm(), RevertFileAction::alterForm(), PurgeAction::alterForm(), SpecialBlock::alterForm(), SpecialPasswordReset::alterForm(), SpecialResetTokens::alterForm(), SpecialChangePassword::alterForm(), WatchAction::alterForm(), UnwatchAction::alterForm(), benchmarkForm(), benchmarkTest(), Article::confirmDelete(), SpecialRecentChanges::doHeader(), SpecialWatchlist::doHeader(), SpecialListFiles::execute(), SpecialNewFiles::execute(), ApiUserrights::execute(), SpecialExport::execute(), SpecialUnblock::execute(), SpecialPagesWithProp::execute(), SpecialBlockList::execute(), SpecialComparePages::execute(), SpecialEditWatchlist::execute(), SpecialRandomInCategory::execute(), SpecialEmailUser::execute(), FormSpecialPage::execute(), SpecialNewpages::form(), SpecialEditWatchlist::getClearForm(), FormAction::getForm(), FormSpecialPage::getForm(), NewFilesPager::getForm(), SpecialEditWatchlist::getNormalForm(), Language::getPluralRuleIndexNumber(), SpecialSearch::getProfileForm(), SpecialEditWatchlist::getRawForm(), SpecialUpload::getUploadForm(), ApiUserrights::getUrUser(), Language::handleExplicitPluralForms(), SpecialBookSources::makeForm(), SpecialExpandTemplates::makeForm(), SpecialBlock::processUIForm(), SpecialUnblock::processUIUnblock(), Article::protect(), SpecialWatchlist::setTopText(), WatchAction::show(), PurgeAction::show(), FormAction::show(), SpecialComparePages::showDiff(), FileDeleteForm::showForm(), SpecialUpload::showRecoverableUploadError(), EmailConfirmation::showRequestForm(), SpecialUpload::showUploadForm(), SpecialUploadStash::showUploads(), SpecialUpload::showUploadWarning(), Preferences::tryFormSubmit(), Preferences::tryUISubmit(), SpecialEmailUser::uiSubmit(), Preferences::validateSignature(), and SpecialBlock::validateTargetField().

◆ $handlerParams

see documentation in includes Linker php for Linker::makeImageLink& $handlerParams

Definition at line 1356 of file hooks.txt.

Referenced by File::getUnscaledThumb(), Linker::makeImageLink(), Linker::makeImageLink2(), and Linker::makeThumbLink2().

◆ $hash

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks& $hash

Definition at line 2697 of file hooks.txt.

Referenced by HistoryBlobStub::__construct(), ConcatenatedGzipHistoryBlob::addItem(), CgzCopyTransaction::addItem(), SwiftFileBackend::addMissingMetadata(), ORAResult::array_unique_md(), UploadBase::checkWarnings(), CgzCopyTransaction::commit(), User::comparePasswords(), User::confirmationToken(), UpdateLogging::copyExactMatch(), User::crypt(), ApiTestCaseUpload::deleteFileByContent(), PPFuzzTester::execute(), LocalFileDeleteBatch::execute(), ForeignAPIRepo::findBySha1(), RepoGroup::findBySha1(), LocalRepo::findBySha1(), RepoGroup::findBySha1s(), FileRepo::findBySha1s(), RepoGroup::findFileFromKey(), ResourceLoaderStartUpModule::getConfig(), ResourceLoaderModule::getDefinitionMtime(), PurgeChangedFiles::getDeletedPath(), WikiFilePage::getDuplicates(), FileBackendStore::getFileSha1Base36(), LocalFileDeleteBatch::getHashes(), ResourceLoaderModule::getHashMtime(), FileRepo::getHashPathForLevel(), ConcatenatedGzipHistoryBlob::getItem(), ResourceLoaderFileModule::getLESSCacheKey(), MessageCache::getLocalCache(), ResourceLoaderUserCSSPrefsModule::getModifiedTime(), ResourceLoaderUserOptionsModule::getModifiedTime(), ResourceLoaderStartUpModule::getModifiedTime(), WebRequest::getRequestURL(), StoreFileOp::getSourceSha1Base36(), File::getStorageKey(), SqlBagOStuff::getTableByKey(), ResourceLoaderWikiModule::getTitleMtimes(), FileCacheBase::hashSubdirectory(), MessageCache::load(), Linker::normalizeSubpageLink(), Preprocessor_Hash::preprocessToObj(), CgzCopyTransaction::recompress(), ConcatenatedGzipHistoryBlob::removeItem(), MessageCache::saveToCaches(), MessageCache::saveToLocal(), ApiQueryBase::validateSha1Base36Hash(), and ApiQueryBase::validateSha1Hash().

◆ $html

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an<a> element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses& $html

Examples: /src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 1530 of file hooks.txt.

Referenced by ImageGalleryBase::add(), CachedAction::addCachedHTML(), WebInstallerOutput::addHTML(), WebInstallerOutput::addHTMLNoFlush(), MediaWikiTestCase::assertValidHtmlDocument(), MediaWikiTestCase::assertValidHtmlSnippet(), SpecialRevisionDelete::buildCheckBoxes(), ChangeTags::buildTagFilterSelector(), HTMLForm::displaySection(), Sanitizer::escapeHtmlAllowEntities(), SpecialListFiles::execute(), SpecialTags::execute(), ApiFeedContributions::feedItemDesc(), FeedUtils::formatDiffRow(), Linker::formatLinksInComment(), HTMLMultiSelectField::formatOptions(), HTMLRadioField::formatOptions(), OutputPage::getBottomScripts(), HTMLForm::getButtons(), PreferencesForm::getButtons(), SpecialVersion::getCreditsForExtension(), MWDebug::getDebugHTML(), HTMLFormField::getDiv(), WebInstaller::getHelpBox(), HTMLForm::getHiddenFields(), JavaScriptContent::getHtml(), CssContent::getHtml(), DBConnectionError::getHTML(), HTMLForm::getHTML(), QuickTemplate::getHTML(), OutputPage::getHtmlFromLoaderLinks(), HTMLMultiSelectField::getInputHTML(), HTMLRadioField::getInputHTML(), HTMLCheckMatrix::getInputHTML(), HTMLFormField::getLabelHtml(), MessageContent::getParserOutput(), TextContent::getParserOutput(), SkinTemplate::getPersonalToolsList(), HTMLFormField::getRaw(), HTMLCheckMatrix::getTableRow(), HTMLFormField::getTableRow(), Html::htmlHeader(), ImageGalleryBase::insert(), Linker::link(), Linker::linkKnown(), Skin::makeFooterIcon(), BaseTemplate::makeLink(), BaseTemplate::makeListItem(), Linker::makeMediaLinkFile(), Linker::makeMediaLinkObj(), Linker::makeSelfLinkObj(), CologneBlueTemplate::otherLanguages(), QueryPage::outputResults(), Installer::parse(), CologneBlueTemplate::renderAfterPortlet(), Linker::revDeleteLink(), Linker::revDeleteLinkDisabled(), WebInstaller::showHelpBox(), SpecialSearch::showHit(), SpecialExpandTemplates::showHtmlPreview(), FileDuplicateSearchPage::showList(), WebInstaller::showMessage(), LogEventsList::showOptions(), StatusTest::testGetHtml(), TextContentTest::testGetParserOutput(), HtmlFormatterTest::testTransform(), ImagePage::view(), HTMLForm::wrapForm(), and PreferencesForm::wrapForm().

◆ $incrBy

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled $incrBy

Definition at line 1956 of file hooks.txt.

Referenced by User::pingLimiter().

◆ $inject_html

occurs before session is loaded can be modified etc $inject_html

Definition at line 2818 of file hooks.txt.

◆ $ldapServer

processing should stop and the error should be shown to the user if you wanted to authenticate users to a custom you could $ldapServer

Definition at line 191 of file hooks.txt.

◆ $link

usually copyright or history_copyright This message must be in HTML not wikitext & $link

Definition at line 2149 of file hooks.txt.

Referenced by LinksUpdate::__construct(), ImageGalleryBase::add(), CategoryViewer::addImage(), CategoryViewer::addPage(), OutputPage::addReturnTo(), CategoryViewer::addSubcategoryObject(), Skin::addToSidebarPlain(), RCCacheEntryFactoryTest::assertQueryLink(), SkinTemplate::buildContentNavigationUrls(), OutputPage::buildCssLinks(), OutputPage::buildCssLinksArray(), ProtectionForm::buildForm(), SpecialEditWatchlist::buildRemoveLine(), Article::confirmDelete(), DifferenceEngine::deletedIdMarker(), Skin::doEditSectionLink(), MovePageForm::doSubmit(), DumpLinks::execute(), VectorTemplate::execute(), SpecialNewpages::filterLinks(), SrConverter::findVariantLink(), ShiConverter::findVariantLink(), IuConverter::findVariantLink(), KuConverter::findVariantLink(), KkConverter::findVariantLink(), Language::findVariantLink(), Linker::formatAutocommentsCallback(), ApiParse::formatCategoryLinks(), ApiParse::formatCss(), DateFormatter::formatDate(), ApiParse::formatLangLinks(), PopularPagesPage::formatResult(), AncientPagesPage::formatResult(), MostcategoriesPage::formatResult(), MostinterwikisPage::formatResult(), MostlinkedPage::formatResult(), SpecialProtectedtitles::formatRow(), DeletedContribsPager::formatRow(), CategoryPager::formatRow(), ContribsPager::formatRow(), ImageListPager::formatValue(), CreditsAction::getContributors(), Skin::getCopyright(), SpecialUndelete::getFileComment(), SpecialUndelete::getFileLink(), SpecialUndelete::getFileUser(), LogEventsList::getFilterLinks(), BaseTemplate::getFooterLinks(), OutputPage::getHeadLinksArray(), OutputPage::getHtmlFromLoaderLinks(), RevDel_FileItem::getLink(), RevDel_ArchivedFileItem::getLink(), SpecialUndelete::getPageLink(), WebInstaller::getPageListItem(), Block::getPermissionsError(), TablePager::getStartBody(), RevDel_FileItem::getUserTools(), HistoryPager::historyLine(), ImagePage::imageDupes(), ImagePage::imageLinks(), ImageGalleryBase::insert(), SpecialWhatLinksHere::listItem(), Linker::makeExternalLink(), Linker::makeHeadline(), BaseTemplate::makeListItem(), LogFormatter::makePageLink(), OutputPage::makeResourceLoaderLink(), ChangesList::maybeWatchedLink(), ImportStreamSource::newFromInterwiki(), ComposerPackageModifier::newMediaWikiLink(), Language::numLink(), ImagePage::openShowImage(), SpecialRecentChanges::optionsPanel(), SpecialSpecialpages::outputPageList(), SkinTemplate::prepareQuickTemplate(), SpecialBlock::preText(), Preferences::profilePreferences(), CologneBlueTemplate::quickBar(), EnhancedChangesList::recentChangesBlockGroup(), MediaWikiPageLinkRenderer::renderHtmlLink(), LinkHolderArray::replaceInterwiki(), Linker::revDeleteLink(), DifferenceEngine::revisionDeleteLink(), HistoryPager::revLink(), Linker::revUserLink(), Linker::revUserTools(), ComposerPackageModifier::setLinkAsProvides(), SpecialAllpages::showChunk(), Article::showDeletedRevisionHeader(), DifferenceEngine::showDiffPage(), FileDeleteForm::showForm(), SpecialRevisionDelete::showForm(), SpecialSearch::showHit(), SpecialSearch::showInterwikiHit(), SpecialBlockList::showList(), Article::showPatrolFooter(), SpecialPrefixindex::showPrefixChunk(), SpecialUndelete::showRevision(), MovePageForm::showSubpages(), SpecialUpload::showViewDeletedLinks(), OutputPage::styleLink(), Skin::subPageSubtitle(), TraditionalImageGallery::toHTML(), SpecialUndelete::undelete(), CreditsAction::userLink(), CologneBlueTemplate::variantLinks(), and Article::viewRedirect().

◆ $linksUpdate

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables & $linksUpdate

Definition at line 1530 of file hooks.txt.

Referenced by ParserOutput::getSecondaryDataUpdates().

◆ $localize

namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable (). 'NewRevisionFromEditComplete' if it s text intended for display in a monospaced font $localize

Definition at line 1746 of file hooks.txt.

◆ $mime

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle () will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage (). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable () always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable (). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage () 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime etc Preferred in most cases over UploadVerification object with all info about the upload string $mime

Definition at line 2573 of file hooks.txt.

Referenced by UploadBase::detectScript(), MIMEsearchPage::execute(), RefreshImageMetadata::getConditions(), ApiQueryImageInfo::getInfo(), File::getIsSafeFileUncached(), MediaHandler::getThumbType(), DjVuHandler::getThumbType(), UploadBase::getTitle(), ApiFormatBase::initPrinter(), lessc::lib_data_uri(), UserMailer::send(), File::splitMime(), UploadBase::verifyExtension(), UploadBase::verifyFile(), UploadBase::verifyMimeType(), and UploadBase::verifyPartialFile().

◆ $modeName

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist but no entry for that model exists in $wgContentHandlers $modeName

Definition at line 815 of file hooks.txt.

◆ $name

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist $name

Examples: /src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 336 of file hooks.txt.

◆ $namespaces

◆ $newtalks

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect $newtalks

Definition at line 1230 of file hooks.txt.

Referenced by Skin::getNewtalks().

◆ $options

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped& $options

Examples: /src/includes/rcfeed/RedisPubSubFeedEngine.php.

Definition at line 1530 of file hooks.txt.

Referenced by CheckLanguageCLI::__construct(), ResourceLoaderTestModule::__construct(), MappedIterator::__construct(), MultiHttpClient::__construct(), RedisConnectionPool::__construct(), RandomImageGenerator::__construct(), XmlTypeCheck::__construct(), RecompressTracked::__construct(), ZipDirectoryReader::__construct(), ResourceLoaderFileModule::__construct(), MWHttpRequest::__construct(), SquidPurgeClientPool::__construct(), UploadForm::__construct(), PathRouter::add(), LinkCache::addLinkObj(), OutputPage::addReturnTo(), PathRouter::addStrict(), OutputPage::addStyle(), RedisConnectionPool::applyDefaultConfig(), ProtectionForm::buildCleanupScript(), DatabasePostgres::buildConcat(), OutputPage::buildCssLinksArray(), IndexPager::buildQueryInfo(), ORMTable::count(), Title::countAuthorsBetween(), SpecialWatchlist::cutoffLinks(), SpecialWatchlist::daysLink(), CheckExtensionsCLI::defaultChecks(), Block::defaultRetroactiveAutoblock(), LocalRepo::deletedFileHasKey(), PathRouter::doAdd(), SiteStatsInit::doAllAndCommit(), WikiPage::doEditUpdates(), UserCache::doQuery(), Skin::editUrlOptions(), FormatJson::encode53(), FormatJson::encode54(), Sanitizer::escapeId(), DatabaseMysqlBase::estimateRowCount(), DatabaseMssql::estimateRowCount(), DatabaseBase::estimateRowCount(), GenerateRandomImages::execute(), ApiExpandTemplates::execute(), SpecialExpandTemplates::execute(), CommandLineInc::execute(), RefreshImageMetadata::execute(), UpdateCollation::execute(), PPFuzzTest::execute(), DeletedContributionsPage::execute(), PhpHttpRequest::execute(), LoginForm::executeReturnTo(), MWHttpRequestTester::factory(), MWHttpRequest::factory(), QueryPage::fetchFromCache(), Revision::fetchFromConds(), HTMLMultiSelectField::filterDataForSubmit(), RepoGroup::findFile(), FileRepo::findFile(), RepoGroup::findFileFromKey(), FileRepo::findFileFromKey(), FileRepo::findFiles(), DatabaseSqlite::fixIgnore(), HTMLFormField::flattenOptions(), HTMLMultiSelectField::formatOptions(), HTMLRadioField::formatOptions(), Linker::generateRollback(), Http::get(), Title::getAuthorsBetween(), InstallerOverrides::getCliInstaller(), DBLockManager::getConnection(), WikiPage::getContributors(), SpecialProtectedtitles::getLevelMenu(), SpecialProtectedpages::getLevelMenu(), Title::getLinksFrom(), Title::getLinksTo(), Category::getMembers(), Preferences::getOptionFromUser(), ApiOptionsTest::getOptionKinds(), User::getOptionKinds(), User::getOptions(), TextContent::getParserOutput(), WikitextContent::getParserOutput(), UsersPager::getQueryInfo(), LogPager::getQueryInfo(), NewPagesPager::getQueryInfo(), ImageListPager::getQueryInfoReal(), ResourceLoaderWikiModule::getScript(), BaseTemplate::getSidebar(), ResourceLoaderUserCSSPrefsModule::getStyles(), ResourceLoaderWikiModule::getStyles(), Title::getSubpages(), MysqlInstaller::getTableOptions(), Title::getTemplateLinksFrom(), Title::getTemplateLinksTo(), ResourceLoaderWikiModule::getTitleMtimes(), SpecialProtectedpages::getTypeMenu(), DumpRenderer::handleRevision(), LocalRepo::hiddenFileHasKey(), SpecialWatchlist::hoursLink(), ForeignAPIRepo::httpGet(), DatabaseSqlite::indexUnique(), ORMRow::insert(), DatabaseOracle::insert(), DatabaseSqlite::insert(), DatabaseMssql::insert(), DatabaseBase::insert(), ORMTable::insertRow(), Language::internalUserTimeAndDate(), Xml::languageSelector(), Linker::link(), Linker::linkAttribs(), Linker::linkKnown(), Linker::linkUrl(), Xml::listDropDown(), PageArchive::listRevisions(), Maintenance::loadParamsAndArgs(), HTMLFormField::lookupOptionsKeys(), DatabaseBase::makeGroupByWithHaving(), DatabaseSqlite::makeInsertOptions(), DatabaseBase::makeInsertOptions(), BaseTemplate::makeLink(), BaseTemplate::makeListItem(), SpecialRecentChanges::makeOptionsLink(), DatabaseBase::makeOrderBy(), ContentHandler::makeParserOptions(), WikiPage::makeParserOptions(), DatabaseSqlite::makeSelectOptions(), DatabaseMssql::makeSelectOptions(), DatabaseBase::makeSelectOptions(), DatabaseOracle::makeSelectOptions(), DatabaseBase::makeUpdateOptions(), DatabaseSqlite::makeUpdateOptionsArray(), DatabaseBase::makeUpdateOptionsArray(), Xml::monthSelector(), Html::namespaceSelector(), RecompressTracked::newFromCommandLine(), RecentChange::newFromConds(), ImagePage::openShowImage(), SpecialRecentChanges::optionsPanel(), WikiPage::pageData(), WikiPage::pageDataFromId(), WikiPage::pageDataFromTitle(), InfoAction::pageInfo(), OutputPage::parserOptions(), Http::post(), Preferences::profilePreferences(), FileRepo::publish(), LocalFile::publish(), FileRepo::publishBatch(), LocalFile::publishTo(), ForeignAPIFile::purgeCache(), LocalFile::purgeCache(), ForeignAPIFile::purgeThumbnails(), LocalFile::purgeThumbnails(), BacklinkCache::queryLinks(), UserCache::queryNeeded(), FileRepo::quickImport(), ORMTable::rawSelect(), ORMTable::rawSelectRow(), ZipDirectoryReader::read(), ImageListPager::reallyDoQuery(), IndexPager::reallyDoQuery(), QueryPage::reallyDoQuery(), UploadFromUrl::reallyFetchFile(), DateFormatter::reformat(), Http::request(), TableCleanup::runTable(), ORMTable::select(), DatabaseMssql::select(), DatabaseBase::select(), DatabaseBase::selectField(), ORMTable::selectFields(), ORMTable::selectFieldsRow(), ORMTable::selectObjects(), ORMTable::selectRow(), DatabaseOracle::selectRow(), DatabaseBase::selectRow(), DatabaseMssql::selectSQLText(), DatabaseBase::selectSQLText(), RedisPubSubFeedEngine::send(), WebResponse::setcookie(), Article::setParserOptions(), DatabaseMysqlBase::setSessionOptions(), SpecialAllpages::showChunk(), MovePageForm::showForm(), SpecialWatchlist::showHideLink(), SpecialWhatLinksHere::showIndirectLinks(), SpecialAllpages::showToplevel(), RedisConnectionPool::singleton(), SevenZipStream::stream_open(), OutputPage::styleLink(), SkinTemplateTest::testMakeListItem(), TextContentTest::testPreloadTransform(), TextContentTest::testPreSaveTransform(), CSSJanusTest::testTransformAdvanced(), GlobalTest::testWfShellMaintenanceCmd(), TraditionalImageGallery::toHTML(), ThumbnailImage::toHtml(), Linker::tooltip(), DatabaseMssql::update(), DatabaseOracle::update(), DatabaseBase::update(), LocalFile::upload(), Language::userDate(), Language::userTime(), and Language::userTimeAndDate().

◆ $output

static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output

Definition at line 375 of file hooks.txt.

Referenced by DatabasePostgres::aggregateValue(), WikiExporter::closeStream(), StringUtils::delimiterReplaceCallback(), UploadBase::detectVirus(), DeleteArchivedFilesImplementation::doDelete(), LinkHolderArray::doVariants(), SpecialWatchlist::execute(), SpecialExpandTemplates::execute(), SpecialRevisionDelete::execute(), SpecialRunJobs::executeJobs(), DatabasePostgres::getSoftwareLink(), MWTimestamp::getTimestamp(), DumpRenderer::handleRevision(), StringUtils::hungryDelimiterReplace(), MediaWiki::main(), SpecialExpandTemplates::makeOutput(), Maintenance::maybeHelp(), mccGetHelp(), WikiExporter::openStream(), SpecialWatchlist::outputChangesList(), WikiExporter::outputLogStream(), WikiExporter::outputPageStream(), MediaWiki::performAction(), MediaWiki::performRequest(), Profiler::remapCallTree(), LinkHolderArray::replaceInternal(), LinkHolderArray::replaceInterwiki(), SpecialAllpages::showChunk(), UserrightsPage::showLogFragment(), SpecialEditWatchlist::showTitles(), SpecialAllpages::showToplevel(), WfShellExecTest::testBug67870(), ArrayDiffFormatterTest::testFormat(), WfTimestampTest::testHttpDate(), WfTimestampTest::testNormalTimestamps(), WfTimestampTest::testOldTimestamps(), PreprocessorTest::testPreprocessorOutputFiles(), SanitizerTest::testRemoveHTMLtags(), WfAssembleUrlTest::testWfAssembleUrl(), WfShorthandToIntegerTest::testWfShorthandToInteger(), GetSlaveServerTest::testXmlDumpsBackupUseCase(), TraditionalImageGallery::toHTML(), and GenerateJqueryMsgData::writeJavascriptFile().

◆ $parser

function wfGetCustomMagicWordValue $parser

Initial value:

{

$parser->setFunctionHook( 'mag_custom', 'wfGetCustomMagicWordValue' )

Definition at line 1956 of file hooks.txt.

◆ $password

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method& $password

◆ $personal_urls

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc& $personal_urls

Definition at line 1956 of file hooks.txt.

Referenced by SkinTemplate::buildPersonalUrls().

◆ $pre

return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped $pre

Definition at line 1105 of file hooks.txt.

Referenced by lessc_formatter_classic::block(), Linker::formatAutocommentsCallback(), MWDebug::getHTMLDebugLog(), DbTestPreviewer::getTestStatusInfo(), and SearchHighlighter::highlightSimple().

◆ $query

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute & $query

Definition at line 1105 of file hooks.txt.

◆ $res

see documentation in includes Linker php for Linker::makeImageLink or false for current& $res

Definition at line 1358 of file hooks.txt.

◆ $resourceLoader

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled also a ContextSource error or success such as when responding to a resource loader request or generating HTML output& $resourceLoader

Definition at line 1956 of file hooks.txt.

Referenced by LessTestSuite::__construct(), OutputPage::buildCssLinks(), OutputPage::filterModules(), MessageBlobStore::get(), WebInstallerOutput::getCSS(), MessageBlobStore::getFromDB(), ResourceLoaderStartUpModule::getModuleRegistrations(), ResourceLoaderTestCase::getResourceLoaderContext(), OutputPage::makeResourceLoaderLink(), ResourceLoaderTest::testCreatingNewResourceLoaderCallsRegistrationHook(), and ResourceLoaderTest::testRegisteredValidModulesAreAccessible().

◆ $ret

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form & $ret

Definition at line 1530 of file hooks.txt.

Referenced by MWMemcached::_load_items(), ArrayUtils::arrayDiffAssocRecursive(), ExternalStoreDB::batchFetchBlobs(), ExternalStoreDB::batchFetchFromURLs(), Benchmarker::bench(), LocalSettingsGenerator::buildMemcachedServerList(), SpecialPageFactory::capturePath(), DatabaseBase::close(), CategoryViewer::columnList(), UploadFromChunks::concatenateChunks(), LanguageZh::convertForSearchResult(), MediaHandler::convertMetadataVersion(), MultiWriteBagOStuff::deleteObjectsExpiringBefore(), DatabaseOracle::doCommit(), DatabaseMysql::doQuery(), DatabaseMysqli::doQuery(), DatabaseInstaller::doUpgrade(), MultiWriteBagOStuff::doWrite(), Installer::envCheckShellLocale(), SpecialEmailUser::execute(), PPFrame_Hash::expand(), PPFrame_DOM::expand(), Html::expandAttributes(), ApiRevisionDelete::extractStatusInfo(), MssqlBlob::fetch(), ExternalStoreDB::fetchBlob(), ExternalStoreDB::fetchFromURL(), ORAResult::fetchObject(), ORAResult::fetchRow(), ForeignAPIRepo::findBySha1(), SpecialPagesWithProp::formatResult(), DeletedContribsPager::formatRow(), ContribsPager::formatRow(), ApiRevisionDelete::formatStatusMessages(), GetConfiguration::formatVarDump(), CoreParserFunctions::gender(), Preferences::generateSkinOptions(), ApiFeedRecentChanges::getAllowedParams(), ApiFeedWatchlist::getAllowedParams(), RevDel_RevisionItem::getApiData(), RevDel_FileItem::getApiData(), RevDel_LogItem::getApiData(), HTMLFormField::getAttributes(), RevisionDeleter::getChanges(), Preferences::getDateOptions(), UserOptions::getDefaultOptionsNames(), Benchmarker::getFormattedResults(), MWDebug::getHTMLDebugLog(), Preferences::getImageSizes(), FileRepo::getInfo(), TablePager::getLimitSelectList(), Title::getLinkURL(), SpecialVersion::getMediaWikiCredits(), getRow(), DatabaseTest::getSharedTableName(), TablePager::getStartBody(), Preferences::getThumbSizes(), ParserOutput::getTimes(), SpecialVersion::getWgHooks(), SiteConfiguration::getWikiParams(), UserrightsPage::groupCheckboxes(), LBFactory::hasMasterChanges(), OutputPage::headElement(), Html::htmlHeader(), DatabaseSqlite::insert(), DatabaseMssql::insert(), DatabaseMssql::insertSelect(), User::isLocallyBlockedProxy(), Linker::link(), Linker::linkAttribs(), Linker::linkUrl(), Revision::loadFromConds(), HTMLFormField::lookupOptionsKeys(), Linker::makeHeadline(), Linker::makeKnownLinkObj(), Linker::makeLinkObj(), ExternalStoreDB::mergeBatchResult(), SiteConfiguration::mergeParams(), Html::namespaceSelector(), Title::newFromText(), Linker::normaliseSpecialPage(), Sanitizer::normalizeCharReferencesCallback(), MediaWikiSite::normalizePageName(), Linker::normalizeSubpageLink(), File::normalizeTitle(), CoreParserFunctions::nse(), ForeignAPIFile::parseMetadata(), MediaWiki::parseTitle(), User::passwordChangeInputAttribs(), DatabaseBase::query(), EnhancedChangesList::recentChangesLine(), lessc::reduce(), Category::refreshCounts(), KkConverter::regsConverter(), DatabaseSqlite::replace(), MWMemcached::run_command(), DatabaseUpdater::runUpdates(), DatabaseMssql::select(), UserMailer::send(), Cookie::serializeToHttpRequest(), WebRequest::setVal(), ApiLoginTest::testApiLoginBadPass(), ApiLoginTest::testApiLoginGoodPass(), ParserMethodsTest::testCallParserFunction(), ApiCreateAccountTest::testValid(), SrConverter::translate(), KkConverter::translate(), Language::truncate_skip(), Language::truncateHtml(), PageArchive::undeleteRevisions(), DelayedParserTest::unleash(), SqlBagOStuff::unserialize(), WebRequest::unsetVal(), StripState::unstripCallback(), DatabaseMssql::update(), WikiPage::updateIfNewerOn(), UserOptions::USAGER(), XmlTypeCheck::validateFromFile(), and XmlTypeCheck::validateFromString().

◆ $retval

please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity& $retval

Examples: /src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 237 of file hooks.txt.

Referenced by LoginForm::authenticateUserData(), ExternalStoreMedium::batchFetchFromURLs(), ExternalStore::batchFetchFromURLs(), MWTidy::checkErrors(), MediaWikiTestCase::checkHasGzip(), CSSJanus_Tokenizer::detokenizeCallback(), DjVuHandler::doTransform(), MWTidy::execExternalTidy(), MWTidy::execInternalTidy(), ApiUndelete::execute(), ApiEmailUser::execute(), ApiMove::execute(), ApiPatrol::execute(), ApiExpandTemplates::execute(), ApiUnblock::execute(), ApiRollback::execute(), ApiBlock::execute(), NamespaceConflictChecker::execute(), ResourceLoaderContext::expandModuleNames(), ArrayDiffFormatter::format(), ApiQueryBacklinks::getAllowedParams(), Interwiki::getAllPrefixesDB(), ApiParamInfo::getClassInfo(), MessageBlobStore::getFromDB(), BitmapHandler::getMagickVersion(), ApiQueryBacklinks::getParamDescription(), UnusedimagesPage::getQueryInfo(), LinkSearchPage::getQueryInfo(), ApiQueryUserInfo::getRateLimits(), SiteConfiguration::getSetting(), ResourceLoader::inDebugMode(), WikiPage::insertRedirect(), MediaHandler::logErrorForExternalProcess(), ApiMain::makeHelpMsg(), ApiMove::moveSubpages(), Title::moveSubpages(), ApiQueryWatchlist::parseRCType(), ApiQueryRecentChanges::parseRCType(), ApiQueryImageInfo::processMetaData(), WfExpandUrlTest::provideExpandableUrls(), SvgHandler::rasterize(), Maintenance::readlineEmulation(), DoubleRedirectsPage::reallyGetQueryInfo(), MediaHandler::removeBadFile(), JpegHandler::rotate(), BitmapHandler::rotate(), Hooks::run(), BitmapHandler::transformCustom(), BitmapHandler::transformImageMagick(), RandomImageGenerator::writeImageWithApi(), and RandomImageGenerator::writeImageWithCommandLine().

◆ $rev

presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev

Definition at line 1337 of file hooks.txt.

◆ $revert

div flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS) 'LoginAuthenticateAudit' this hook is for auditing only etc create2 Corresponds to logging log_action database field and which is displayed in the UI& $revert

Definition at line 1632 of file hooks.txt.

Referenced by WikiStatsOutput::formatPercent(), MoveLogFormatter::getActionLinks(), DeleteLogFormatter::getActionLinks(), and LogEventsList::logLine().

◆ $right

return false if a UserGetRights hook might remove the named right $right

Definition at line 2798 of file hooks.txt.

Referenced by Action::checkCanExecute(), Title::checkCascadingSourcesRestrictions(), Title::checkPageRestrictions(), RecentChange::doMarkPatrolled(), CLDRPluralRuleEvaluator::doOperation(), CLDRPluralRuleConverter::doOperation(), lessc::eq(), lessc::evaluate(), CLDRPluralRuleEvaluator::evaluateCompiled(), ActiveUsersPager::formatRow(), LocalSettingsGenerator::getDefaultText(), LogEventsList::getExcludeClause(), MWNamespace::getRestrictionLevels(), User::getRightDescription(), User::isEveryoneAllowed(), Title::isNamespaceProtected(), Title::isValidMoveOperation(), lessc::op_color_color(), lessc::op_number_number(), CLDRPluralRuleConverter_Operator::operate(), SpecialListGroupRights::outputNamespaceProtectionInfo(), JSMinPlus::parseTree(), CSSJanusTest::provideTransformAdvancedCases(), ApiMain::reallyMakeHelpMsg(), JSParser::reduce(), lessc::stringConcatenate(), UserTest::testGetGroupsWithPermission(), and LogEventsList::typeAction().

◆ $sectionContent

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty& $sectionContent

Definition at line 1956 of file hooks.txt.

Referenced by WikiPage::replaceSection(), and WikiPage::replaceSectionContent().

◆ $siteNotice

set to $title object and return false for a match for latest after cache objects are set use the ContentHandler facility to handle CSS and JavaScript for highlighting or change the value of $siteNotice and return false to alter it& $siteNotice

Definition at line 2149 of file hooks.txt.

Referenced by Skin::getSiteNotice().

◆ $skin

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an<a> element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin

Definition at line 1530 of file hooks.txt.

Referenced by LogPage::actionText(), ResourceLoaderModule::getFileDependencies(), ResourceLoader::makeLoaderQuery(), ResourceLoader::makeLoaderURL(), Skin::newFromKey(), QueryPage::outputResults(), ResourceLoader::preloadModuleInfo(), ParserOutput::replaceEditSectionLinksCallback(), and ResourceLoaderModule::setFileDependencies().

◆ $special

namespace and then decline to actually register it RecentChangesLinked and Watchlist $special

Definition at line 815 of file hooks.txt.

Referenced by UpdateSpecialPages::doSpecialPageCacheUpdates(), UpdateSpecialPages::execute(), BaseTemplate::getToolbox(), RevisiondeleteAction::show(), SpecialProtectedtitles::showOptions(), and SpecialPreferencesTest::testBug41337().

◆ $tabindex

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff& $tabindex

Definition at line 1038 of file hooks.txt.

Referenced by Xml::listDropDown().

◆ $tables

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist& $tables

Examples: /src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 815 of file hooks.txt.

Referenced by UploadFromUrlTestSuite::addTables(), SiteStatsInit::articles(), IndexPager::buildQueryInfo(), Sqlite::checkSqlSyntax(), CompressOld::compressWithConcat(), SpecialRecentChangesLinked::doMainQuery(), SpecialWatchlist::doMainQuery(), SpecialRecentChanges::doMainQuery(), ChangesListSpecialPage::doMainQuery(), MysqlUpdater::doNamespaceSize(), WikiExporter::dumpFrom(), FixDoubleRedirects::execute(), Title::getCascadeProtectionSources(), WikiPage::getContributors(), LocalFile::getHistory(), LonelyPagesPage::getQueryInfo(), NewFilesPager::getQueryInfo(), LogPager::getQueryInfo(), NewPagesPager::getQueryInfo(), ImageListPager::getQueryInfoReal(), DatabaseLogEntry::getSelectQueryData(), ContribsPager::getUserCond(), ApiPageSet::initFromRevIDs(), PageArchive::listRevisions(), MediaWikiTestCase::listTables(), UserDupes::lock(), ChangeTags::modifyDisplayQuery(), ImageListPager::reallyDoQuery(), IndexPager::reallyDoQuery(), QueryPage::reallyDoQuery(), and DatabaseSqliteTest::testUpgrades().

◆ $term

the value to return A Title object or null whereas SearchGetNearMatch runs after $term

Definition at line 2125 of file hooks.txt.

Referenced by SpecialSearch::formHeader(), GIFMetadataExtractor::getMetadata(), SearchEngine::getNearMatchInternal(), SpecialSearch::getProfileForm(), SpecialSearch::goResult(), SearchHighlighter::highlightText(), SpecialSearch::makeSearchLink(), SearchSqlite::parseQuery(), SearchMySQL::parseQuery(), SearchPostgres::parseQuery(), SpecialSearch::powerSearchBox(), SearchSqlite::searchInternal(), SearchMySQL::searchInternal(), SearchPostgres::searchQuery(), SearchMssql::searchText(), SearchPostgres::searchText(), SearchOracle::searchText(), SearchSqlite::searchText(), SearchMySQL::searchText(), SearchPostgres::searchTitle(), SearchMssql::searchTitle(), SearchOracle::searchTitle(), SearchSqlite::searchTitle(), SearchMySQL::searchTitle(), SpecialSearch::setupPage(), SpecialSearch::shortDialog(), SpecialSearch::showResults(), SpecialSearch::startsWithAll(), SpecialSearch::startsWithImage(), SpecialSearchTest::testSearchTermIsNotExpanded(), and SearchEngine::transformSearchTerm().

◆ $time

div flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS) 'LoginAuthenticateAudit' this hook is for auditing only etc create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment $time

Definition at line 1358 of file hooks.txt.

Referenced by OldLocalFile::__construct(), MemcachedBagOStuff::delete(), MultiWriteBagOStuff::delete(), MemcachedPeclBagOStuff::delete(), JobQueueAggregatorRedis::doGetAllReadyWikiQueues(), DBFileJournal::doGetPositionAtTime(), FileBackendTest::doTestGetFileStat(), PoolWorkArticleView::doWork(), BenchmarkHooks::execute(), SyncFileBackend::execute(), RepoGroup::findFile(), FileRepo::findFile(), FileRepo::findFileFromKey(), MIMEsearchPage::formatResult(), FileDuplicateSearchPage::formatResult(), NewFilesPager::formatRow(), SpecialNewpages::formatRow(), ProtectionForm::getExpiry(), SpecialUndelete::getFileLink(), User::getFirstEditTimestamp(), Profiler::getInitialTime(), ResourceLoaderStartUpModule::getModifiedTime(), SpecialUndelete::getPageLink(), FileJournal::getPositionAtTime(), Profiler::getTime(), UIDGenerator::getTimestampAndDelay(), UIDGenerator::getTimestampedID128(), UIDGenerator::getTimestampedID88(), SpecialUndelete::loadRequest(), LogEventsList::logLine(), ApiMain::logRequest(), Linker::makeBrokenImageLinkObj(), FormatMetadata::makeFormattedData(), Linker::makeImageLink(), Linker::makeImageLink2(), Linker::makeMediaLinkObj(), Linker::makeThumbLink2(), UIDGenerator::millisecondsSinceEpochBinary(), ForeignAPIRepo::newFile(), FileRepo::newFile(), OldLocalFile::newFromTitle(), UIDGenerator::newTimestampedUID128(), UIDGenerator::newTimestampedUID88(), IPTC::parse(), Profiler::profileOut(), Preferences::profilePreferences(), ZipDirectoryReader::readCentralDirectory(), EmailConfirmation::showRequestForm(), SpecialUndelete::showRevision(), IPTC::timeHelper(), UIDGenerator::timeWaitUntil(), and Language::translateBlockExpiry().

◆ $title

return false to override stock group addition can be modified try getUserPermissionsErrors $title

Definition at line 1324 of file hooks.txt.

◆ $tools

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place change it to the message you want to define which works for all SkinTemplate type skins $tools

static

Definition at line 1679 of file hooks.txt.

Referenced by SpecialEditWatchlist::buildRemoveLine(), SpecialEditWatchlist::buildTools(), SpecialContributions::contributionsSub(), DeletedContribsPager::formatRow(), DeletedContributionsPage::getSubTitle(), and HistoryPager::historyLine().

◆ $upload

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle () will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage (). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable () always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable (). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage () 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime etc Preferred in most cases over UploadVerification object $upload

Definition at line 2573 of file hooks.txt.

Referenced by ImportReporter::__construct(), Linker::getUploadUrl(), UploadFromFile::initializeFromRequest(), ImportStreamSource::newFromUpload(), PublishStashedFileJob::run(), and AssembleUploadChunksJob::run().

◆ $user

return false to override stock group removal $user

Examples: /src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 237 of file hooks.txt.

◆ $vars

configuration should be added through ResourceLoaderGetConfigVars instead& $vars

static

Definition at line 1679 of file hooks.txt.

Referenced by MWMemcached::_load_items(), IEUrlExtension::areServerVarsBad(), DatabaseMysqlBase::estimateRowCount(), DatabaseMssql::estimateRowCount(), ResourceLoaderStartUpModule::getConfig(), DatabaseMysqlBase::getDefaultSchemaVars(), OutputPage::getJSVars(), ResourceLoaderFileModule::getLESSCacheKey(), OracleInstaller::getSchemaVars(), DatabaseMysqlBase::getServerUptime(), getVars(), ConfEditor::getVars(), DatabaseSqlite::listTables(), DatabaseMysqlBase::listTables(), DatabaseUpdater::loadExtensions(), Sanitizer::removeHTMLtags(), DatabaseBase::replaceSchemaVars(), DatabaseMssql::select(), DatabaseBase::select(), DatabaseOracle::selectRow(), DatabaseBase::selectRow(), DatabaseMssql::selectSQLText(), DatabaseBase::selectSQLText(), DatabaseBase::setSchemaVars(), and lessc::sortProps().

◆ $wgCapitalizeTitle

An extension or a will often add custom code to the function with or without a global variable For someone wanting email notification when an article is shown may $wgCapitalizeTitle

Definition at line 51 of file hooks.txt.

Referenced by follows().

◆ $wgHooks

When an event the function (or object method) will be called with the optional data provided as well as event-specific parameters. The above examples would result in the following code being executed when 'EventName' happened $wgHooks[ 'ArticleSaveComplete'][] = 'reverseArticleTitle'

◆ $wgNotifyArticle

An extension or a will often add custom code to the function with or without a global variable For someone wanting email notification when an article is shown may $wgNotifyArticle

Definition at line 51 of file hooks.txt.

◆ AbortAutoAccount

please add to it if you re going to add events to the MediaWiki code AbortAutoAccount

Definition at line 237 of file hooks.txt.

◆ add

you don t have to do a grep find to see where the $wgReverseTitle variable is say If the code is well enough it can even be excluded when not used making for some slight savings in memory and load up performance at runtime Admins who want to have all the reversed titles can add

Definition at line 51 of file hooks.txt.

Referenced by MemcachedPeclBagOStuff::add(), CheckLanguageCLI::help(), and PoolCounterRedis::initAndPopPoolSlotList().

◆ addition

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In addition

Definition at line 86 of file hooks.txt.

Referenced by RedisLockManager::getLocksOnServer().

◆ admin

An extension or a admin

Definition at line 51 of file hooks.txt.

◆ Alternatively

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok in case the handler function wants to provide a converted Content object Note that $result getContentModel () must return $toModel. Handler functions that modify $result should generally return false to further attempts at conversion. 'ContribsPager you ll need to handle error etc yourself Alternatively

Definition at line 896 of file hooks.txt.

◆ APIEditBeforeSave

as a message key or array as accepted by ApiBase::dieUsageMsg APIEditBeforeSave

Definition at line 375 of file hooks.txt.

◆ article

and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and administrators to define code that will be run at certain points in the mainline and to modify the data run by that mainline code Hooks can keep mainline code and make it easier to write extensions Hooks are a principled alternative to patches for two options in MediaWiki One reverses the order of a title before displaying the article

Definition at line 23 of file hooks.txt.

◆ ArticleSave

and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleSave

Definition at line 6 of file hooks.txt.

◆ ArticleSaveComplete

and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleSaveComplete

Definition at line 6 of file hooks.txt.

◆ based

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero based

Definition at line 1956 of file hooks.txt.

Referenced by wfStreamThumb().

◆ becomes

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function becomes

Definition at line 73 of file hooks.txt.

◆ block

div flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS) 'LoginAuthenticateAudit' this hook is for auditing only etc block

Definition at line 1632 of file hooks.txt.

Referenced by BlockTest::addDBData(), SpecialUnblock::execute(), SpecialUnblock::getFields(), DeletedContributionsPage::getSubTitle(), SpecialBlock::maybeAlterFormDefaults(), BlockTest::testBug26425BlockTimestampDefaultsToTime(), BlockTest::testBug29116NewFromTargetWithEmptyIp(), BlockTest::testINewFromIDReturnsCorrectBlock(), BlockTest::testINewFromTargetReturnsCorrectBlock(), and TraditionalImageGallery::toHTML().

◆ bolding

presenting them properly to the user as errors is done by the caller return true but is called only if expensive checks are enabled Add a permissions error when permissions errors are checked for Return false if the user can t do and populate $result with the reason in the form of error messages should be plain text with no special bolding

Definition at line 1318 of file hooks.txt.

◆ broken

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped broken

Definition at line 1530 of file hooks.txt.

Referenced by CheckLanguageCLI::help().

◆ case

it s the revision text itself In either case

Definition at line 2113 of file hooks.txt.

◆ check

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff overridable Default is either copyrightwarning or copyrightwarning2 overridable Default is editpage tos summary such as anonymity and the real check

Definition at line 1038 of file hooks.txt.

Referenced by BrokenRedirectsPage::formatResult(), CheckLanguageCLI::help(), ParserOutput::isLinkInternal(), Title::isValidMoveOperation(), and MagicVariableTest::setUp().

◆ code

the other converts the title to all uppercase letters in MediaWiki code

Definition at line 23 of file hooks.txt.

Referenced by CheckLanguageCLI::__construct(), CheckLanguageCLI::doChecks(), DatabaseOracle::doQuery(), FauxResponse::header(), CheckLanguageCLI::help(), and EditPageTest::provideAutoMerge().

◆ coloring

presenting them properly to the user as errors is done by the caller return true but is called only if expensive checks are enabled Add a permissions error when permissions errors are checked for Return false if the user can t do and populate $result with the reason in the form of error messages should be plain text with no special coloring

Definition at line 1318 of file hooks.txt.

◆ complete

Returning false makes less sense for events where the action is complete

Definition at line 198 of file hooks.txt.

Referenced by CheckLanguageCLI::help(), and ApiFormatBase::initPrinter().

◆ Consider

and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and administrators to define code that will be run at certain points in the mainline and to modify the data run by that mainline code Hooks can keep mainline code and make it easier to write extensions Hooks are a principled alternative to patches Consider

Definition at line 23 of file hooks.txt.

◆ ContentModelCanBeUsedOn

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist but no entry for that model exists in $wgContentHandlers if desired ContentModelCanBeUsedOn

Definition at line 815 of file hooks.txt.

◆ ConvertContent

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok ConvertContent

Definition at line 815 of file hooks.txt.

◆ core

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled also a ContextSource error or success such as when responding to a resource loader request or generating HTML output included in core

Definition at line 1956 of file hooks.txt.

◆ Currently

the other converts the title to all uppercase letters Currently

Definition at line 34 of file hooks.txt.

◆ data

and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data

Definition at line 6 of file hooks.txt.

◆ deleteAnArticle

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing deleteAnArticle

Definition at line 93 of file hooks.txt.

◆ do

processing should stop and the error should be shown to the user if you wanted to authenticate users to a custom you could do

Definition at line 191 of file hooks.txt.

◆ e

in this case you re responsible for computing and outputting the entire conflict i e

Definition at line 1038 of file hooks.txt.

Referenced by BenchmarkParse::execute(), RedisLockManager::freeLocksOnServer(), RedisLockManager::getLocksOnServer(), DatabaseOracle::open(), PoolCounterRedis::release(), and SearchPostgres::searchQuery().

◆ EditPageGetDiffText

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff overridable Default is either copyrightwarning or copyrightwarning2 EditPageGetDiffText

Definition at line 1038 of file hooks.txt.

◆ EmailConfirmed

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff overridable Default is either copyrightwarning or copyrightwarning2 overridable Default is editpage tos summary EmailConfirmed

Definition at line 1038 of file hooks.txt.

◆ EmailUser

return true to allow those checks to and false if checking is done EmailUser

Definition at line 1105 of file hooks.txt.

◆ errors

presenting them properly to the user as errors is done by the caller return true but is called only if expensive checks are enabled Add a permissions error when permissions errors are checked for Return false if the user can t do and populate $result with the reason in the form of error messages should be plain text with no special etc to show that they re errors

Definition at line 1318 of file hooks.txt.

Referenced by PermissionsError::__construct(), CheckStorage::check(), Status::error(), CheckStorage::error(), MWDocGen::execute(), Status::fatal(), Status::getErrorsByType(), Status::getMessage(), Status::getStatusArray(), Status::getWikiText(), Status::hasMessage(), CheckLanguageCLI::help(), CheckStorage::importRevision(), Status::merge(), Status::replaceMessage(), PermissionsError::report(), and Status::warning().

◆ etc

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing etc

Definition at line 93 of file hooks.txt.

◆ event

and how to run hooks for an event

Initial value:

==Glossary==
 
event
     Something that happens with the wiki. For example: a user logs in. A wiki
     page is saved. A wiki page is deleted. Often there are two events
     associated with a single action: one before the code is run to make the
     event happen

Definition at line 4 of file hooks.txt.

◆ example

An extension or a will often add custom code to the function with or without a global variable For example

Definition at line 6 of file hooks.txt.

◆ exportArticle

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing exportArticle

Definition at line 93 of file hooks.txt.

◆ fail

as a message key or array as accepted by ApiBase::dieUsageMsg after processing request parameters Return false to let the request fail

Examples: /src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 375 of file hooks.txt.

Referenced by TextPassDumperTest::checkpointHelper(), DumpTestCase::gunzip(), HttpTest::provideURI(), ApiQueryContinueTestBase::query(), MediaWikiTestCase::tearDown(), DatabaseSqliteTest::testAddQuotes(), ApiOptionsTest::testAnon(), TagHookTest::testBadFunctionTagHooks(), TagHookTest::testBadTagHooks(), ApiEditPageTest::testEditConflict(), ApiEditPageTest::testEditConflict_redirect(), ApiEditPageTest::testEditSection(), DatabaseSqliteTest::testEntireSchema(), RevisionTest_ContentHandlerUseDB::testGetContentFormat(), RevisionTest_ContentHandlerUseDB::testGetContentModel(), ORMTableTest::testIgnoreErrorsOverride(), ResourceLoaderLESSTest::testLessFile(), ContentHandlerTest::testMakeContent(), ApiOptionsTest::testNoChanges(), ApiOptionsTest::testNoOptionname(), ApiParseTest::testParseNonexistentPage(), HtmlCheckMatrixTest::testPlainInstantiation(), PrefixUniquenessTest::testPrefixes(), WikitextContentHandlerTest::testSerializeContent(), WikitextContentHandlerTest::testUnserializeContent(), ApiWatchTest::testWatchRollback(), GetSlaveServerTest::testXmlDumpsBackupUseCase(), BackupDumperPageTest::testXmlDumpsBackupUseCase(), and BackupDumperLoggerTest::testXmlDumpsBackupUseCaseLogging().

◆ false

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return false

Definition at line 188 of file hooks.txt.

Referenced by PPFrame_Hash::__construct(), PPFrame_DOM::__construct(), SkinTemplate::buildContentNavigationUrls(), Title::checkUserBlock(), CopyFileBackend::copyFileBatch(), LocalFile::delete(), JobQueueRedis::doDelete(), SpecialContributions::execute(), SpecialExport::execute(), SpecialListGroupRights::execute(), SpecialLog::execute(), LogFormatter::extractParameters(), ExternalStoreDB::fetchBlob(), Linker::formatLinksInCommentCallback(), CreditsAction::getAuthor(), User::getBlockId(), SiteSQLStore::getCacheKey(), JobQueueDB::getDB(), SwiftFileBackend::getDirListPageInternal(), WebInstaller::getInfoBox(), NewUsersLogFormatter::getMessageParameters(), BackupReader::getNsIndex(), MediaHandler::getThumbType(), ApiMain::handleApiBeforeMainException(), HistoryPager::historyLine(), FileCacheBase::incrMissesRecent(), DatabaseMysqlBase::indexInfo(), DatabaseMssql::indexInfo(), User::isBlockedFrom(), Title::isSubpage(), Linker::makeBrokenImageLinkObj(), moveToExternal(), RCCacheEntryFactory::newFromRecentChange(), XmlTypeCheck::newFromString(), UnregisteredLocalFile::newFromTitle(), WikiPage::onArticleDelete(), SpecialUploadStash::outputLocallyScaledThumb(), Preprocessor_Hash::preprocessToObj(), LocalisationCache::recache(), LocalFile::recordUpload2(), UploadFromUrlJob::run(), RefreshLinksJob::runForTitle(), SearchMssql::searchTitle(), SearchOracle::searchTitle(), ORMTable::selectFieldsRow(), SpecialAllpages::showToplevel(), LockManagerGroup::singleton(), JobQueueGroup::singleton(), RevisionStorageTest::testNewNullRevision(), File::transform(), PageArchive::undeleteRevisions(), Preferences::validateSignature(), DatabaseMysqlBase::wasReadOnlyError(), and wfStreamThumb().

◆ FetchChangesList

return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone FetchChangesList

Definition at line 1105 of file hooks.txt.

◆ file

to their LocalSettings php file

Definition at line 93 of file hooks.txt.

Referenced by LessFileCompilationTest::__construct(), BackupReader::__construct(), FileDeleteForm::__construct(), Exif::__construct(), ThumbnailImage::__construct(), TestFileIterator::__construct(), RevDel_FileItem::__construct(), RevDel_ArchivedFileItem::__construct(), MySQLMasterPos::__construct(), LocalFileDeleteBatch::__construct(), LocalFileRestoreBatch::__construct(), LocalFileMoveBatch::__construct(), LocalFileDeleteBatch::addCurrent(), LocalFileDeleteBatch::addOld(), LocalFileDeleteBatch::addOlds(), RevDel_FileItem::canView(), RevDel_FileItem::canViewContent(), ApiFileRevert::checkPermissions(), TestFileIterator::checkSection(), LocalFileRestoreBatch::cleanup(), LocalFileRestoreBatch::cleanupFailedBatch(), LocalFileMoveBatch::cleanupSource(), LocalFileMoveBatch::cleanupTarget(), LocalFileDeleteBatch::doDBDeletes(), LocalFileDeleteBatch::doDBInserts(), LocalFileMoveBatch::doDBUpdates(), FileBackendTest::doTestDoOperationsPipeline(), ApiFileRevert::execute(), FileDeleteForm::execute(), FileDuplicateSearchPage::execute(), MWDocGen::execute(), ZipDirectoryReader::execute(), LocalFileDeleteBatch::execute(), LocalFileRestoreBatch::execute(), LocalFileMoveBatch::execute(), RevDel_FileItem::getBits(), RevDel_FileItem::getComment(), MediaTransformOutput::getDescLinkAttribs(), ZipDirectoryReader::getFileLength(), LocalFileDeleteBatch::getHashes(), RevDel_FileItem::getHTML(), RevDel_FileItem::getLink(), RevDel_ArchivedFileItem::getLink(), MediaTransformOutput::getLocalCopyPath(), LocalFileMoveBatch::getMoveTriplets(), ZipDirectoryReader::getSegment(), SpecialVersion::getSvnInfo(), RevDel_FileItem::getUserTools(), CheckLanguageCLI::help(), RevDel_FileItem::isDeleted(), User::isLocallyBlockedProxy(), ImportStreamSource::newFromUpload(), DatabaseInstaller::populateInterwikiTable(), FileDeleteForm::prepareMessage(), MergeMessageFileList::readFile(), LocalFileDeleteBatch::removeNonexistentFiles(), LocalFileRestoreBatch::removeNonexistentFiles(), LocalFileMoveBatch::removeNonexistentFiles(), LocalFileRestoreBatch::removeNonexistentFromCleanup(), RevDel_FileItem::setBits(), showHelp(), showUsage(), MediaTransformOutput::streamFile(), FileBackendTest::testConcatenate(), FileBackendTest::testStore(), ThumbnailImage::toHtml(), and ApiFileRevert::validateParameters().

◆ FileDeleteComplete

return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used FileDeleteComplete

Definition at line 1105 of file hooks.txt.

◆ form

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array form

Definition at line 1530 of file hooks.txt.

Referenced by UserloginTemplate::execute(), UsercreateTemplate::execute(), ActiveUsersPager::getPageHeader(), CheckLanguageCLI::help(), ImportStreamSource::newFromUpload(), MonoBookTemplate::searchBox(), and DBConnectionError::searchForm().

◆ format

usually copyright or history_copyright This message must be in HTML format

Definition at line 1230 of file hooks.txt.

Referenced by ChangesFeed::__construct(), UpdateLogging::execute(), ChangesFeed::execute(), QueryPage::execute(), SpecialVersion::getCopyrightAndAuthorList(), ChangesFeed::getFeedObject(), WikiRevision::getFormat(), ApiFormatBase::initPrinter(), HistoryAction::onView(), CoreParserFunctions::revisionday(), CoreParserFunctions::revisionday2(), CoreParserFunctions::revisionmonth(), CoreParserFunctions::revisionmonth1(), CoreParserFunctions::revisiontimestamp(), CoreParserFunctions::revisionyear(), and WikiRevision::setFormat().

◆ framework

For QUnit framework

Definition at line 2107 of file hooks.txt.

◆ GetCanonicalURL

return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options GetCanonicalURL

Definition at line 1105 of file hooks.txt.

◆ GetLocalURL

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys GetLocalURL

Definition at line 1230 of file hooks.txt.

◆ GetLogTypesOnUser

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify GetLogTypesOnUser

Definition at line 1230 of file hooks.txt.

◆ GetRelativeTimestamp

if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect to be fed to an HTMLForm object GetRelativeTimestamp

Definition at line 1230 of file hooks.txt.

◆ getUserPermissionsErrorsExpensive

presenting them properly to the user as errors is done by the caller return true getUserPermissionsErrorsExpensive

Definition at line 1324 of file hooks.txt.

◆ GitViewers

presenting them properly to the user as errors is done by the caller return true GitViewers

Definition at line 1337 of file hooks.txt.

◆ gzip

gzip

Definition at line 2117 of file hooks.txt.

◆ herself

they could be provided by a third party developer or written by the admin him herself

Initial value:

==Writing hooks==
 
A hook is a chunk of code run at some particular event. It consists of:
 
  * a function with some optional accompanying data

Definition at line 131 of file hooks.txt.

◆ hook

as a message key or array as accepted by ApiBase::dieUsageMsg after processing request parameters Return false to let the request returning an error message or an< edit result="Failure"> tag if $resultArr was filled which will be used in the intoken parameter and in the and a callback function which should return the or false if the user isn t allowed to obtain it The prototype of the callback function is where $pageid is the page ID of the page the token is requested for and $title is the associated Title object In the hook

Initial value:

==Rationale==
 
Hooks allow us to decouple optionally-run code from code that is run for
everyone. It allows MediaWiki hackers

Definition at line 23 of file hooks.txt.

Referenced by SpecialStatistics::execute().

◆ hooks

they could be provided by a third party developer or written by the admin him or *an object with a method and some optional accompanying data Hooks are registered by adding them to the global $wgHooks array for a given event All the following are valid ways to define hooks

Definition at line 73 of file hooks.txt.

Referenced by SpecialUpload::processVerificationError(), DelayedParserTest::requireHook(), DelayedParserTest::reset(), ApiQueryTest::setUp(), Sanitizer::setupAttributeWhitelist(), and DelayedParserTest::unleash().

◆ ID

occurs before session is loaded can be modified ID

Definition at line 2818 of file hooks.txt.

Referenced by UpdateLogging::execute(), BackupDumper::initProgress(), TextPassDumper::showReport(), BackupDumper::showReport(), and SpecialSearch::showResults().

◆ imagelinks

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an<a> element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form imagelinks

Definition at line 1530 of file hooks.txt.

◆ ImageOpenShowImageInlineBefore

see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false ImageOpenShowImageInlineBefore

Definition at line 1358 of file hooks.txt.

◆ insert

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an<a> element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and insert

Definition at line 1530 of file hooks.txt.

Referenced by DatabaseSqlite::insert().

◆ isolated

you don t have to do a grep find to see where the $wgReverseTitle variable is say If the code is well enough isolated

Definition at line 117 of file hooks.txt.

◆ it

presenting them properly to the user as errors is done by the caller return true but is called only if expensive checks are enabled Add a permissions error when permissions errors are checked for Return false if the user can t do it

Definition at line 1324 of file hooks.txt.

◆ key

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an<a> element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message key

Definition at line 1624 of file hooks.txt.

◆ Live

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections Live

Definition at line 1038 of file hooks.txt.

◆ LoginPasswordResetMessage

div flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS) 'LoginAuthenticateAudit' this hook is for auditing only etc LoginPasswordResetMessage

Definition at line 1632 of file hooks.txt.

◆ lt

logged in & lt

Initial value:

{{int:Accesskey-contributions}}
</td></tr><tr><td>
[http:
 
</td><td>
&amp

Definition at line 1631 of file hooks.txt.

◆ MarkPatrolled

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title MarkPatrolled

static

Definition at line 1679 of file hooks.txt.

◆ MediaWiki

those of us who don t want or need it can just leave it out The extensions don t even have to be shipped with MediaWiki

Definition at line 3 of file hooks.txt.

◆ message

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an<a> element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a message

◆ messages

namespace and then decline to actually register it RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok in case the handler function wants to provide a converted Content object Note that $result getContentModel () must return $toModel. Handler functions that modify $result should generally return false to further attempts at conversion. 'ContribsPager you ll need to handle error messages

Definition at line 896 of file hooks.txt.

Referenced by RCCacheEntryFactory::__construct(), DeletedContribsPager::__construct(), DeletedContribsPager::formatRow(), ContribsPager::formatRow(), OutputPage::getHeadLinksArray(), RCCacheEntryFactory::getMessage(), CheckLanguageCLI::help(), SideBarTest::initMessagesHref(), MessageCache::load(), and SideBarTest::testExpandMessages().

◆ name

and how to run hooks for an and one after Each event has a name

Definition at line 6 of file hooks.txt.

◆ NamespaceIsMovable

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place change it to the message you want to define which works for all SkinTemplate type skins see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array NamespaceIsMovable

static

Definition at line 1679 of file hooks.txt.

◆ occur

return true to allow those checks to occur

Definition at line 1105 of file hooks.txt.

◆ occurs

When an event occurs

Definition at line 150 of file hooks.txt.

◆ on

We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going on

Definition at line 86 of file hooks.txt.

Referenced by PopulateCategory::__construct(), Revision::__construct(), MockImageHandler::doFakeTransform(), BitmapHandler::doTransform(), PostgresField::fromText(), CheckLanguageCLI::help(), PoolCounterRedis::initAndPopPoolSlotList(), mccShowUsage(), JSTokenizer::newSyntaxError(), Preferences::profilePreferences(), JobQueueRedis::recyclePruneAndUndelayJobs(), PoolCounterRedis::registerAcquisitionTime(), PoolCounterRedis::release(), GlobalTest::testReadOnlySet(), and wfStreamThumb().

◆ otherwise

otherwise

Definition at line 2113 of file hooks.txt.

◆ page

page as if applicable</td >< td > ve followed a link to a page that doesn &To create the page

Definition at line 1956 of file hooks.txt.

Referenced by UpdateCollation::__construct(), BlockListPager::__construct(), Action::__construct(), ThumbnailImage::__construct(), PoolWorkArticleView::__construct(), MockImageHandler::doFakeTransform(), BitmapHandler::doTransform(), PoolWorkArticleView::doWork(), UpdateLogging::execute(), ApiQueryPageProps::execute(), PoolWorkArticleView::fallback(), HistoryAction::fetchRevisions(), PoolWorkArticleView::getCachedWork(), CachedAction::getCacheKey(), Action::getContext(), CreditsAction::getContributors(), InfoAction::getContributors(), CreditsAction::getCredits(), MediaTransformOutput::getDescLinkAttribs(), FormAction::getForm(), RevertFileAction::getFormFields(), User::getNewtalk(), RawAction::getOldId(), Action::getTitle(), CheckLanguageCLI::help(), Linker::normalizeSubpageLink(), PurgeAction::onSubmit(), RevertFileAction::onSubmit(), RevertFileAction::onSuccess(), RollbackAction::onView(), CreditsAction::onView(), RawAction::onView(), InfoAction::onView(), HistoryAction::onView(), InfoAction::pageInfo(), ApiEditPageTest::provideEditAppend(), ProtectAction::show(), RenderAction::show(), ViewAction::show(), DeleteAction::show(), UnprotectAction::show(), MovePageForm::showForm(), showHelp(), SideBarTest::testTrickyPipe(), wfPHPVersionError(), DumpLatestFilter::writeClosePage(), and DumpLatestFilter::writeOpenPage().

◆ pagelinks

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an<a> element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form pagelinks

Definition at line 1530 of file hooks.txt.

◆ ParserLimitReportPrepare

namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable (). 'NewRevisionFromEditComplete' if it s text intended for display in a monospaced font $report should be output in English ParserLimitReportPrepare

Definition at line 1746 of file hooks.txt.

◆ ParserTestTables

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values ParserTestTables

Definition at line 1956 of file hooks.txt.

◆ part

in this case you re responsible for computing and outputting the entire conflict part

Definition at line 1038 of file hooks.txt.

Referenced by HttpTest::provideURI().

◆ PingLimiter

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc etc PingLimiter

Definition at line 1956 of file hooks.txt.

◆ Preview

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections Preview

Definition at line 1038 of file hooks.txt.

◆ processing

null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an<a> element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after processing

Definition at line 1530 of file hooks.txt.

Referenced by MediaWikiTitleCodec::splitTitleString().

◆ request

div flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS) 'LoginAuthenticateAudit' this hook is for auditing only etc create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment this hook should only be used to add variables that depend on the current page request

Definition at line 1632 of file hooks.txt.

Referenced by ResourceLoaderContext::__construct(), WebInstaller::__construct(), WebInstaller::execute(), ResourceLoaderContext::getDirection(), WebInstaller::getFingerprint(), ResourceLoaderContext::getLanguage(), RedisLockManager::getLocksOnServer(), RequestContext::getRequest(), DerivativeContext::getRequest(), WebInstaller::getUrl(), RequestContext::setRequest(), DerivativeContext::setRequest(), WebInstaller::setupLanguage(), and WebInstaller::setVarsFromRequest().

◆ RevisionInsertComplete

For QUnit the mediawiki tests qunit testrunner dependency will be added to any module RevisionInsertComplete

Definition at line 2107 of file hooks.txt.

◆ rollback

presenting them properly to the user as errors is done by the caller return true use this to change the list i e rollback

Definition at line 1337 of file hooks.txt.

◆ saved

This code would result in ircNotify being run twice when an article is saved

Definition at line 177 of file hooks.txt.

◆ SearchableNamespaces

set to $title object and return false for a match for latest SearchableNamespaces

Definition at line 2149 of file hooks.txt.

◆ SearchAfterNoDirectMatch

the value to return A Title object or null SearchAfterNoDirectMatch

Definition at line 2125 of file hooks.txt.

◆ SearchGetNearMatch

set to $title object and return false for a match SearchGetNearMatch

Definition at line 2133 of file hooks.txt.

◆ SearchGetNearMatchBefore

external SearchGetNearMatchBefore

Definition at line 2122 of file hooks.txt.

◆ SearchGetNearMatchComplete

set to $title object and return false for a match SearchGetNearMatchComplete

Definition at line 2149 of file hooks.txt.

◆ set

it s the revision text itself In either if gzip is set

Definition at line 2113 of file hooks.txt.

Referenced by Makefile::main(), Makefile::manualWordsTable(), Makefile::parserCore(), MemcachedPeclBagOStuff::set(), and Makefile::toManyRules().

◆ ShowMissingArticle

set to $title object and return false for a match for latest after cache objects are set ShowMissingArticle

Definition at line 2149 of file hooks.txt.

◆ simple

and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and administrators to define code that will be run at certain points in the mainline and to modify the data run by that mainline code Hooks can keep mainline code simple

Definition at line 23 of file hooks.txt.

Referenced by Sanitizer::setupAttributeWhitelist().

◆ source

return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify source

Initial value:

=> 'name of hook' ).
$file: File object of file in question
$context: RequestContext (including language to use)
$single: Only extract the current language

Definition at line 1227 of file hooks.txt.

Referenced by JSTokenizer::getInput(), JSTokenizer::init(), Site::serialize(), Site::setSource(), and showUsage().

◆ storage

For QUnit the mediawiki tests qunit testrunner dependency will be added to any module it s the URL of the revision text in external storage

Definition at line 2107 of file hooks.txt.

◆ strategy

Using a hook running strategy

Definition at line 73 of file hooks.txt.

◆ TitleIsMovable

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle () will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage (). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known TitleIsMovable

Definition at line 2551 of file hooks.txt.

◆ token

as a message key or array as accepted by ApiBase::dieUsageMsg after processing request parameters Return false to let the request returning an error message or an<edit result="Failure"> tag if $resultArr was filled which will be used in the intoken parameter and in the and a callback function which should return the token

Definition at line 421 of file hooks.txt.

Referenced by CSSJanus_Tokenizer::__construct(), CSSJanus_Tokenizer::detokenize(), ApiQueryRevisions::execute(), SpecialRevisionDelete::execute(), ApiQueryRecentChanges::extractRowInfo(), ApiQueryRevisions::extractRowInfo(), and ApiQueryRecentChanges::run().

◆ true

return true

Definition at line 1530 of file hooks.txt.

Referenced by TestORMRowTest::constructorTestProvider(), CopyFileBackend::copyFileBatch(), CopyFileBackend::delFileBatch(), UploadStashCleanup::doOperations(), SpecialExport::execute(), ChangePassword::execute(), FixDoubleRedirects::execute(), CreateAndPromote::execute(), CreditsAction::getAuthor(), ParserCache::getDirty(), RawAction::getRawText(), RevisionItem::getRevisionLink(), LoginForm::hasSessionCookie(), Block::isHardblock(), User::isItemLoaded(), Skin::makeKnownUrlDetails(), XmlTypeCheck::newFromFilename(), ForeignAPIFile::newFromTitle(), RollbackAction::onView(), FileDeleteForm::prepareMessage(), ImportReporter::reportPage(), EraseArchivedFile::scrubVersion(), SearchMssql::searchText(), SearchOracle::searchText(), SpecialUndelete::showRevision(), SyncFileBackend::syncBackends(), SkinTemplate::tabAction(), SiteTest::testAddInterwikiId(), SiteTest::testAddNavigationId(), ApiParseTest::testParseNonexistentPage(), SpecialUploadStash::tryClearStashedUploads(), and HTMLForm::trySubmit().

◆ type

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle () will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage (). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable () always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable (). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage () 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime type

Definition at line 2573 of file hooks.txt.

◆ understand

Having all this code related to the title reversion option in one place means that it s easier to read and understand

Definition at line 116 of file hooks.txt.

◆ undo

presenting them properly to the user as errors is done by the caller return true use this to change the list i e undo

Definition at line 1337 of file hooks.txt.

◆ up

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set up

static

Definition at line 1679 of file hooks.txt.

Referenced by UpdateCollation::__construct(), PoolCounterRedis::initAndPopPoolSlotList(), XmlDumpWriter::openStream(), Preprocessor_Hash::preprocessToObj(), PoolCounterRedis::registerAcquisitionTime(), and PoolCounterRedis::release().

◆ UploadComplete

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle () will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage (). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable () always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable (). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage () 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime etc Preferred in most cases over UploadVerification object with all info about the upload string as detected by MediaWiki Handlers will typically only apply for specific mime types object an indexed array representing the problem with the where the first element is the message key and the remaining elements are used as parameters to the message UploadComplete

Definition at line 2573 of file hooks.txt.

◆ UploadVerifyFile

usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle () will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage (). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable () always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable (). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage () 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message UploadVerifyFile

Definition at line 2573 of file hooks.txt.

◆ used

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc etc otherwise the built in rate limiting checks are used

Definition at line 117 of file hooks.txt.

Referenced by Exif::__construct(), UsercreateTemplate::execute(), ModernTemplate::execute(), PNGMetadataExtractor::getMetadata(), OracleInstaller::getSchemaVars(), CheckLanguageCLI::help(), Preferences::profilePreferences(), UtfNormal::quickIsNFCVerify(), Sanitizer::removeHTMLtags(), SearchPostgres::searchQuery(), Sanitizer::setupAttributeWhitelist(), and showUsage().

◆ UserArrayFromResult

return false to override stock group addition can be modified UserArrayFromResult

Definition at line 2697 of file hooks.txt.

Referenced by WikiPage::getContributors(), UserArrayFromResultTest::getUserArrayFromResult(), and UserArray::newFromResult_internal().

◆ UserCanSendEmail

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code UserCanSendEmail

Definition at line 2697 of file hooks.txt.

◆ UserClearNewTalkNotification

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output UserClearNewTalkNotification

Definition at line 2697 of file hooks.txt.

◆ UserCreateForm

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid UserCreateForm

Definition at line 2697 of file hooks.txt.

◆ UserEffectiveGroups

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash UserEffectiveGroups

Definition at line 2697 of file hooks.txt.

◆ UserGetDefaultOptions

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to UserGetDefaultOptions

Definition at line 2697 of file hooks.txt.

◆ UserGetEmailAuthenticationTimestamp

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller which means it s potentially called dozens or hundreds of times You may want to cache the results of non trivial operations in your hook function for this reason change this to override email UserGetEmailAuthenticationTimestamp

Definition at line 2697 of file hooks.txt.

◆ UserGetImplicitGroups

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller which means it s potentially called dozens or hundreds of times You may want to cache the results of non trivial operations in your hook function for this reason change this to override email change this to override email authentication timestamp UserGetImplicitGroups

Definition at line 2697 of file hooks.txt.

◆ UserIsBlockedGlobally

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller which means it s potentially called dozens or hundreds of times You may want to cache the results of non trivial operations in your hook function for this reason change this to override email change this to override email authentication timestamp whether or not the user is blocked from that page whether or not the block allows users to edit their own user talk pages UserIsBlockedGlobally

Definition at line 2697 of file hooks.txt.

◆ UserIsEveryoneAllowed

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller which means it s potentially called dozens or hundreds of times You may want to cache the results of non trivial operations in your hook function for this reason change this to override email change this to override email authentication timestamp whether or not the user is blocked from that page whether or not the block allows users to edit their own user talk pages to be modified by the hook UserIsEveryoneAllowed

Definition at line 2697 of file hooks.txt.

◆ UserLogin

and how to run hooks for an and one after Each event has a preferably in CamelCase For UserLogin

Definition at line 6 of file hooks.txt.

◆ UserLoginComplete

occurs before session is loaded can be modified UserLoginComplete

Definition at line 2818 of file hooks.txt.

◆ UserRights

return false to override stock group removal can be modified UserRights

Definition at line 2838 of file hooks.txt.

◆ UserSetCookies

return false to override stock group removal can be modified modifiable UserSetCookies

Definition at line 2838 of file hooks.txt.

◆ UserSetEmailAuthenticationTimestamp

return false to override stock group removal can be modified modifiable will be added to $_SESSION change this to override new email address UserSetEmailAuthenticationTimestamp

Definition at line 2838 of file hooks.txt.

◆ UserToolLinksEdit

return false to override stock group removal can be modified modifiable will be added to $_SESSION change this to override new email address change this to override email authentication timestamp UserToolLinksEdit

Definition at line 2838 of file hooks.txt.

◆ values

null means default in associative array with keys and values unescaped Should be merged with default values

Definition at line 177 of file hooks.txt.

Referenced by LocalSettingsGenerator::__construct(), Exif::__construct(), LocalSettingsGenerator::buildMemcachedServerList(), LanguageHsb::convertGrammar(), LanguageSl::convertGrammar(), LanguageDsb::convertGrammar(), LanguageBs::convertGrammar(), LocalSettingsGenerator::getDefaultText(), CheckLanguageCLI::help(), and WfBCP47Test::provideLanguageCodes().

◆ Warning

return false to override stock group addition can be modified try getUserPermissionsErrors userCan checks are continued by internal code can override on output return false to not delete it return false to override the default password checks this Boolean value will be checked to determine if the password was valid return false to implement your own hashing method this String will be used as the hash which may be added to this hook is run right before returning the options to the caller Warning

Definition at line 2697 of file hooks.txt.

◆ weird

We ve cleaned up the code here by removing clumps of weird

Definition at line 86 of file hooks.txt.

◆ writer

An extension writer

Definition at line 51 of file hooks.txt.

Referenced by WikiExporter::__construct(), WikiExporter::closeStream(), LCStoreCDB::finishWrite(), WikiExporter::openStream(), WikiExporter::outputLogStream(), WikiExporter::outputPageStream(), LCStoreCDB::set(), and LCStoreCDB::startWrite().

◆ WRONG_PASS

div flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS) 'LoginAuthenticateAudit' this hook is for auditing only WRONG_PASS

Definition at line 1632 of file hooks.txt.

Referenced by LoginForm::authenticateUserData().

◆ wrongpassword

do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled also a ContextSource wrongpassword

Definition at line 1956 of file hooks.txt.

Typedefs

Functions

Variables

Typedef Documentation

◆ $result

◆ myext.tests

Function Documentation

◆ array() [1/2]

◆ array() [2/2]

◆ follows()

◆ func()

◆ if()

◆ ldapLogin()

◆ options()

◆ output()

◆ query()

◆ system()

◆ values()

◆ wfMessage()

Variable Documentation

◆ ! $text

◆ $abortMsg

◆ $allowUsertalk

◆ $article

◆ $attribs

◆ $colours

◆ $cookies

◆ $customAttribs

◆ $defaultOptions

◆ $editor

◆ $editPage

◆ $error

◆ $extTypes

◆ $flags

◆ $form

◆ $handlerParams

◆ $hash

◆ $html

◆ $incrBy

◆ $inject_html

◆ $ldapServer

◆ $link

◆ $linksUpdate

◆ $localize

◆ $mime

◆ $modeName

◆ $name

◆ $namespaces

◆ $newtalks

◆ $options

◆ $output

◆ $parser

◆ $password

◆ $personal_urls

◆ $pre

◆ $query

◆ $res

◆ $resourceLoader

◆ $ret

◆ $retval

◆ $rev

◆ $revert

◆ $right

◆ $sectionContent

◆ $siteNotice

◆ $skin

◆ $special

◆ $tabindex

◆ $tables

◆ $term

◆ $time

◆ $title

◆ $tools

◆ $upload

◆ $user

◆ $vars

◆ $wgCapitalizeTitle

◆ $wgHooks

◆ $wgNotifyArticle

◆ AbortAutoAccount