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. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. '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 '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 '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 '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. '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 IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() '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 Sanitizer::validateEmail(), 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. '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) '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 '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. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. '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
for adding new MIME info to the list Use $mimeMagic	addExtraTypes ( $stringOfTypes)

the	array () calling protocol came about after MediaWiki 1.4rc1.

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,...) or a MessageSpecifier instance(you might want to use ApiMessage to provide machine-readable details for the API). For consistency

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

	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

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 whether this was an auto creation 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 whether this was an auto creation 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 "<div ...>$1</div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services

Variables
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 local account incomplete &	$abortMsg

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

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges 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 true if there is text before this autocomment	$auto

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges	$changesList

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable &	$code

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

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content	$content

null means default &	$customAttribs

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next refreshes the diff cache allow viewing deleted revs &	$differenceEngine

returning false will NOT prevent logging	$e

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace 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 inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor' you ll need to handle error etc yourself modifying $error and returning true will cause the contents of $error to be echoed at the top of the edit form as wikitext Return true without altering $error to allow the edit to proceed &	$editor

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges 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

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state	$generateHtml

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves	$handler

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

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

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check	$image

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 before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled	$incrBy

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

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace 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 inclusive	$limit

the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set 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(). 'NewDifferenceEngine' if it s text intended for display in a monospaced font	$localize

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 or wrap existing services the preferred way to define a new service is the $wgServiceWiringFiles array change it to the message you want to define you are encouraged to submit patches to MediaWiki s core to add new MIME types to mime types	$mimeMagic

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace 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

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context	$options

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output	$out

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object &	$output

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 before the output is cached	$page

do that in ParserLimitReportFormat instead	$parser

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context	$parserOutput

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 before the output is cached one of or reset my talk my contributions etc &	$personal_urls

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges 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

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify	$query

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next	$refreshCache

this hook is for auditing only	$req

error also a ContextSource you ll probably need to make sure the header is varied on	$request

Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink() instead. & $feedLinks hooks can tweak the array to change how login etc forms should look	$requests

namespace and then decline to actually register it file or subcat	$res

error also a ContextSource you ll probably need to make sure the header is varied on such as when responding to a resource loader request or generating HTML output &	$resourceLoader

For QUnit the mediawiki tests qunit testrunner dependency will be added to any module &	$ResourceLoader

this hook is for auditing only	$response

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

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 before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect &	$returnTo

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 before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string &	$returnToQuery

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 local 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

this hook is for auditing only etc instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters create2 Corresponds to logging log_action database field and which is displayed in the UI &	$revert

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context	$revId

usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template	$section

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

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 or wrap existing services the preferred way to define a new service is the $wgServiceWiringFiles array	$services

the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set 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

this hook is for auditing only RecentChangesLinked and Watchlist	$special

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set	$status = Status::newGood()` to allow deletion

returning false will NOT prevent logging a wrapping ErrorException	$suppressed

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

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist &	$tables

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books	$tag

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping	$template

external whereas SearchGetNearMatch runs after	$term

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

namespace and then decline to actually register it file or subcat img or subcat	$title

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 before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values &	$type

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next refreshes the diff cache	$unhide

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 local account	$user

this hook is for auditing only or null if authentication failed before getting that far	$username

static configuration should be added through ResourceLoaderGetConfigVars instead &	$vars

An extension or a local 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 local 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

error	__pad0__

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

An extension or a local 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 local	admin

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace 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 inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor' you ll need to handle error etc yourself	Alternatively

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 local 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 local patches for two options in MediaWiki One reverses the order of a title before displaying the	article

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace 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 inclusive false for	ascending

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place	ATTENTION

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that	AuthPluginAutoCreate

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub	AutopromoteCondition

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

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array	BeforeDisplayNoArticleText

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable	BeforeInitialize

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable	BeforeParserFetchFileAndTitle

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result	BitmapHandlerTransform

this hook is for auditing only etc instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters	block

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves set to a MediaTransformOutput	BlockIp

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves set to a MediaTransformOutput the error message to be returned in an array	BlockIpComplete

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

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point	ChangeTagCanCreate

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag	ChangeTagCanDelete

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 local 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

namespace addition is	conditional

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 local 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 local patches	Consider

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace	ContentHandlerDefaultModelFor

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired	ContentModelCanBeUsedOn

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace 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 inclusive false for true for descending	ContributionsLineEnding

error also a ContextSource you ll probably need to make sure the header is varied on such as when responding to a resource loader request or generating HTML output included in	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 before the output is cached one of	create

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	EditPageGetDiffContent

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

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

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

Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add	feeds

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges 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 remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges 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

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook	function

null for the local wiki Added should default to null in handler	functions

null for the local wiki Added should default to null in handler for backwards compatibility	GalleryGetModes

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options	GetCanonicalURL

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next refreshes the diff cache allow viewing deleted revs difference engine object to be used for diff	GetDoubleUnderscoreIDs

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

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves set to a MediaTransformOutput the error message to be returned in an array you should do so by altering $wgNamespaceProtection and $wgNamespaceContentModels outside the	handler

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

presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc next in line in page	history

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

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 or wrap existing services	However

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 for the local wiki Added	in

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 whether this was an auto creation 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

usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template to be included in the	link

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

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 whether this was an auto creation	LogEventsListGetExtraInputs

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 before the output is cached one of	login

this hook is for auditing only etc	LoginFormValidErrorMessages

this hook is for auditing only etc instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters	LogLine

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 whether this was an auto creation 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

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace 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 inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor' you ll need to handle error	messages

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 or wrap existing services the preferred way to define a new service is the $wgServiceWiringFiles array change it to the message you want to define	MimeMagicGuessFromContent

for adding new MIME types to the list	ModifyExportQuery

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

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 before the output is cached one of or reset my talk	page

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

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

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(). 'NewDifferenceEngine' 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	ParserTestParser

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

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been	performed

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 before the output is cached one of or reset	PerformRetroactiveAutoblock

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 before the output is cached one of or reset 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

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	replace

this hook is for auditing only etc instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters 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

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

Allows to change the fields on the form that will be generated	rss

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

external	SearchableNamespaces

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

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

the value to return A Title object or null	SearchGetNearMatchComplete

the value to return A Title object or null for latest	SecondaryDataUpdates

the value to return A Title object or null for latest to be modified or replaced by the hook handler	SecuritySensitiveOperationStatus

the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible	SelfLinkBegin

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

the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set	ShortPagesQuery

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 local 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

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be	skipped

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next refreshes the diff cache allow viewing deleted revs difference engine object to be used for diff	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

This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some	string

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

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

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

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

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

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

An extension	writer

this hook is for auditing only	WRONG_PASS

Typedef Documentation

◆ $result

namespace being checked & $result

Definition at line 1652 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 2540 of file hooks.txt.

Function Documentation

◆ addExtraTypes()

for adding new MIME info to the list Use $mimeMagic addExtraTypes ( $stringOfTypes )

◆ array() [1/2]

the array ( )

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 34 of file hooks.txt.

◆ if()

if ( $wgReverseTitle )

Definition at line 58 of file hooks.txt.

References $article.

◆ ldapLogin()

function ldapLogin	(	$username,
		$password
	)

Definition at line 194 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(), MediaWiki\Logger\Monolog\KafkaHandler::__construct(), FormOptions::add(), MediaWiki\Logger\Monolog\KafkaHandler::addMessages(), XmlSelect::addOption(), ApiQueryBase::addOption(), XmlSelect::addOptions(), ApiQueryBase::addWhereRange(), CompareParsers::checkOptions(), FormOptions::consumeValue(), FormOptions::consumeValues(), FormOptions::delete(), SpecialBlockList::execute(), FormOptions::fetchValuesFromRequest(), FormOptions::getAllValues(), SpecialBlockList::getBlockListPager(), FormOptions::getChangedValues(), XmlSelect::getHTML(), FormOptions::getUnconsumedValues(), FormOptions::getValue(), FormOptions::offsetExists(), CompareParsers::processRevision(), FormOptions::reset(), ApiQueryBase::resetQueryParams(), ApiQueryBase::select(), ExtraParserTest::setUp(), FormOptions::setValue(), showUsage(), UserOptions::showUsageAndExit(), HtmlAutoCompleteSelectFieldTest::testGetAttributes(), ExtraParserTest::testGetPreloadText(), ExtraParserTest::testParse(), ExtraParserTest::testPreprocess(), ExtraParserTest::testPreSaveTransform(), XmlSelectTest::testSetDefaultAfterAddingOptions(), ExtraParserTest::testTrackingCategory(), ExtraParserTest::testTrackingCategorySpecial(), FormOptions::validateBounds(), FormOptions::validateName(), and MediaWiki\Logger\Monolog\KafkaHandler::warning().

◆ 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 whether this was an auto creation default is conds Array Extra conditions for the query ( )

References default, false, if, in, is(), and of.

◆ 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 whether this was an auto creation 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 "<div ...>$1</div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services

References are, display, false, in, is(), message, and that.

Variable Documentation

◆ $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 local account incomplete& $abortMsg

Definition at line 250 of file hooks.txt.

◆ $article

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges 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:

{
 
            Hooks::run( 'ArticleShowComplete', array( &$article ) )

Definition at line 78 of file hooks.txt.

Referenced by EditPage::__construct(), ProtectionForm::__construct(), EditPageTest::assertEdit(), Orphans::checkSeparation(), CategoryViewer::columnList(), ApiParse::execute(), RebuildFileCache::execute(), ParserCache::get(), ParserCache::getDirty(), ParserCache::getETag(), ParserCache::getKey(), ParserCache::getOptionsKey(), ParserCache::getParserOutputKey(), ListredirectsPage::getRedirectTarget(), if(), MediaWiki::initializeArticle(), Article::newFromWikiPage(), MediaWiki::performRequest(), CategoryFinder::run(), DoubleRedirectJob::run(), EditPageTest::testCheckDirectEditingDisallowed_forNonTextContent(), TitleTest::testExists(), PageArchive::undeleteRevisions(), and view().

◆ $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 1819 of file hooks.txt.

Referenced by PPNode_Hash_Tree::__toString(), OutputPage::addElement(), HTMLForm::addHiddenField(), ProtectionForm::buildForm(), Xml::buildTable(), Xml::buildTableRow(), Xml::check(), Html::check(), Xml::checkLabel(), UploadBase::checkSvgScriptCallback(), EditPage::displayPreviewArea(), XMPReader::doAttribs(), WebInstaller::docLink(), Skin::doEditSectionLink(), Html::dropDefaults(), Html::element(), Xml::element(), Xml::elementClean(), XmlTypeCheck::elementClose(), XmlTypeCheck::elementOpen(), Xml::expandAttributes(), Html::expandAttributes(), Xml::fieldset(), CategoryViewer::formatList(), HTMLMultiSelectField::formatOptions(), HTMLRadioField::formatOptions(), SpecialUndelete::formatRevisionRow(), HTMLForm::formatSection(), HTMLAutoCompleteSelectField::getAttributes(), HTMLComboboxField::getAttributes(), HTMLForm::getButtons(), OOUIHTMLForm::getButtons(), VFormHTMLForm::getButtons(), DatabaseInstaller::getCheckBox(), EditPage::getCheckboxes(), MediaTransformOutput::getDescLinkAttribs(), EditPage::getEditButtons(), getExternalLinkAttribs(), HTMLForm::getFormAttributes(), VFormHTMLForm::getFormAttributes(), HTMLForm::getHiddenFields(), CategoryViewer::getHTML(), ChangeTagsLogItem::getHTML(), ChangeTagsRevisionItem::getHTML(), RevDelRevisionItem::getHTML(), HTMLCheckMatrix::getInputHTML(), HTMLTextAreaField::getInputHTML(), HTMLTextField::getInputHTML(), Licenses::getInputHTML(), HTMLFormFieldCloner::getInputHTMLForKey(), HTMLComboboxField::getInputOOUI(), HTMLSelectField::getInputOOUI(), HTMLTextAreaField::getInputOOUI(), HTMLTextField::getInputOOUI(), UploadSourceField::getLabelHtml(), TablePager::getLimitSelect(), IRCColourfulRCFeedFormatter::getLine(), HTMLCheckMatrix::getOneCheckbox(), HTMLMultiSelectField::getOneCheckbox(), DatabaseInstaller::getPasswordBox(), EditPage::getPreviewText(), LogFormatter::getRestrictedElement(), DBQueryError::getTechnicalDetails(), DatabaseInstaller::getTextBox(), HTMLTextField::getType(), Html::hidden(), HistoryPager::historyLine(), Html::htmlHeader(), Xml::input(), Html::input(), Xml::inputLabel(), Xml::inputLabelSep(), Xml::label(), Html::label(), Linker::link(), Linker::linkAttribs(), Xml::listDropDown(), TestRecentChangesHelper::makeCategorizationRecentChange(), TestRecentChangesHelper::makeDeletedEditRecentChange(), TestRecentChangesHelper::makeEditRecentChange(), DummyLinker::makeExternalLink(), Linker::makeExternalLink(), DummyLinker::makeHeadline(), TestRecentChangesHelper::makeLogRecentChange(), Linker::makeMediaLinkFile(), TestRecentChangesHelper::makeNewBotEditRecentChange(), TestRecentChangesHelper::makeRecentChange(), Revision::newFromArchiveRow(), Html::openElement(), Xml::openElement(), Xml::option(), Licenses::outputOption(), Xml::password(), CoreTagHooks::pre(), Html::radio(), Xml::radio(), Xml::radioLabel(), Html::rawElement(), LinkHolderArray::replaceInternal(), RecentChange::setAttribs(), ImageGalleryBase::setAttributes(), SpecialImport::showForm(), EditPage::showTextbox(), EditPage::showTextbox1(), Xml::span(), XMPReader::startElement(), TextPassDumper::startElement(), XMPReader::startElementModeInitial(), XMPReader::startElementModeLi(), XMPReader::startElementModeLiLang(), XMPReader::startElementModeSimple(), XMPReader::startElementModeStruct(), LogFormatter::styleRestricedElement(), Xml::submitButton(), Xml::tags(), HtmlTest::testDropDefaults(), SideBarTest::testRespectExternallinktarget(), SideBarTest::testRespectWgnofollowlinks(), SideBarTest::testTestAttributesAssertionHelper(), Xml::textarea(), Html::textarea(), ThumbnailImage::toHtml(), TraditionalImageGallery::toHTML(), Linker::tooltipAndAccesskeyAttribs(), Linker::userToolLinks(), Sanitizer::validateAttributes(), Sanitizer::validateTagAttributes(), and Xml::wrapClass().

◆ $auto

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges 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 true if there is text before this autocomment $auto

Definition at line 1416 of file hooks.txt.

Referenced by PatrolLog::buildParams(), RecentChange::doMarkPatrolled(), Linker::formatAutocomments(), RecentChange::markPatrolled(), and PatrolLog::record().

◆ $changesList

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges $changesList

Definition at line 1345 of file hooks.txt.

Referenced by ChangesList::getArticleLink().

◆ $code

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable& $code

Definition at line 847 of file hooks.txt.

◆ $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 1506 of file hooks.txt.

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

◆ $content

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content

Definition at line 1039 of file hooks.txt.

◆ $customAttribs

null means default& $customAttribs

Definition at line 1801 of file hooks.txt.

Referenced by DummyLinker::link(), Linker::link(), Skin::link(), DummyLinker::linkKnown(), Linker::linkKnown(), Skin::linkKnown(), EditPage::showTextbox(), and EditPage::showTextbox1().

◆ $differenceEngine

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next refreshes the diff cache allow viewing deleted revs& $differenceEngine

Definition at line 1461 of file hooks.txt.

Referenced by ContentHandler::createDifferenceEngine().

◆ $e

returning false will NOT prevent logging $e

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

Definition at line 1940 of file hooks.txt.

◆ $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 1224 of file hooks.txt.

Referenced by EnotifNotifyJob::run(), RecentChange::save(), EditAction::show(), and WatchedItemStore::updateNotificationTimestamp().

◆ $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 1369 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 2554 of file hooks.txt.

Referenced by AutoloadGenerator::__construct(), GenericArrayObject::__construct(), KkConverter::__construct(), GanConverter::__construct(), ZhConverter::__construct(), LanguageConverter::__construct(), BotPassword::__construct(), LanguageIu::__construct(), LanguageShi::__construct(), LanguageSr::__construct(), ApiPageSet::__construct(), DatabaseBase::__construct(), MemcachedClient::_load_items(), MemcachedClient::_set(), ApiResult::addContentField(), ApiResult::addContentValue(), User::addToDatabase(), ApiResult::addValue(), ApiErrorFormatter::addWarningOrError(), MediaWiki\Auth\AuthManager::autoCreateUser(), JobQueue::batchPush(), SpecialBlock::blockLogFlags(), PPFrame_DOM::cachedExpand(), PPTemplateFrame_DOM::cachedExpand(), PPFrame_Hash::cachedExpand(), PPTemplateFrame_Hash::cachedExpand(), Preprocessor::cacheGetTree(), Preprocessor::cacheSetTree(), callParserFunction(), MediaWiki\Auth\AuthManager::canCreateAccount(), CentralIdLookup::centralIdFromLocalUser(), CentralIdLookup::centralIdFromName(), CheckStorage::check(), Article::checkFlags(), WikiPage::checkFlags(), TrackBlobs::checkIntegrity(), FileRepo::cleanupBatch(), WikiPage::commitRollback(), CompressOld::compressPage(), Revision::compressRevisionText(), FileRepo::concatenate(), WebPHandler::decodeExtendedChunkHeader(), Revision::decompressRevisionText(), CachedBagOStuff::delete(), StringUtils::delimiterReplace(), StringUtils::delimiterReplaceCallback(), JobQueueDB::doBatchPush(), JobQueueFederated::doBatchPush(), JobQueueRedis::doBatchPush(), JobQueueDB::doBatchPushInternal(), WikiPage::doCreate(), Article::doEdit(), WikiPage::doEdit(), Article::doEditContent(), WikiPage::doEditContent(), CachedBagOStuff::doGet(), MemcachedBagOStuff::doGet(), MultiWriteBagOStuff::doGet(), ReplicatedBagOStuff::doGet(), SqlBagOStuff::doGet(), WikiPage::doModify(), OracleInstaller::doOpenConnection(), DjVuHandler::doTransform(), SvgHandler::doTransform(), TransformationalImageHandler::doTransform(), MockBitmapHandler::doTransform(), MockSvgHandler::doTransform(), SquidPurgeClient::doWrites(), DumpRev::execute(), FixBug20757::execute(), StorageTypeStats::execute(), Title::exists(), PPFrame_DOM::expand(), PPFrame_Hash::expand(), extensionSubstitution(), extractSections(), Revision::fetchFromConds(), FileRepo::findFile(), RepoGroup::findFiles(), FileRepo::findFiles(), LocalRepo::findFiles(), BlockLogFormatter::formatBlockFlags(), OldChangesList::formatChangeLine(), File::generateAndSaveThumb(), File::generateBucketsIfNeeded(), BagOStuff::get(), ApiFeedWatchlist::getAllowedParams(), ApiImageRotate::getAllowedParams(), ApiPageSet::getAllowedParams(), ApiPurge::getAllowedParams(), ApiQuery::getAllowedParams(), ApiQueryLogEvents::getAllowedParams(), ApiSetNotificationTimestamp::getAllowedParams(), ApiWatch::getAllowedParams(), Title::getArticleID(), Article::getAutosummary(), WikiPage::getAutosummary(), ContentHandler::getAutosummary(), Title::getContentModel(), Title::getEarliestRevTime(), ApiBase::getFinalParams(), Title::getFirstRevision(), DerivativeRequest::getHeader(), WebRequest::getHeader(), ApiBase::getHelpFlags(), ApiQueryGeneratorBase::getHelpFlags(), ApiHelp::getHelpInternal(), HTMLButtonField::getInputHTML(), LogFormatter::getIRCActionText(), Title::getLatestRevID(), Title::getLength(), ReplicatedBagOStuff::getMulti(), Title::getNextRevisionID(), User::getOptions(), ParserTest::getParser(), Parser::getPreloadText(), Title::getPreviousRevisionID(), Revision::getRecentChange(), Revision::getRevisionText(), UIDGenerator::getSequentialPerNodeIDs(), HistoryBlobStub::getText(), Revision::getTimestampFromId(), SpecialVersion::getVersion(), BagOStuff::getWithSetCallback(), MemcachedPeclBagOStuff::getWithToken(), DBAccessObjectUtils::hasFlags(), User::idForName(), User::idFromName(), PPFrame_DOM::implodeWithFlags(), PPFrame_Hash::implodeWithFlags(), CheckStorage::importRevision(), WikiRevision::importUpload(), FSFileBackendList::initIterator(), Revision::insertOn(), EditPage::internalAttemptSave(), Title::isRedirect(), FixBug20757::isUnbrokenStub(), LocalFile::load(), User::load(), Revision::loadFromConds(), User::loadFromDatabase(), LocalFile::loadFromDB(), OldLocalFile::loadFromDB(), User::loadFromId(), WikiPage::loadLastEdit(), CentralIdLookup::localUserFromCentralId(), LocalIdLookup::lookupCentralIds(), LocalIdLookup::lookupUserNames(), BagOStuff::merge(), ReplicatedBagOStuff::merge(), WinCacheBagOStuff::merge(), SqlBagOStuff::merge(), BagOStuff::mergeViaLock(), moveToExternal(), CentralIdLookup::nameFromCentralId(), BotPassword::newFromCentralId(), Revision::newFromConds(), User::newFromConfirmationCode(), Revision::newFromId(), Title::newFromID(), Revision::newFromPageId(), Revision::newFromTitle(), BotPassword::newFromUser(), LBFactorySimple::newMainLB(), UIDGenerator::newRawUUIDv4(), UIDGenerator::newSequentialPerNodeID(), UIDGenerator::newSequentialPerNodeIDs(), BotPassword::newUnsaved(), UIDGenerator::newUUIDv4(), SpecialChangeContentModel::onSubmit(), GenerateSitemap::open(), SpecialUploadStash::outputLocallyScaledThumb(), SpecialUploadStash::outputThumbFromStash(), ConverterRule::parse(), ConverterRule::parseFlags(), IuConverter::parseManualRule(), KkConverter::parseManualRule(), ShiConverter::parseManualRule(), SrConverter::parseManualRule(), JobQueueGroup::pop(), preprocessToDom(), Preprocessor_DOM::preprocessToObj(), Preprocessor_Hash::preprocessToObj(), Preprocessor_DOM::preprocessToXml(), FileRepo::publish(), LocalFile::publish(), FileRepo::publishBatch(), LocalFile::publishTo(), JobQueue::push(), ChangesList::recentChangesFlags(), ApiResult::removeValue(), replaceVariables(), resolveStub(), CachedBagOStuff::set(), MultiWriteBagOStuff::set(), ReplicatedBagOStuff::set(), SqlBagOStuff::set(), ApiResult::setContentField(), ApiResult::setContentValue(), ApiResult::setElement(), setFunctionHook(), ParserDiffTest::setFunctionHook(), setFunctionTagHook(), ApiResult::setValue(), LBFactoryMulti::shutdown(), LBFactorySimple::shutdown(), FileRepo::store(), FileRepo::storeBatch(), StoreBatchTest::storeit(), MediaWikiParserTest::suite(), EditPageTest::testCreatePage(), EditPageTest::testCreatePageTrx(), WikitextContentHandlerTest::testGetAutosummary(), XhprofTest::testRawData(), EditPageTest::testUpdatePage(), EditPageTest::testUpdatePageTrx(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider::testUserExists(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::testUserExists(), File::thumbName(), File::transform(), ForeignAPIFile::transform(), File::transformErrorOutput(), JobQueueFederated::tryJobInsertions(), WANObjectCache::unwrap(), LocalFile::upload(), MediaWiki\Auth\AuthManager::userExists(), DummyLinker::userToolLinks(), Linker::userToolLinks(), Skin::userToolLinks(), and wfResetOutputBuffers().

◆ $generateHtml

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state $generateHtml

Definition at line 1045 of file hooks.txt.

Referenced by JsonContent::fillParserOutput(), TextContent::fillParserOutput(), WikitextContent::fillParserOutput(), AbstractContent::getParserOutput(), and MessageContent::getParserOutput().

◆ $handler

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler

Definition at line 882 of file hooks.txt.

◆ $handlerParams

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

Definition at line 1613 of file hooks.txt.

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

◆ $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 1818 of file hooks.txt.

Referenced by ImageGalleryBase::add(), CachedAction::addCachedHTML(), WebInstallerOutput::addHTML(), WebInstallerPage::addHTML(), WebInstallerOutput::addHTMLNoFlush(), MediaWikiTestCase::assertValidHtmlDocument(), MediaWikiTestCase::assertValidHtmlSnippet(), SpecialEditTags::buildCheckBoxes(), SpecialRevisionDelete::buildCheckBoxes(), ChangeTags::buildTagFilterSelector(), HTMLForm::displaySection(), WebInstallerInstall::endStage(), Sanitizer::escapeHtmlAllowEntities(), ApiHelp::execute(), SpecialPageExecutor::executeSpecialPage(), ApiFeedContributions::feedItemDesc(), TextContent::fillParserOutput(), ApiHelp::fixHelpLinks(), OldChangesList::formatChangeLine(), FeedUtils::formatDiffRow(), HTMLMultiSelectField::formatOptions(), HTMLRadioField::formatOptions(), HTMLForm::formatSection(), CategoryViewer::generateLink(), LogEventsList::getActionSelector(), PreferencesForm::getButtons(), SpecialVersion::getCreditsForExtension(), MWDebug::getDebugHTML(), HTMLFormField::getDiv(), Title::getEditNotices(), ApiHelp::getHelp(), WebInstaller::getHelpBox(), HTMLForm::getHiddenFields(), HTMLForm::getHTML(), CssContent::getHtml(), JavaScriptContent::getHtml(), DBConnectionError::getHTML(), QuickTemplate::getHTML(), OutputPage::getHtmlFromLoaderLinks(), SpecialPageExecutor::getHTMLFromSpecialPage(), HTMLFormField::getInline(), HTMLCheckMatrix::getInputHTML(), HTMLMultiSelectField::getInputHTML(), HTMLRadioField::getInputHTML(), HTMLFormFieldCloner::getInputHTML(), HTMLFormFieldCloner::getInputHTMLForKey(), HTMLFormField::getLabelHtml(), LoginSignupSpecialPage::getPageHtml(), MessageContent::getParserOutput(), SkinTemplate::getPersonalToolsList(), HTMLFormField::getRaw(), Article::getRedirectHeaderHtml(), HTMLCheckMatrix::getTableRow(), HTMLFormField::getTableRow(), Html::htmlHeader(), ImageGalleryBase::insert(), Xml::isWellFormedXmlFragment(), DummyLinker::link(), Linker::link(), Skin::link(), DummyLinker::linkKnown(), Linker::linkKnown(), Skin::linkKnown(), Skin::makeFooterIcon(), DummyLinker::makeHeadline(), BaseTemplate::makeLink(), BaseTemplate::makeListItem(), DummyLinker::makeMediaLinkFile(), Linker::makeMediaLinkFile(), DummyLinker::makeMediaLinkObj(), Linker::makeMediaLinkObj(), LogFormatter::makePageLink(), DummyLinker::makeSelfLinkObj(), Linker::makeSelfLinkObj(), QueryPage::outputResults(), Installer::parse(), SpecialJavaScriptTest::plainQUnit(), OldChangesList::recentChangesLine(), LogFormatterTestCase::removeSomeHtml(), renderImageGallery(), Linker::revDeleteLink(), Linker::revDeleteLinkDisabled(), WebInstaller::showHelpBox(), SpecialSearch::showHit(), FileDuplicateSearchPage::showList(), WebInstaller::showMessage(), LogEventsList::showOptions(), SpecialTags::showTagList(), stripOuterParagraph(), EnhancedChangesListTest::testBeginRecentChangesList_html(), EnhancedChangesListTest::testCategorizationLineFormatting(), EnhancedChangesListTest::testCategorizationLineFormattingWithRevision(), SpecialEditWatchlistTest::testClearPage_hasClearButtonForm(), SpecialEditWatchlistTest::testEditRawPage_hasTitlesBox(), EnhancedChangesListTest::testEndRecentChangesList(), SanitizerTest::testEscapeHtmlAllowEntities(), HttpErrorTest::testGetHtml(), StatusTest::testGetHtml(), HTMLFormTest::testGetHTML_empty(), TextContentTest::testGetParserOutput(), SpecialBlankPageTest::testHasWikiMsg(), HtmlAutoCompleteSelectFieldTest::testOptionalSelectElement(), EnhancedChangesListTest::testRecentChangesLine(), SpecialSearchTest::testRewriteQueryWithSuggestion(), SpecialEditWatchlistTest::testRootPage_displaysExplanationMessage(), SpecialWatchlistTest::testUserWithNoWatchedItems_displaysNoWatchlistMessage(), ImagePage::view(), ParserTest::wellFormed(), HTMLForm::wrapForm(), OOUIHTMLForm::wrapForm(), VFormHTMLForm::wrapForm(), PreferencesForm::wrapForm(), and SkinTemplate::wrapHTML().

◆ $image

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check $image

Definition at line 875 of file hooks.txt.

Referenced by NewParserTest::addDBDataOnce(), ApiQueryImageInfo::checkParameterNormalise(), MockBitmapHandler::doClientImage(), MockImageHandler::doFakeTransform(), BitmapHandler_ClientOnly::doTransform(), DjVuHandler::doTransform(), SvgHandler::doTransform(), TransformationalImageHandler::doTransform(), MockBitmapHandler::doTransform(), MockDjVuHandler::doTransform(), MockSvgHandler::doTransform(), InitSiteStats::execute(), UploadDumper::fetchUsed(), RepoGroup::findFile(), RepoGroup::findFiles(), ExifBitmapHandler::formatMetadata(), GIFHandler::formatMetadata(), PNGHandler::formatMetadata(), TransformationalImageHandler::getClientScalingThumbnailImage(), GIFHandler::getCommonMetaArray(), PNGHandler::getCommonMetaArray(), DjVuHandler::getDjVuImage(), GIFHandler::getImageArea(), ImageHandler::getImageArea(), ResourceLoaderImageModule::getImages(), DjVuHandler::getImageSize(), ExifBitmapHandler::getImageSize(), GIFHandler::getLongDesc(), PNGHandler::getLongDesc(), DjVuHandler::getMetadata(), DjVuHandler::getMetaTree(), ResourceLoaderImageModule::getModifiedTime(), SearchNearMatcher::getNearMatchInternal(), MediaHandler::getPageDimensions(), ImageHandler::getScriptedTransform(), ResourceLoaderImageModule::getStyles(), MediaHandler::getTransform(), GIFHandler::isAnimatedImage(), PNGHandler::isAnimatedImage(), WebPHandler::isAnimatedImage(), ResourceLoader::makeModuleResponse(), ApiQueryImageInfo::mergeThumbParams(), BitmapHandler::normaliseParams(), BitmapHandler_ClientOnly::normaliseParams(), ImageHandler::normaliseParams(), JpegHandler::normaliseParams(), SvgHandler::normaliseParams(), TransformationalImageHandler::normaliseParams(), ApiQueryDuplicateFiles::run(), ParserTest::setupDatabase(), ResourceLoaderImageTest::testGetExtension(), ResourceLoaderImageTest::testGetImageData(), ResourceLoaderImageTest::testGetPath(), ResourceLoaderImageTest::testMassageSvgPathdata(), BitmapHandler::transformGd(), BitmapHandler::transformImageMagick(), ExifBitmapHandler::transformImageMagick(), BitmapHandler::transformImageMagickExt(), and RandomImageGenerator::writeImageWithApi().

◆ $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 before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled $incrBy

Definition at line 2400 of file hooks.txt.

Referenced by User::pingLimiter().

◆ $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 192 of file hooks.txt.

◆ $limit

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace 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 inclusive $limit

Definition at line 1080 of file hooks.txt.

◆ $link

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

Definition at line 2659 of file hooks.txt.

Referenced by LinksUpdate::__construct(), ImageGalleryBase::add(), OutputPage::addHelpLink(), OutputPage::addReturnTo(), Skin::addToSidebarPlain(), RCCacheEntryFactoryTest::assertQueryLink(), SkinTemplate::buildContentNavigationUrls(), OutputPage::buildCssLinks(), OutputPage::buildCssLinksArray(), ProtectionForm::buildForm(), SpecialEditWatchlist::buildRemoveLine(), Article::confirmDelete(), DifferenceEngine::deletedIdMarker(), MovePageForm::doSubmit(), SpecialApiHelp::execute(), DumpLinks::execute(), SpecialNewpages::filterLinks(), StubUserLang::findVariantLink(), IuConverter::findVariantLink(), KkConverter::findVariantLink(), KuConverter::findVariantLink(), ShiConverter::findVariantLink(), SrConverter::findVariantLink(), Language::findVariantLink(), LanguageConverter::findVariantLink(), Linker::formatAutocomments(), ApiParse::formatCategoryLinks(), ApiParse::formatCss(), DateFormatter::formatDate(), ApiParse::formatLangLinks(), AncientPagesPage::formatResult(), MostcategoriesPage::formatResult(), MostinterwikisPage::formatResult(), MostlinkedPage::formatResult(), DeletedContribsPager::formatRevisionRow(), CategoryPager::formatRow(), ContribsPager::formatRow(), SpecialProtectedtitles::formatRow(), ImageListPager::formatValue(), CategoryViewer::generateLink(), Skin::getCategoryLinks(), CreditsAction::getContributors(), Skin::getCopyright(), SpecialUndelete::getFileComment(), SpecialUndelete::getFileLink(), SpecialUndelete::getFileUser(), LogEventsList::getFilterLinks(), BaseTemplate::getFooterLinks(), OutputPage::getHeadLinksArray(), ApiHelp::getHelpInternal(), OutputPage::getHtmlFromLoaderLinks(), EnhancedChangesList::getLineData(), RevDelArchivedFileItem::getLink(), RevDelFileItem::getLink(), ApiParamInfo::getModuleInfo(), SpecialUndelete::getPageLink(), WebInstaller::getPageListItem(), Block::getPermissionsError(), TablePager::getStartBody(), RevDelFileItem::getUserTools(), HistoryPager::historyLine(), ImagePage::imageDupes(), ImagePage::imageLinks(), ImageGalleryBase::insert(), SpecialWhatLinksHere::listItem(), Linker::makeCommentLink(), Linker::makeExternalLink(), Linker::makeHeadline(), DummyLinker::makeHeadline(), makeKnownLinkHolder(), BaseTemplate::makeListItem(), LogFormatter::makePageLink(), OutputPage::makeResourceLoaderLink(), ChangesList::maybeWatchedLink(), ImportStreamSource::newFromInterwiki(), ComposerPackageModifier::newMediaWikiLink(), Language::numLink(), ImagePage::openShowImage(), SpecialRecentChanges::optionsPanel(), SpecialSpecialpages::outputPageList(), LanguageConverter::parseCachedTable(), SkinTemplate::prepareQuickTemplate(), SpecialBlock::preText(), Preferences::profilePreferences(), MediaWikiPageLinkRenderer::renderHtmlLink(), renderImageGallery(), replaceInternalLinks2(), LinkHolderArray::replaceInterwiki(), Linker::revDeleteLink(), DifferenceEngine::revisionDeleteLink(), HistoryPager::revLink(), Linker::revUserLink(), Linker::revUserTools(), ComposerPackageModifier::setLinkAsProvides(), 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(), ApiMain::substituteResultWithError(), MediaWiki\Auth\AuthManagerTest::testAuthentication(), TraditionalImageGallery::toHTML(), SpecialUndelete::undelete(), and CreditsAction::userLink().

◆ $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 1851 of file hooks.txt.

Referenced by LinksUpdate::__construct(), and LinksUpdate::doUpdate().

◆ $localize

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

Definition at line 2332 of file hooks.txt.

◆ $mimeMagic

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 or wrap existing services the preferred way to define a new service is the $wgServiceWiringFiles array change it to the message you want to define you are encouraged to submit patches to MediaWiki s core to add new MIME types to mime types $mimeMagic

static

Definition at line 2063 of file hooks.txt.

Referenced by File::checkExtensionCompatibility().

◆ $modeName

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers $modeName

Definition at line 1059 of file hooks.txt.

◆ $name

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist $name

inline

Definition at line 295 of file hooks.txt.

◆ $namespaces

namespace and then decline to actually register it& $namespaces

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

Definition at line 916 of file hooks.txt.

Referenced by ApiQuerySiteinfo::appendNamespaceAliases(), PrefixSearch::defaultSearchBackend(), FixDefaultJsonContentPages::doDBUpdates(), SpecialAllPages::execute(), SpecialPrefixindex::execute(), ApiOpenSearch::execute(), MWNamespace::getCanonicalNamespaces(), User::getDefaultOptions(), MediaWikiTestCase::getDefaultWikitextNS(), ApiHelp::getHelpInternal(), Languages::getProblematicProjectTalks(), PrefixSearch::handleResultFromHook(), Title::inNamespaces(), SearchEngine::namespacesAsText(), SearchEngineConfig::namespacesAsText(), SearchEngine::normalizeNamespaces(), SearchExactMatchRescorer::rescore(), ApiQueryDuplicateFiles::run(), ApiQueryPrefixSearch::run(), ApiQueryAllDeletedRevisions::run(), ApiOpenSearch::search(), PrefixSearch::search(), PrefixSearch::searchBackend(), PrefixSearchTest::searchProvision(), SearchEnginePrefixTest::searchProvision(), PrefixSearch::searchWithVariants(), SearchEngine::setNamespaces(), Language::setNamespaces(), BackupReader::setNsfilter(), SpecialAllPages::showChunk(), SpecialPrefixindex::showPrefixChunk(), ImportTest::testSiteInfoContainsNamespaces(), PrefixSearch::titleSearch(), and PrefixSearch::validateNamespaces().

◆ $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 1541 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 1042 of file hooks.txt.

Referenced by ZipDirectoryReader::__construct(), XmlTypeCheck::__construct(), MappedIterator::__construct(), RecompressTracked::__construct(), Block::__construct(), SquidPurgeClientPool::__construct(), MediaWiki\Session\SessionManager::__construct(), ParserTest::__construct(), RandomImageGenerator::__construct(), ResourceLoaderTestModule::__construct(), ResourceLoaderImageModule::__construct(), ResourceLoaderFileModule::__construct(), MWHttpRequest::__construct(), RedisConnectionPool::__construct(), MultiHttpClient::__construct(), CheckLanguageCLI::__construct(), CheckExtensionsCLI::__construct(), UploadForm::__construct(), ResourceLoaderWikiModule::__construct(), ContribsPager::__construct(), PathRouter::add(), OutputPage::addReturnTo(), PathRouter::addStrict(), OutputPage::addStyle(), User::addToDatabase(), RedisConnectionPool::applyDefaultConfig(), OutputPage::buildCssLinksArray(), IndexPager::buildQueryInfo(), NamespaceConflictChecker::checkAll(), ApiStashEdit::checkCache(), NamespaceConflictChecker::checkLinkTable(), NamespaceConflictChecker::checkNamespace(), NamespaceConflictChecker::checkPrefix(), WebResponse::clearCookie(), LBFactory::commitMasterChanges(), Title::countAuthorsBetween(), WatchedItemStore::countWatchersMultiple(), SpecialWatchlist::cutoffselector(), Block::defaultRetroactiveAutoblock(), LocalRepo::deletedFileHasKey(), PathRouter::doAdd(), SiteStatsInit::doAllAndCommit(), Article::doEditUpdates(), WikiPage::doEditUpdates(), UserCache::doQuery(), MockOggHandler::doTransform(), Skin::editUrlOptions(), FormatJson::encode(), Sanitizer::escapeId(), Sanitizer::escapeIdReferenceList(), DatabaseBase::estimateRowCount(), DatabaseMssql::estimateRowCount(), DatabaseMysqlBase::estimateRowCount(), DatabasePostgres::estimateRowCount(), SpecialApiHelp::execute(), DeletedContributionsPage::execute(), SpecialExpandTemplates::execute(), ApiExpandTemplates::execute(), PhpHttpRequest::execute(), CommandLineInc::execute(), NamespaceConflictChecker::execute(), PPFuzzTest::execute(), RefreshImageMetadata::execute(), UpdateCollation::execute(), GenerateRandomImages::execute(), ResourceLoaderFileModule::extractBasePaths(), ResourceLoaderImageModule::extractLocalBasePath(), MWHttpRequest::factory(), MWHttpRequestTester::factory(), fetchFile(), fetchFileAndTitle(), fetchFileNoRegister(), QueryPage::fetchFromCache(), Revision::fetchFromConds(), TextContent::fillParserOutput(), WikitextContent::fillParserOutput(), ResourceLoader::filter(), HTMLMultiSelectField::filterDataForSubmit(), FileRepo::findFile(), RepoGroup::findFile(), RepoGroup::findFileFromKey(), FileRepo::findFileFromKey(), FileRepo::findFiles(), DatabaseSqlite::fixIgnore(), HTMLFormField::flattenOptions(), HTMLMultiSelectField::formatOptions(), HTMLRadioField::formatOptions(), DummyLinker::generateRollback(), Linker::generateRollback(), Skin::generateRollback(), Http::get(), NamespaceConflictChecker::getAlternateTitle(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::getAuthenticationRequests(), MediaWiki\Auth\AuthManager::getAuthenticationRequests(), MediaWiki\Auth\AuthManager::getAuthenticationRequestsInternal(), Title::getAuthorsBetween(), CategoryMembershipChangeJob::getCategoriesAtRev(), InstallerOverrides::getCliInstaller(), DBLockManager::getConnection(), WikiPage::getContributors(), DBAccessObjectUtils::getDBOptions(), ResourceLoaderFileModule::getDefinitionSummary(), MediaWiki\Auth\ConfirmLinkAuthenticationRequest::getFieldInfo(), SpecialPageLanguage::getFormFields(), ApiHelp::getHelp(), ApiHelp::getHelpInternal(), ResourceLoaderImageModule::getImages(), HTMLRadioField::getInputOOUI(), OutputPage::getKeyHeader(), DatabaseMysqlBase::getLagFromPtHeartbeat(), SpecialProtectedpages::getLevelMenu(), SpecialProtectedtitles::getLevelMenu(), Title::getLinksFrom(), Title::getLinksTo(), Category::getMembers(), MediaWiki\Widget\NamespaceInputWidget::getNamespaceDropdownOptions(), SpecialEditWatchlist::getNormalForm(), Preferences::getOptionFromUser(), User::getOptionKinds(), ApiOptionsTest::getOptionKinds(), User::getOptions(), SpecialChangeContentModel::getOptionsForTitle(), HTMLFormField::getOptionsOOUI(), AbstractContent::getParserOutput(), BotPassword::getPassword(), Parser::getPreloadText(), LogPager::getQueryInfo(), ContribsPager::getQueryInfo(), NewFilesPager::getQueryInfo(), NewPagesPager::getQueryInfo(), UsersPager::getQueryInfo(), ShortPagesPage::getQueryInfo(), ImageListPager::getQueryInfoReal(), ResourceLoaderWikiModule::getScript(), BaseTemplate::getSidebar(), ResourceLoaderUserCSSPrefsModule::getStyles(), ResourceLoaderWikiModule::getStyles(), Title::getSubpages(), MysqlInstaller::getTableOptions(), NamespaceConflictChecker::getTargetList(), Title::getTemplateLinksFrom(), Title::getTemplateLinksTo(), ResourceLoaderImageTest::getTestImage(), ImageHistoryList::getThumbForLine(), ResourceLoaderWikiModule::getTitleInfo(), SpecialProtectedpages::getTypeMenu(), OutputPage::getVaryHeader(), MediaWiki\Session\SessionManager::getVaryHeaders(), WatchedItemStore::getWatchedItemsForUser(), DumpRenderer::handleRevision(), LocalRepo::hiddenFileHasKey(), ForeignAPIRepo::httpGet(), User::idForName(), DatabaseSqlite::indexUnique(), PasswordFactory::init(), DatabaseBase::insert(), DatabaseOracle::insert(), DatabaseSqlite::insert(), DatabasePostgres::insert(), DatabaseMssql::insert(), Language::internalUserTimeAndDate(), Xml::languageSelector(), DummyLinker::link(), Linker::link(), Skin::link(), Linker::linkAttribs(), DummyLinker::linkKnown(), Linker::linkKnown(), Skin::linkKnown(), Linker::linkUrl(), Xml::listDropDown(), PageArchive::listRevisions(), User::loadFromDatabase(), ResourceLoaderImageModule::loadFromDefinition(), Maintenance::loadWithArgv(), LocalIdLookup::lookupCentralIds(), HTMLFormField::lookupOptionsKeys(), LocalIdLookup::lookupUserNames(), DummyLinker::makeCommentLink(), Linker::makeCommentLink(), DatabaseBase::makeGroupByWithHaving(), makeImage(), DatabaseBase::makeInsertOptions(), DatabaseSqlite::makeInsertOptions(), BaseTemplate::makeLink(), BaseTemplate::makeListItem(), SpecialRecentChanges::makeOptionsLink(), DatabaseBase::makeOrderBy(), ContentHandler::makeParserOptions(), WikiPage::makeParserOptions(), DatabaseBase::makeSelectOptions(), DatabaseMssql::makeSelectOptions(), DatabaseOracle::makeSelectOptions(), DatabasePostgres::makeSelectOptions(), DatabaseSqlite::makeSelectOptions(), DatabaseBase::makeUpdateOptions(), DatabaseBase::makeUpdateOptionsArray(), DatabaseSqlite::makeUpdateOptionsArray(), MediaWiki\Auth\AuthenticationRequest::mergeFieldInfo(), ApiMain::modifyHelp(), Xml::monthSelector(), Html::namespaceSelector(), Html::namespaceSelectorOptions(), BotPassword::newFromCentralId(), RecompressTracked::newFromCommandLine(), User::newSystemUser(), ImagePage::openShowImage(), SpecialRecentChanges::optionsPanel(), WikiPage::pageData(), Article::pageDataFromId(), WikiPage::pageDataFromId(), Article::pageDataFromTitle(), WikiPage::pageDataFromTitle(), InfoAction::pageInfo(), Parser::parse(), FormatJson::parse(), OutputPage::parserOptions(), MediaWiki\Session\CookieSessionProvider::persistSession(), MediaWiki\Session\ImmutableSessionProviderWithCookie::persistSession(), Http::post(), MediaWiki::preOutputCommit(), Parser::preprocess(), preSaveTransform(), BackupDumper::processOptions(), Preferences::profilePreferences(), FileRepo::publish(), LocalFile::publish(), FileRepo::publishBatch(), LocalFile::publishTo(), ForeignAPIFile::purgeCache(), LocalFile::purgeCache(), ForeignAPIFile::purgeThumbnails(), LocalFile::purgeThumbnails(), BacklinkCache::queryLinks(), UserCache::queryNeeded(), FileRepo::quickImport(), ZipDirectoryReader::read(), QueryPage::reallyDoQuery(), ImageListPager::reallyDoQuery(), IndexPager::reallyDoQuery(), ContribsPager::reallyDoQuery(), UploadFromUrl::reallyFetchFile(), DateFormatter::reformat(), renderImageGallery(), LinkHolderArray::replaceInterwiki(), Http::request(), JobRunner::run(), TableCleanup::runTable(), ParserTest::runTest(), DatabaseBase::select(), DatabaseMssql::select(), DatabaseBase::selectField(), DatabaseBase::selectFieldValues(), DatabaseBase::selectRow(), DatabaseOracle::selectRow(), DatabaseBase::selectRowCount(), DatabaseBase::selectSQLText(), DatabaseMssql::selectSQLText(), DatabasePostgres::selectSQLText(), UserMailer::send(), RedisPubSubFeedEngine::send(), UserMailer::sendInternal(), WebResponse::setCookie(), FauxResponse::setCookie(), Maintenance::setParam(), Article::setParserOptions(), DatabaseMysqlBase::setSessionOptions(), ParserTest::setupRecorder(), SpecialWatchlist::showHideCheck(), LoginHelper::showReturnToPage(), RedisConnectionPool::singleton(), startExternalParse(), startParse(), SevenZipStream::stream_open(), OutputPage::styleLink(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest::testGetAuthenticationRequests(), MediaWiki\Logger\Monolog\KafkaHandlerTest::testGetAvailablePartitionsException(), SkinTemplateTest::testMakeListItem(), MediaWiki\Auth\AuthenticationRequestTest::testMergeFieldInfo(), NewParserTest::testParserTest(), TextContentTest::testPreloadTransform(), testPreprocess(), TextContentTest::testPreSaveTransform(), testPst(), MediaWiki\Logger\Monolog\KafkaHandlerTest::testSendException(), testSrvus(), MediaWiki\Logger\Monolog\KafkaHandlerTest::testTopicNaming(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider::testUserExists(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::testUserExists(), GlobalTest::testWfShellWikiCmd(), DummyLinker::titleAttrib(), Linker::titleAttrib(), ThumbnailImage::toHtml(), TraditionalImageGallery::toHTML(), DummyLinker::tooltip(), Linker::tooltip(), transformMsg(), DatabaseBase::update(), DatabaseMssql::update(), DatabaseOracle::update(), LocalFile::upload(), Language::userDate(), Language::userTime(), Language::userTimeAndDate(), wfFindFile(), wfShellExec(), and wfShellWikiCmd().

◆ $out

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out

Definition at line 845 of file hooks.txt.

◆ $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 1048 of file hooks.txt.

Referenced by Maintenance::activateProfiler(), LanguageConverter::autoConvert(), ProtectionForm::buildForm(), WikiExporter::closeStream(), StringUtils::delimiterReplaceCallback(), UploadBase::detectVirus(), LinkHolderArray::doVariants(), SpecialContributions::execute(), SpecialEditTags::execute(), SpecialRevisionDelete::execute(), SpecialExpandTemplates::execute(), SpecialWatchlist::execute(), ApiParse::execute(), SpecialPageExecutor::executeSpecialPage(), JsonContent::fillParserOutput(), TextContent::fillParserOutput(), WikitextContent::fillParserOutput(), DummyContentForTesting::fillParserOutput(), DummyNonTextContent::fillParserOutput(), MediaWiki\Logger\Monolog\LineFormatter::format(), AutoloadGenerator::generatePHPAutoload(), CategoryMembershipChangeJob::getCategoriesAtRev(), CheckSyntax::getGitModifiedFiles(), SpecialPageExecutor::getHTMLFromSpecialPage(), WebInstallerLanguage::getLanguageSelector(), EditPage::getPreviewLimitReport(), MWTimestamp::getTimestamp(), DumpRenderer::handleRevision(), MWCryptHKDF::HKDFExpand(), StringUtils::hungryDelimiterReplace(), Profiler::logData(), Profiler::logDataPageOutputOnly(), MediaWiki::main(), SpecialExpandTemplates::makeOutput(), Maintenance::maybeHelp(), mccGetHelp(), ImagePage::openShowImage(), WikiExporter::openStream(), SpecialWatchlist::outputChangesList(), WikiExporter::outputLogStream(), WikiExporter::outputPageStream(), MediaWiki::performAction(), MediaWiki::performRequest(), DatabasePostgres::pg_array_parse(), ParserTest::quickDiff(), SectionProfiler::remapCallTree(), LinkHolderArray::replaceInternal(), LinkHolderArray::replaceInterwiki(), UserNotLoggedIn::report(), ParserTest::runTest(), SpecialAllPages::showChunk(), UserrightsPage::showLogFragment(), SpecialPrefixindex::showPrefixChunk(), SpecialEditWatchlist::showTitles(), ExifBitmapHandler::swapICCProfile(), WfShellExecTest::testBug67870(), ArrayDiffFormatterTest::testFormat(), WfTimestampTest::testHttpDate(), WfTimestampTest::testNormalTimestamps(), WfTimestampTest::testOldTimestamps(), NewParserTest::testParserTest(), JpegPixelFormatTest::testPixelFormatRendering(), PreprocessorTest::testPreprocessorOutputFiles(), SanitizerTest::testRemoveHTMLtags(), FormatMetadataTest::testResolveMultivalueValue(), ApiResultTest::testTransformations(), WfAssembleUrlTest::testWfAssembleUrl(), WfShorthandToIntegerTest::testWfShorthandToInteger(), TraditionalImageGallery::toHTML(), MediaWiki::tryNormaliseRedirect(), wfArrayInsertAfter(), wfRemoveDotSegments(), and GenerateJqueryMsgData::writeJavascriptFile().

◆ $page

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 before the output is cached $page

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

Definition at line 2372 of file hooks.txt.

◆ $parser

function wfGetCustomMagicWordValue $parser

Initial value:

{

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

$parser

do that in ParserLimitReportFormat instead $parser

Definition hooks.txt:2341

Definition at line 2338 of file hooks.txt.

◆ $parserOutput

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context $parserOutput

Definition at line 1034 of file hooks.txt.

Referenced by LinksUpdate::__construct(), OutputPage::addParserOutput(), OutputPage::addParserOutputContent(), OutputPage::addParserOutputMetadata(), OutputPage::addParserOutputNoText(), OutputPage::addParserOutputText(), OutputPage::addWikiTextTitle(), LinksUpdateTest::assertLinksUpdate(), ApiStashEdit::buildStashValue(), WikiPage::getParserOutput(), DifferenceEngine::getParserOutput(), EditPage::getPreviewText(), AbstractContent::getSecondaryDataUpdates(), OutputPage::parse(), DifferenceEngine::renderNewRevision(), RefreshLinksJob::runForTitle(), ParserCache::save(), JsonContentTest::testFillParserOutput(), TagHookTest::testFunctionTagHooks(), ExtraParserTest::testParse(), TagHookTest::testTagHooks(), ExtraParserTest::testTrackingCategory(), ExtraParserTest::testTrackingCategorySpecial(), Article::triggerOpportunisticLinksUpdate(), and WikiPage::triggerOpportunisticLinksUpdate().

◆ $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 before the output is cached one of or reset my talk my contributions etc& $personal_urls

Definition at line 2389 of file hooks.txt.

Referenced by SkinTemplate::buildPersonalUrls().

◆ $pre

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges 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 1415 of file hooks.txt.

Referenced by Linker::formatAutocomments(), DbTestPreviewer::getTestStatusInfo(), SearchHighlighter::highlightSimple(), and ExtensionProcessorTest::testRegisterHooks().

◆ $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 1447 of file hooks.txt.

◆ $refreshCache

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next $refreshCache

Definition at line 1459 of file hooks.txt.

Referenced by DifferenceEngine::__construct(), and ContentHandler::createDifferenceEngine().

◆ $req

this hook is for auditing only $req

Definition at line 945 of file hooks.txt.

◆ $request

error also a ContextSource you ll probably need to make sure the header is varied on $request

Definition at line 2506 of file hooks.txt.

◆ $requests

Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink () instead. &$feedLinks hooks can tweak the array to change how login etc forms should look $requests ( ) &

Definition at line 755 of file hooks.txt.

Referenced by AuthManagerSpecialPage::fieldInfoToFormDescriptor(), SpecialChangeCredentials::getAuthForm(), SpecialLinkAccounts::getAuthForm(), LoginSignupSpecialPage::getAuthForm(), AuthManagerSpecialPage::getAuthFormDescriptor(), SpecialChangeCredentials::getAuthFormDescriptor(), MediaWiki\Auth\AuthenticationRequest::getRequestByClass(), MediaWiki\Auth\ButtonAuthenticationRequest::getRequestByName(), AuthManagerSpecialPage::handleFormSubmit(), SpecialChangeCredentials::handleFormSubmit(), AuthManagerSpecialPage::isActionAllowed(), LoginSignupSpecialPage::mainLoginForm(), AuthManagerSpecialPage::needsSubmitButton(), SpecialChangeCredentials::onAuthChangeFormFields(), AuthManagerSpecialPage::performAuthenticationStep(), LoginSignupSpecialPage::postProcessFormDescriptor(), and MediaWiki\Session\SessionBackendTest::testSave().

◆ $res

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

Definition at line 933 of file hooks.txt.

◆ $resourceLoader

error also a ContextSource you ll probably need to make sure the header is varied on such as when responding to a resource loader request or generating HTML output& $resourceLoader

Definition at line 2533 of file hooks.txt.

Referenced by LessTestSuite::__construct(), OutputPage::buildCssLinks(), OutputPage::filterModules(), WebInstallerOutput::getCSS(), ResourceLoaderStartUpModule::getModuleRegistrations(), ResourceLoaderTestCase::getResourceLoaderContext(), DerivativeResourceLoaderContextTest::getResourceLoaderContext(), ResourceLoaderModule::getScriptURLsForDebug(), ResourceLoaderModule::getStyleURLsForDebug(), OutputPage::makeResourceLoaderLink(), ResourceLoaderTest::testCreatingNewResourceLoaderCallsRegistrationHook(), and ResourceLoaderTest::testRegisteredValidModulesAreAccessible().

◆ $ResourceLoader

For QUnit the mediawiki tests qunit testrunner dependency will be added to any module& $ResourceLoader

Definition at line 2546 of file hooks.txt.

◆ $response

this hook is for auditing only $response

Definition at line 764 of file hooks.txt.

◆ $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 1808 of file hooks.txt.

◆ $returnTo

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 before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect& $returnTo

Definition at line 2411 of file hooks.txt.

Referenced by SpecialChangeCredentials::getReturnUrl(), MarkpatrolledAction::onView(), LoginSignupSpecialPage::showReturnToPage(), and LoginHelper::showReturnToPage().

◆ $returnToQuery

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 before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string& $returnToQuery

Definition at line 2412 of file hooks.txt.

Referenced by SpecialChangeCredentials::getReturnUrl(), LoginSignupSpecialPage::showReturnToPage(), and LoginHelper::showReturnToPage().

◆ $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 local account incomplete not yet checked for validity& $retval

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

Definition at line 268 of file hooks.txt.

Referenced by ExternalStore::batchFetchFromURLs(), ExternalStoreMedium::batchFetchFromURLs(), PPTemplateFrame_DOM::cachedExpand(), PPTemplateFrame_Hash::cachedExpand(), MediaWikiTestCase::checkHasGzip(), MediaWiki\Tidy\RaggettExternal::cleanWrapped(), MediaWiki\Tidy\RaggettInternalHHVM::cleanWrapped(), MediaWiki\Tidy\RaggettInternalPHP::cleanWrapped(), HTMLForm::displaySection(), DjVuHandler::doTransform(), ApiBlock::execute(), ApiEmailUser::execute(), ApiExpandTemplates::execute(), ApiPatrol::execute(), ApiRollback::execute(), ApiUnblock::execute(), ApiUndelete::execute(), NamespaceConflictChecker::execute(), ResourceLoaderContext::expandModuleNames(), ArrayDiffFormatter::format(), ApiQueryBacklinks::getAllowedParams(), Interwiki::getAllPrefixesDB(), CheckSyntax::getGitModifiedFiles(), FindHooks::getHooksFromOnlineDocCategory(), TransformationalImageHandler::getMagickVersion(), LinkSearchPage::getQueryInfo(), UnusedimagesPage::getQueryInfo(), ApiQueryUserInfo::getRateLimits(), SiteConfiguration::getSetting(), WikiPage::insertRedirect(), MediaHandler::logErrorForExternalProcess(), ApiMove::moveSubpages(), Title::moveSubpages(), RecentChange::parseToRCType(), ApiQueryImageInfo::processMetaData(), WfExpandUrlTest::provideExpandableUrls(), SvgHandler::rasterize(), Maintenance::readlineEmulation(), DoubleRedirectsPage::reallyGetQueryInfo(), ApiFormatXml::recXmlPrint(), MediaHandler::removeBadFile(), DjVuImage::retrieveMetaData(), BitmapHandler::rotate(), JpegHandler::rotate(), Hooks::run(), EmailConfirmation::showRequestForm(), ExifBitmapHandler::swapICCProfile(), MediaWiki\Session\SessionTest::testMethods(), JpegPixelFormatTest::testPixelFormatRendering(), BitmapHandler::transformCustom(), BitmapHandler::transformImageMagick(), MediaWiki\Tidy\RaggettBase::validate(), wfShellExec(), wfShellExecWithStderr(), wfUrlProtocols(), 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 1595 of file hooks.txt.

◆ $revert

this hook is for auditing only etc instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters create2 Corresponds to logging log_action database field and which is displayed in the UI& $revert

Definition at line 1977 of file hooks.txt.

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

◆ $revId

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context $revId

◆ $section

usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section

Definition at line 2727 of file hooks.txt.

Referenced by HTMLForm::__construct(), JobQueueFederated::__construct(), SectionProfiler::__construct(), HTMLForm::addFooterText(), CategoryViewer::addFragmentToTitle(), HTMLForm::addHeaderText(), ParserOutput::addHeadItem(), SkinTemplate::buildContentNavigationUrls(), HTMLForm::displaySection(), Skin::doEditSectionLink(), IndexPager::doQuery(), ApiEditPage::execute(), Linker::formatAutocomments(), DummyLinker::formatTemplates(), Linker::formatTemplates(), Linker::generateTOC(), HTMLForm::getFooterText(), HTMLForm::getHeaderText(), OOUIHTMLForm::getHeaderText(), LBFactoryMulti::getMainLB(), RawAction::getRawText(), LBFactoryMulti::getSectionForWiki(), Exif::makeFilteredData(), LBFactoryMulti::newMainLB(), Sanitizer::normalizeSectionNameWhitespace(), WebInstallerOutput::outputFooter(), EditPageTest::provideAutoMerge(), ParserTest::runTest(), ProfilerSectionOnly::scopedProfileIn(), ProfilerXhprof::scopedProfileIn(), SectionProfiler::scopedProfileIn(), SectionProfiler::scopedProfileOut(), Profiler::scopedProfileOut(), HTMLForm::setFooterText(), HTMLForm::setHeaderText(), SpecialSearch::showHit(), EditPageTest::testExtractSectionTitle(), NewParserTest::testParserTest(), EditPageTest::testSectionEdit(), Exif::validate(), HTMLForm::wrapFieldSetSection(), and OOUIHTMLForm::wrapFieldSetSection().

◆ $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 2355 of file hooks.txt.

Referenced by Article::replaceSectionAtRev(), WikiPage::replaceSectionAtRev(), Article::replaceSectionContent(), and WikiPage::replaceSectionContent().

◆ $services

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 or wrap existing services the preferred way to define a new service is the $wgServiceWiringFiles array $services

static

Definition at line 2028 of file hooks.txt.

◆ $siteNotice

the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set for highlighting or change the value of $siteNotice and return false to alter it& $siteNotice

Definition at line 2694 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 1814 of file hooks.txt.

Referenced by LogPage::actionText(), ApiQuerySiteinfo::appendSkins(), SkinFallbackTemplate::buildHelpfulInformationMessage(), WebInstallerOptions::execute(), ResourceLoaderImageModule::getGlobalVariants(), ResourceLoaderImageModule::getImages(), ParserOutput::getText(), ResourceLoaderImageModule::loadFromDefinition(), ResourceLoaderOOUIImageModule::loadFromDefinition(), SkinFactory::makeSkin(), QueryPage::outputResults(), ResourceLoader::preloadModuleInfo(), WebInstallerOptions::submit(), SkinFactoryTest::testMakeSkinWithValidCallback(), and wfLoadSkins().

◆ $special

this hook is for auditing only RecentChangesLinked and Watchlist $special

Definition at line 970 of file hooks.txt.

Referenced by SpecialPageAction::doesWrites(), UpdateSpecialPages::doSpecialPageCacheUpdates(), UpdateSpecialPages::execute(), BaseTemplate::getToolbox(), RevisiondeleteAction::show(), SpecialPageAction::show(), SpecialProtectedtitles::showOptions(), PrefixSearch::specialSearch(), SpecialPreferencesTest::testBug41337(), SpecialMyLanguageTest::testFindTitle(), and MediaWiki::triggerJobs().

◆ $status

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status = Status::newGood()` to allow deletion

Definition at line 1007 of file hooks.txt.

◆ $suppressed

returning false will NOT prevent logging a wrapping ErrorException $suppressed

Definition at line 1941 of file hooks.txt.

Referenced by MWExceptionHandler::logError(), and DifferenceEngine::showDiffPage().

◆ $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 1252 of file hooks.txt.

Referenced by EditPage::getCheckboxes(), EditPage::getEditButtons(), Xml::listDropDown(), and EditPage::showStandardInputs().

◆ $tables

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist& $tables

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

Definition at line 979 of file hooks.txt.

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

◆ $tag

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions $tag

Definition at line 989 of file hooks.txt.

Referenced by SqlBagOStuff::__construct(), ChangeTags::activateTagWithChecks(), ApiResult::addArrayType(), ApiResult::addArrayTypeRecursive(), ParserOutput::addHeadItem(), ApiResult::addIndexedTagName(), ApiResult::addIndexedTagNameRecursive(), ApiErrorFormatter::addMessagesFromStatus(), ApiErrorFormatter::addWarningOrError(), ApiErrorFormatter_BackCompat::addWarningOrError(), SpecialEditTags::buildCheckBoxes(), ChangeTags::canActivateTag(), ChangeTags::canCreateTag(), ChangeTags::canDeactivateTag(), ChangeTags::canDeleteTag(), ChangeTags::createTagWithChecks(), ChangeTags::deactivateTagWithChecks(), ChangeTags::defineTag(), ChangeTags::deleteTagEverywhere(), ChangeTags::deleteTagWithChecks(), UploadBase::detectScript(), XMPReader::doAttribs(), WikiImporter::doImport(), SpecialTags::doTagRow(), XMPReader::endElementModeLi(), XMPReader::endElementModeQDesc(), XMPReader::endElementModeSimple(), XMPReader::endElementNested(), ApiQueryTags::execute(), ApiParse::formatHeadItems(), SvgHandler::formatMetadata(), MediaHandler::formatMetadataHelper(), ChangeTags::formatSummaryRow(), IPTC::getCharset(), SvgHandler::getCommonMetaArray(), RedisBagOStuff::getConnection(), OutputPage::getHeadLinksArray(), ApiHelp::getHelpInternal(), ApiParamInfo::getModuleInfo(), ParserTest::getParser(), SiteConfiguration::getSetting(), WikiImporter::handleContributor(), WikiImporter::handleLogItem(), WikiImporter::handlePage(), WikiImporter::handleRevision(), WikiImporter::handleSiteInfo(), WikiImporter::handleUpload(), Html::htmlHeader(), ManualLogEntry::insert(), Language::isKnownLanguageTag(), HTMLCheckMatrix::isTagForcedOff(), HTMLCheckMatrix::isTagForcedOn(), ChangeTags::logTagManagementAction(), Exif::makeFilteredData(), FormatMetadata::makeFormattedData(), IPTC::parse(), SpecialTags::processCreateTagForm(), SpecialTags::processTagForm(), SVGReader::read(), replaceTransparentTags(), Linker::revDeleteLink(), IEContentAnalyzer::sampleData(), XMPReader::saveValue(), OutputPage::setETag(), setFunctionTagHook(), setHook(), ApiResult::setIndexedTagName(), ApiResult::setIndexedTagName_internal(), ApiResult::setIndexedTagName_recursive(), ApiResult::setIndexedTagNameRecursive(), setTransparentTagHook(), SpecialTags::showActivateDeactivateForm(), ChangesList::showCharacterDifference(), SpecialTags::showDeleteTagForm(), SpecialTags::showTagList(), XMPReader::startElement(), XMPReader::startElementModeInitial(), XMPReader::startElementModeSimple(), XMPReader::startElementModeStruct(), ChangeTags::tagDescription(), TagHookTest::testBadFunctionTagHooks(), TagHookTest::testBadTagHooks(), ApiDocumentationTest::testDocumentationExists(), TagHookTest::testFunctionTagHooks(), TagHookTest::testTagHooks(), Language::truncate_endBracket(), Language::truncateHtml(), ChangeTags::undefineTag(), ChangeTags::updateTags(), Exif::validate(), ApiHelp::wrap(), and Xml::wrapClass().

◆ $template

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping $template

◆ $term

external whereas SearchGetNearMatch runs after $term

Definition at line 2563 of file hooks.txt.

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

◆ $time

this hook is for auditing only etc instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment $time

Definition at line 1615 of file hooks.txt.

Referenced by OldLocalFile::__construct(), MediaWikiPHPUnitTestListener::addError(), MediaWikiPHPUnitTestListener::addFailure(), MediaWikiPHPUnitTestListener::addIncompleteTest(), MediaWikiPHPUnitTestListener::addSkippedTest(), ApiFormatBase::closePrinter(), LBFactory::commitMasterChanges(), JobQueueAggregatorRedis::doGetAllReadyWikiQueues(), DBFileJournal::doGetPositionAtTime(), FileBackendTest::doTestGetFileStat(), PoolWorkArticleView::doWork(), MediaWikiPHPUnitTestListener::endTest(), BenchmarkHooks::execute(), SyncFileBackend::execute(), fetchFileAndTitle(), FileRepo::findFile(), RepoGroup::findFile(), FileRepo::findFileFromKey(), MediaWiki\Logger\LegacyLogger::formatAsWfDebugLog(), FileDuplicateSearchPage::formatResult(), MIMEsearchPage::formatResult(), SpecialNewpages::formatRow(), NewFilesPager::formatRow(), DifferenceEngine::generateTextDiffBody(), WANObjectCache::getCheckKeyTime(), ProtectionForm::getExpiry(), SpecialUndelete::getFileLink(), User::getFirstEditTimestamp(), Language::getHumanTimestamp(), DatabaseMysqlBase::getLagFromPtHeartbeat(), SpecialUndelete::getPageLink(), FileJournal::getPositionAtTime(), SectionProfiler::getTime(), UIDGenerator::getTimeAndDelay(), UIDGenerator::getTimestampedID128(), UIDGenerator::getTimestampedID88(), UIDGenerator::intervalsSinceGregorianBinary(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::isTimestampValid(), SpecialUndelete::loadRequest(), LogEventsList::logLine(), ApiMain::logRequest(), DummyLinker::makeBrokenImageLinkObj(), Linker::makeBrokenImageLinkObj(), FormatMetadata::makeFormattedData(), makeImage(), DummyLinker::makeImageLink(), Linker::makeImageLink(), DummyLinker::makeMediaLinkObj(), Linker::makeMediaLinkObj(), DummyLinker::makeThumbLink2(), Linker::makeThumbLink2(), UIDGenerator::millisecondsSinceEpochBinary(), FileRepo::newFile(), ForeignAPIRepo::newFile(), OldLocalFile::newFromTitle(), User::newTouchedTimestamp(), IPTC::parse(), Preferences::profilePreferences(), ZipDirectoryReader::readCentralDirectory(), EmailConfirmation::showRequestForm(), SpecialUndelete::showRevision(), MediaWiki\Session\CookieSessionProviderTest::testCookieData(), MediaWiki\Session\ImmutableSessionProviderWithCookieTest::testPersistSession(), MediaWiki\Session\CookieSessionProviderTest::testPersistSession(), WatchedItemStoreUnitTest::testResetNotificationTimestamp_futureNotificationTimestampForced(), WatchedItemStoreUnitTest::testResetNotificationTimestamp_futureNotificationTimestampNotForced(), WatchedItemStoreUnitTest::testResetNotificationTimestamp_notWatchedPageForced(), WatchedItemStoreUnitTest::testResetNotificationTimestamp_oldidSpecifiedLatestRevisionForced(), WatchedItemStoreUnitTest::testResetNotificationTimestamp_oldidSpecifiedNotLatestRevisionForced(), IPTC::timeHelper(), UIDGenerator::timeWaitUntil(), Language::translateBlockExpiry(), and wfShellExec().

◆ $title

do that in ParserLimitReportFormat instead use this to modify the parameters of the image $title

Definition at line 938 of file hooks.txt.

◆ $type

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 before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values& $type

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

Definition at line 2413 of file hooks.txt.

Referenced by PoolCounterRedis::__construct(), Installer::__construct(), RedisLockManager::__destruct(), JobQueueGroup::__destruct(), FormOptions::add(), DeferredUpdates::addCallableUpdate(), OutputPage::addCategoryLinks(), SpecialLog::addHeader(), FakeAuthTemplate::addInputItem(), StripState::addItem(), BackupDumperLoggerTest::addLogEntry(), ApiQueryLogEvents::addLogParams(), BitmapMetadataHandler::addMetadata(), PostgresUpdater::addPgExtIndex(), DeferredUpdates::addUpdate(), SiteStatsUpdate::adjustPending(), ApiQuerySiteinfo::appendExtensions(), ApiQuerySiteinfo::appendUserGroups(), ApiResult::applyTransformations(), ApiErrorFormatter::arrayFromStatus(), ApiErrorFormatter_BackCompat::arrayFromStatus(), XhprofTest::assertArrayStructure(), LogFormatterTest::assertIRCComment(), BackupDumperLoggerTest::assertLogItem(), MediaWikiTestCase::assertType(), SiteTest::assertTypeOrFalse(), MediaWikiTestCase::assertTypeOrValue(), SpecialBlock::blockLogFlags(), RCCacheEntryFactory::buildCLink(), RCCacheEntryFactory::buildLastLink(), FeedUtils::checkFeedOutput(), UploadBase::checkSvgExternalDTD(), HTMLFileCache::clearFileCache(), CategoryPage::closeShowCategory(), StreamFile::contentTypeFromPath(), WikiPage::convertSelectType(), SearchEngine::create(), SearchEngineFactory::create(), UploadBase::createFromRequest(), CategoryMembershipChange::createRecentChangesEntry(), LayeredParameterizedPassword::crypt(), MediaWikiMediaTestCase::dataFile(), Exif::debug(), LCStoreStaticArray::decode(), JobQueueAggregatorRedis::decodeQueueName(), CategoryViewer::doCategoryQuery(), MemcLockManager::doFreeLocksOnServer(), JobQueueAggregatorRedis::doGetAllReadyWikiQueues(), MySqlLockManager::doGetLocksOnServer(), PostgreSqlLockManager::doGetLocksOnServer(), MemcLockManager::doGetLocksOnServer(), WikiImporter::doImport(), FSLockManager::doLock(), QuorumLockManager::doLock(), LockManager::doLockByType(), QuorumLockManager::doLockByType(), FSLockManager::doSingleLock(), FSLockManager::doSingleUnlock(), FSLockManager::doUnlock(), QuorumLockManager::doUnlock(), LockManager::doUnlockByType(), QuorumLockManager::doUnlockByType(), SearchUpdate::doUpdate(), SiteStatsUpdate::doUpdateContextStats(), DeferredUpdates::doUpdates(), Html::dropDefaults(), CSSMin::encodeImageAsDataURI(), CSSMin::encodeStringAsDataURI(), CheckStorage::error(), SpecialLog::execute(), SpecialProtectedpages::execute(), SpecialProtectedtitles::execute(), ApiQueryBlocks::execute(), ApiQueryLogEvents::execute(), ApiQueryTokens::execute(), ApiTokens::execute(), WebInstallerDBConnect::execute(), WebInstallerUpgrade::execute(), UploadStashCleanup::execute(), ConvertExtensionToRegistration::execute(), ConvertLinks::execute(), CopyJobQueue::execute(), Protect::execute(), PurgeChangedFiles::execute(), RunJobs::execute(), ShowJobs::execute(), CompressOld::execute(), UpdateCollation::execute(), SiteExporter::exportSite(), LogFormatter::extractParameters(), ApiQueryRecentChanges::extractRowInfo(), ApiQueryWatchlist::extractRowInfo(), PoolCounter::factory(), ScopedLock::factory(), ApiTestCaseUpload::fakeUploadChunk(), ApiTestCaseUpload::fakeUploadFile(), HistoryAction::feed(), SpecialNewpages::feed(), FormOptions::fetchValuesFromRequest(), OutputPage::filterModules(), JobQueueAggregator::findPendingWikiQueues(), FormatMetadata::flattenArrayContentLang(), FormatMetadata::flattenArrayReal(), FormatMetadata::formatCoords(), LogFormatter::formatParameterValue(), LogFormatter::formatParameterValueForApi(), BlockListPager::formatValue(), MemcLockManager::freeLocksOnServer(), RedisLockManager::freeLocksOnServer(), CategoryViewer::generateLink(), JobQueueGroup::get(), LegacyLogFormatter::getActionLinks(), OutputPage::getAllowedModules(), SpecialBlockList::getBlockListPager(), CachingSiteStore::getCacheKey(), LinksUpdate::getCategoryInsertions(), CategoryMembershipChange::getChangeMessageText(), PPNode_DOM::getChildrenOfType(), JobQueueGroup::getCoalescedQueues(), Skin::getCopyright(), CategoryViewer::getCountMessage(), IEContentAnalyzer::getDataFormat(), ResourceLoaderImage::getDataUri(), Language::getDateFormatString(), SqlBagOStuff::getDB(), ForeignDBRepo::getDBFactory(), Installer::getDBInstaller(), LayeredParameterizedPassword::getDefaultParams(), StatusValue::getErrorsByType(), Status::getErrorsByType(), SpecialVersion::getExtensionCategory(), SpecialVersion::getExtensionCredits(), SpecialVersion::getExtensionTypeName(), LogEventsList::getFilterLinks(), SpecialWhatLinksHere::getFilterPanel(), LogPager::getFilterParams(), MediaHandler::getHandler(), OutputPage::getHeadLinksArray(), ApiHelp::getHelpInternal(), MWException::getHTML(), getImageParams(), HTMLTextField::getInputHTML(), HTMLTextField::getInputOOUI(), File::getIsSafeFileUncached(), OutputPage::getJSVars(), SpecialProtectedpages::getLevelMenu(), SpecialProtectedtitles::getLevelMenu(), MachineReadableRCFeedFormatter::getLine(), EnhancedChangesList::getLineData(), DBLockManager::getLocksOnServer(), MemcLockManager::getLocksOnServer(), RedisLockManager::getLocksOnServer(), MWExceptionHandler::getLogMessage(), LogFormatter::getMessageKey(), BitmapMetadataHandler::getMetadataArray(), IEContentAnalyzer::getMimeTypeForVersion(), ArrayDiffFormatterTest::getMockDiffOp(), TablePager::getNavigationBar(), ApiOpenSearch::getOpenSearchTemplate(), Skin::getPageClasses(), IndexPager::getPagingLinks(), ApiBase::getParameterFromSettings(), SiteStatsUpdate::getPendingDeltas(), PostgresInstaller::getPgConnection(), MWExceptionHandler::getPublicLogMessage(), JobQueueGroup::getQueueSizes(), JobQueueGroup::getQueuesWithJobs(), FileBackend::getScopedFileLocks(), CategoryViewer::getSectionPagingLinks(), Status::getStatusArray(), ZipDirectoryReader::getStructSize(), SpecialBlock::getTargetAndType(), HTMLTextField::getType(), SiteStatsUpdate::getTypeCacheKey(), SpecialProtectedpages::getTypeMenu(), LogEventsList::getTypeSelector(), ArchivedFile::getUser(), ForeignAPIFile::getUser(), LocalFile::getUser(), BitmapMetadataHandler::GIF(), FileBackendGroup::guessMimeInternal(), incrementIncludeSize(), PasswordFactory::init(), MediaWiki\Auth\AuthManagerTest::initializeConfig(), Message::inLanguage(), Html::input(), Language::internalUserTimeAndDate(), Title::isProtected(), Language::isValidBuiltInCode(), MIMEsearchPage::isValidType(), BitmapMetadataHandler::Jpeg(), SearchMySQL::legalSearchChars(), SearchOracle::legalSearchChars(), SearchSqlite::legalSearchChars(), LogPager::limitAction(), LogPager::limitType(), JobRunner::loadBackoffs(), Title::loadRestrictionsFromRows(), LockManager::lock(), FileBackend::lockFiles(), EnhancedChangesList::makeCacheGroupingKey(), FileBackend::makeContentDisposition(), FormatMetadata::makeFormattedData(), ApiBase::makeHelpMsgParameters(), makeImage(), IndexPager::makeLink(), ImagePage::makeMetadataTable(), SiteImporter::makeSite(), AuthManagerSpecialPage::mapFieldInfoTypeToFormDescriptorType(), AuthManagerSpecialPage::mapSingleFieldInfo(), StripState::merge(), mimeTypeMatch(), JavaScriptMinifier::minify(), MovePage::move(), DatabaseUpdater::newForDB(), PasswordFactory::newFromCiphertext(), ObjectFileCache::newFromKey(), PasswordFactory::newFromType(), RecentChange::newLogEntry(), LockManager::normalizePathsByType(), RecentChange::notifyLog(), JobQueueAggregator::notifyQueueEmpty(), JobQueueAggregator::notifyQueueNonEmpty(), SwiftFileBackend::objectListing(), SpecialChangeCredentials::onAuthChangeFormFields(), PostgresInstaller::openPgConnection(), CoreParserFunctions::pagesincategory(), CategoryViewer::pagingLinks(), SpecialUploadStash::parseKey(), RecentChange::parseToRCType(), JSMinPlus::parseTree(), LayeredParameterizedPassword::partialCrypt(), BitmapMetadataHandler::PNG(), JobQueueGroup::pop(), StreamFile::prepareForStream(), SpecialBlock::processForm(), ApiTag::processIndividual(), BackupDumper::processOptions(), CoreParserFunctions::protectionexpiry(), CoreParserFunctions::protectionlevel(), HtmlTest::provideHtml5InputTypes(), PurgeChangedFiles::purgeFromLogType(), JobQueueGroup::push(), UserCache::queryNeeded(), JobQueueGroup::queuesHaveJobs(), SVGReader::read(), EnhancedChangesList::recentChangesBlockLine(), OutputPage::reduceAllowedModules(), PasswordFactory::register(), SiteStatsUpdate::removePendingDeltas(), LinkHolderArray::replaceInternal(), Message::replaceParameters(), LinkHolderArray::replaceTextCallback(), ApiQueryCategoryMembers::run(), ApiQuerySearch::run(), ApiQueryBacklinksprop::run(), JobRunner::run(), User::sendConfirmationMail(), ApiResult::setArrayType(), ApiResult::setArrayTypeRecursive(), AjaxResponse::setContentType(), PasswordFactory::setDefaultType(), User::setEmailWithConfirmation(), OutputPage::setFeedAppendQuery(), NewParserTest::setUp(), PasswordTestCase::setUp(), SpecialProtectedpages::showOptions(), LoginSignupSpecialPage::showReturnToPage(), LoginHelper::showReturnToPage(), LoginSignupSpecialPage::showSuccessPage(), FileBackendDBRepoWrapper::streamFile(), WebInstallerDBConnect::submit(), JobRunner::syncBackoffDeltas(), MediaWikiTestCase::teardownTestDB(), MediaWiki\Auth\AuthManagerTest::testCanCreateAccounts(), MediaWiki\Auth\AuthManagerTest::testCanLinkAccounts(), XhprofTest::testCompleteMetricsStructure(), MediaWiki\Auth\AuthManagerTest::testGetAuthenticationRequests(), MediaWikiServicesTest::testGetService(), MediaWikiServicesTest::testGetters(), XhprofTest::testInclusiveMetricsStructure(), ExifRotationTest::testMetadata(), ExifRotationTest::testMetadataAutoRotate(), ExifRotationTest::testMetadataAutoRotateUnsupported(), ExifRotationTest::testMetadataNoAutoRotate(), MWMessagePackTest::testPack(), RecentChangeTest::testParseFromRCType(), RecentChangeTest::testParseToRCType(), MediaWiki\Auth\AbstractPrimaryAuthenticationProviderTest::testPrimaryAccountLink(), SiteTest::testProtocolRelativePath(), MediaWiki\Auth\AuthPluginPrimaryAuthenticationProviderTest::testProviderAllowsAuthenticationDataChange(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest::testProviderAllowsAuthenticationDataChange(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest::testProviderAllowsAuthenticationDataChange(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest::testProviderChangeAuthenticationData(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest::testProviderChangeAuthenticationData(), ExifRotationTest::testRotationRendering(), ExifRotationTest::testRotationRenderingNoAutoRotate(), IEContentAnalyzer::translateMimeType(), LogEventsList::typeAction(), LockManager::unlock(), FileBackend::unlockFiles(), ZipDirectoryReader::unpack(), StripState::unstripType(), LogEventsList::userCanViewLogType(), FormOptions::validateBounds(), SpecialBlock::validateTarget(), ApiResult::validateValue(), JobQueueGroup::waitForBackups(), wfGenericError(), wfMissingExtensions(), wfMissingVendorError(), wfNegotiateType(), and wfPHPVersionError().

◆ $unhide

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next refreshes the diff cache $unhide

Definition at line 1460 of file hooks.txt.

Referenced by ContentHandler::createDifferenceEngine(), Article::setOldSubtitle(), and Article::showDiffPage().

◆ $user

error also a ContextSource $user

Definition at line 249 of file hooks.txt.

◆ $username

this hook is for auditing only or null if authentication failed before getting that far $username

Definition at line 767 of file hooks.txt.

◆ $vars

configuration should be added through ResourceLoaderGetConfigVars instead& $vars

static

Definition at line 1997 of file hooks.txt.

Referenced by MemcachedClient::_load_items(), ApiResult::addMetadataToResultVars(), IEUrlExtension::areServerVarsBad(), ResourceLoaderFileModule::compileLessFile(), DatabaseMssql::estimateRowCount(), DatabaseMysqlBase::estimateRowCount(), DatabasePostgres::estimateRowCount(), CliInstaller::execute(), WebInstallerExistingWiki::execute(), ConvertExtensionToRegistration::execute(), ResourceLoaderStartUpModule::getConfigSettings(), DatabaseMysqlBase::getDefaultSchemaVars(), OutputPage::getJSVars(), ResourceLoaderEditToolbarModule::getLessVars(), Sanitizer::getRecognizedTagData(), OracleInstaller::getSchemaVars(), DatabaseMysqlBase::getServerUptime(), WebInstallerExistingWiki::handleExistingUpgrade(), ConvertExtensionToRegistration::handleExtensionMessagesFiles(), WebInstallerExistingWiki::importVariables(), DatabaseMysqlBase::listTables(), DatabasePostgres::listTables(), DatabaseSqlite::listTables(), DatabaseUpdater::loadExtensions(), DatabasePostgres::makeConnectionString(), DatabaseBase::replaceVars(), DatabaseBase::select(), DatabaseMssql::select(), DatabaseBase::selectRow(), DatabaseOracle::selectRow(), DatabaseBase::selectSQLText(), DatabaseMssql::selectSQLText(), DatabasePostgres::selectSQLText(), DatabaseBase::setSchemaVars(), and WatchedItemStoreUnitTest::verifyCallbackJob().

◆ $wgCapitalizeTitle

An extension or a local 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 56 of file hooks.txt.

◆ $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[ 'PageContentSaveComplete'][] = 'reverseArticleTitle'

Definition at line 110 of file hooks.txt.

Referenced by BenchmarkHooks::execute(), DumpIterator::finalSetup(), Hooks::getHandlers(), SpecialVersion::getWgHooks(), MediaWiki\Auth\AuthManagerTest::hook(), Installer::includeExtensions(), Hooks::isRegistered(), DatabaseUpdater::loadExtensions(), HooksTest::setUp(), NewParserTest::setUp(), ParserOptions::setupFakeRevision(), ParserTest::setupGlobals(), MediaWiki\Auth\AuthManagerTest::testAutoAccountCreation(), HooksTest::testNewStyleHookInteraction(), HooksTest::testOldStyleHooks(), and MediaWiki\Auth\AuthManagerTest::unhook().

◆ $wgNotifyArticle

An extension or a local 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 56 of file hooks.txt.

◆ pad0

error __pad0__

Definition at line 2414 of file hooks.txt.

◆ AbortAutoAccount

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

Definition at line 245 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 53 of file hooks.txt.

Referenced by TextPassDumper::__construct(), CheckLanguageCLI::help(), PoolCounterRedis::initAndPopPoolSlotList(), and MediaWikiServices().

◆ 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 90 of file hooks.txt.

Referenced by RedisLockManager::getLocksOnServer().

◆ admin

An extension or a local admin

Definition at line 51 of file hooks.txt.

◆ Alternatively

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace 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 inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel () must return $toModel. 'CustomEditor' you ll need to handle error etc yourself Alternatively

Definition at line 1221 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 local 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 local patches for two options in MediaWiki One reverses the order of a title before displaying the article

Definition at line 33 of file hooks.txt.

◆ ascending

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace 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 inclusive false for ascending

Definition at line 1081 of file hooks.txt.

◆ ATTENTION

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place ATTENTION

Definition at line 824 of file hooks.txt.

◆ AuthPluginAutoCreate

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that AuthPluginAutoCreate

Definition at line 770 of file hooks.txt.

◆ AutopromoteCondition

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub AutopromoteCondition

Definition at line 780 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 2354 of file hooks.txt.

Referenced by on(), and 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 74 of file hooks.txt.

◆ BeforeDisplayNoArticleText

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array BeforeDisplayNoArticleText

Definition at line 817 of file hooks.txt.

◆ BeforeInitialize

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable BeforeInitialize

Definition at line 829 of file hooks.txt.

◆ BeforeParserFetchFileAndTitle

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable BeforeParserFetchFileAndTitle

Definition at line 849 of file hooks.txt.

◆ BitmapHandlerTransform

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result BitmapHandlerTransform

Definition at line 880 of file hooks.txt.

◆ block

this hook is for auditing only etc instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters block

Definition at line 1969 of file hooks.txt.

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

◆ BlockIp

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves set to a MediaTransformOutput BlockIp

Definition at line 887 of file hooks.txt.

◆ BlockIpComplete

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves set to a MediaTransformOutput the error message to be returned in an array BlockIpComplete

Definition at line 892 of file hooks.txt.

◆ 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 1567 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 1807 of file hooks.txt.

Referenced by cell(), CheckLanguageCLI::help(), CheckExtensionsCLI::help(), and replaceInternalLinks2().

◆ case

it s the revision text itself In either case

Definition at line 2552 of file hooks.txt.

◆ ChangeTagCanCreate

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point ChangeTagCanCreate

Definition at line 994 of file hooks.txt.

◆ ChangeTagCanDelete

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag ChangeTagCanDelete

Definition at line 1003 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 1308 of file hooks.txt.

Referenced by CategoryFinder::check(), Xml::checkLabel(), BrokenRedirectsPage::formatResult(), CheckLanguageCLI::help(), CheckExtensionsCLI::help(), ParserOutput::isLinkInternal(), CategoryFinder::run(), ApiQueryBasicTest::testAllTogether(), MWRestrictionsTest::testCheck(), ApiQueryBasicTest::testGenerator(), ApiQueryBasicTest::testGeneratorRedirects(), ApiQueryBasicTest::testLists(), and ApiQueryBasicTest::testProps().

◆ code

string $code PHP ClassCollector::code

Returns: array List of FQCN detected within the tokens

Definition at line 28 of file hooks.txt.

Referenced by CheckLanguageCLI::__construct(), CheckExtensionsCLI::__construct(), CheckLanguageCLI::doChecks(), DatabaseOracle::doQuery(), FauxResponse::header(), CheckLanguageCLI::help(), CheckExtensionsCLI::help(), MediaWikiServices(), of(), CheckLanguageCLI::outputWiki(), EditPageTest::provideAutoMerge(), and FauxResponse::statusHeader().

◆ 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 1567 of file hooks.txt.

◆ complete

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

Definition at line 199 of file hooks.txt.

Referenced by Xhprof::getCompleteMetrics(), CheckLanguageCLI::help(), CheckExtensionsCLI::help(), and Xhprof::loadRawData().

◆ conditional

namespace addition is conditional

Definition at line 914 of file hooks.txt.

◆ 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 local 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 local patches Consider

Definition at line 32 of file hooks.txt.

◆ ContentHandlerDefaultModelFor

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace ContentHandlerDefaultModelFor

Definition at line 1050 of file hooks.txt.

◆ ContentModelCanBeUsedOn

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired ContentModelCanBeUsedOn

Definition at line 1062 of file hooks.txt.

◆ ContributionsLineEnding

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace 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 inclusive false for true for descending ContributionsLineEnding

Definition at line 1083 of file hooks.txt.

◆ core

error also a ContextSource you ll probably need to make sure the header is varied on such as when responding to a resource loader request or generating HTML output included in core

Definition at line 2538 of file hooks.txt.

◆ create

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 before the output is cached one of create

Definition at line 2379 of file hooks.txt.

Referenced by FileBackendTest::doTestDoOperations(), FileBackendTest::doTestDoOperationsFailing(), FileBackendTest::doTestDoOperationsPipeline(), FileBackendTest::doTestGetFileStat(), and FileBackendTest::doTestStreamFile().

◆ 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 18 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 190 of file hooks.txt.

◆ e

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

Definition at line 1243 of file hooks.txt.

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

◆ EditPageGetDiffContent

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 EditPageGetDiffContent

Definition at line 1270 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 1307 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

◆ 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

this hook is for auditing only etc instead of letting the login form give the generic error message that the account does not exist For example

Definition at line 13 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.

◆ 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 185 of file hooks.txt.

◆ feeds

Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add feeds

Definition at line 316 of file hooks.txt.

◆ FetchChangesList

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers temp or archived zone FetchChangesList

Definition at line 1378 of file hooks.txt.

◆ file

to their LocalSettings php file

Definition at line 94 of file hooks.txt.

Referenced by FileDeleteForm::__construct(), Exif::__construct(), TestFileIterator::__construct(), MySQLMasterPos::__construct(), ThumbnailImage::__construct(), LessFileCompilationTest::__construct(), RevDelArchivedFileItem::__construct(), RevDelFileItem::__construct(), BackupReader::__construct(), LocalFileDeleteBatch::__construct(), LocalFileRestoreBatch::__construct(), LocalFileMoveBatch::__construct(), LocalFileDeleteBatch::addCurrent(), LocalFileDeleteBatch::addOld(), LocalFileDeleteBatch::addOlds(), and(), RevDelFileItem::canView(), RevDelFileItem::canViewContent(), ApiFileRevert::checkPermissions(), TestFileIterator::checkSection(), LocalFileRestoreBatch::cleanup(), LocalFileRestoreBatch::cleanupFailedBatch(), LocalFileMoveBatch::cleanupSource(), LocalFileMoveBatch::cleanupTarget(), LocalFileDeleteBatch::doDBDeletes(), LocalFileDeleteBatch::doDBInserts(), LocalFileMoveBatch::doDBUpdates(), FileDuplicateSearchPage::execute(), ApiFileRevert::execute(), FileDeleteForm::execute(), LocalFileDeleteBatch::execute(), LocalFileRestoreBatch::execute(), LocalFileMoveBatch::execute(), ZipDirectoryReader::execute(), MWDocGen::execute(), RevDelFileItem::getBits(), RevDelFileItem::getComment(), MediaTransformOutput::getDescLinkAttribs(), UploadBase::getExistsWarning(), ZipDirectoryReader::getFileLength(), LocalFileDeleteBatch::getHashes(), RevDelFileItem::getHTML(), RevDelArchivedFileItem::getLink(), RevDelFileItem::getLink(), MediaTransformOutput::getLocalCopyPath(), LocalFileMoveBatch::getMoveTriplets(), ZipDirectoryReader::getSegment(), RevDelFileItem::getUserTools(), CheckLanguageCLI::help(), RevDelFileItem::isDeleted(), User::isLocallyBlockedProxy(), GenerateSitemap::main(), NewParserTest::parserTestProvider(), DatabaseInstaller::populateInterwikiTable(), FileDeleteForm::prepareMessage(), DumpBackup::processOptions(), GIFMetadataExtractorTest::provideGetMetadata(), MergeMessageFileList::readFile(), LocalFileDeleteBatch::removeNonexistentFiles(), LocalFileRestoreBatch::removeNonexistentFiles(), LocalFileMoveBatch::removeNonexistentFiles(), LocalFileRestoreBatch::removeNonexistentFromCleanup(), RevDelFileItem::setBits(), NewParserTest::setParserTestFile(), showUsage(), MediaTransformOutput::streamFileWithStatus(), LessFileCompilationTest::testLessFileCompilation(), ThumbnailImage::toHtml(), and ApiFileRevert::validateParameters().

◆ FileDeleteComplete

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges 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 1385 of file hooks.txt.

◆ form

Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed or on behalf the Licensor for the purpose of discussing and improving the but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as Not a Contribution Contributor shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work Grant of Copyright License Subject to the terms and conditions of this each Contributor hereby grants to You a non no royalty irrevocable copyright license to prepare Derivative Works publicly publicly and distribute the Work and such Derivative Works in Source or Object form Grant of Patent License Subject to the terms and conditions of this each Contributor hereby grants to You a non no royalty have offer to and otherwise transfer the where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed Redistribution You may reproduce and distribute copies of the Work or Derivative Works thereof in any with or without and in Source or Object form

Definition at line 1802 of file hooks.txt.

Referenced by SkinFallbackTemplate::execute(), CheckLanguageCLI::help(), CheckExtensionsCLI::help(), and replaceInternalLinks2().

◆ format

usually copyright or history_copyright This message must be in HTML format

◆ framework

For QUnit framework

Definition at line 2544 of file hooks.txt.

◆ function

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook function

Definition at line 1043 of file hooks.txt.

◆ functions

null for the local wiki Added should default to null in handler functions

Definition at line 1422 of file hooks.txt.

◆ GalleryGetModes

null for the local wiki Added should default to null in handler for backwards compatibility GalleryGetModes

Definition at line 1424 of file hooks.txt.

◆ GetCanonicalURL

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options GetCanonicalURL

Definition at line 1443 of file hooks.txt.

◆ GetDoubleUnderscoreIDs

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next refreshes the diff cache allow viewing deleted revs difference engine object to be used for diff GetDoubleUnderscoreIDs

Definition at line 1464 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 1508 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 1551 of file hooks.txt.

◆ getUserPermissionsErrorsExpensive

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

Definition at line 1575 of file hooks.txt.

◆ GitViewers

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

Definition at line 1589 of file hooks.txt.

◆ gzip

gzip

Definition at line 2555 of file hooks.txt.

◆ handler

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves set to a MediaTransformOutput the error message to be returned in an array you should do so by altering $wgNamespaceProtection and $wgNamespaceContentModels outside the handler

Definition at line 911 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 129 of file hooks.txt.

◆ history

presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc next in line in page history

Definition at line 1597 of file hooks.txt.

Referenced by WikiExporter::__construct(), SpecialImport::doImport(), Parser::doTableStuff(), TextPassDumper::dump(), WikiExporter::dumpFrom(), UpdateLogging::execute(), TextPassDumper::processOptions(), and SpecialImport::showForm().

◆ hook

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

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 21 of file hooks.txt.

Referenced by SpecialStatistics::execute(), and WikitextContentTest::testRedirectParserOption().

◆ 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 74 of file hooks.txt.

Referenced by ParserTest::__construct(), ParserTest::getParser(), SpecialUpload::processVerificationError(), DelayedParserTest::requireHook(), ParserTest::requireHook(), DelayedParserTest::reset(), and DelayedParserTest::unleash().

◆ However

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 or wrap existing services However

static

Definition at line 2027 of file hooks.txt.

◆ 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 1850 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 1618 of file hooks.txt.

◆ in

null for the local wiki Added in

Definition at line 1421 of file hooks.txt.

Referenced by Exif::__construct(), BackupReader::__construct(), PopulateCategory::__construct(), UpdateCollation::__construct(), and(), below(), below(), braceSubstitution(), cell(), SpecialContributions::contributionsSub(), UploadBase::detectScript(), RedisLockManager::freeLocksOnServer(), Title::getContentModel(), SpecialContributions::getForm(), Title::getLatestRevID(), Title::getLength(), RedisLockManager::getLocksOnServer(), Sanitizer::getRecognizedTagData(), Title::getSkinFromCssJsSubpage(), User::getStubThreshold(), DeletedContributionsPage::getSubTitle(), MWExceptionHandler::handleFatalError(), CheckLanguageCLI::help(), CheckExtensionsCLI::help(), PoolCounterRedis::initAndPopPoolSlotList(), ParserOutput::isLinkInternal(), Title::isRedirect(), MessageCache::load(), Title::loadFromRow(), Title::makeTitle(), MediaWikiServices(), SpecialUpload::processVerificationError(), EditPageTest::provideAutoMerge(), RevisionStorageTest::provideUserWasLastToEdit(), JobQueueRedis::pushBlobs(), query(), release(), DjVuImage::retrieveMetaData(), EditPage::showIntro(), SpecialBookSources::showList(), Article::showMissingArticle(), WikitextContentTest::testRedirectParserOption(), text(), updates(), UserOptions::warn(), wfMessage(), work(), and Work().

◆ 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 1856 of file hooks.txt.

Referenced by DatabaseBase::replace(), and DatabaseBase::upsert().

◆ 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 119 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 1577 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 whether this was an auto creation 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 1928 of file hooks.txt.

◆ link

usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template to be included in the link

◆ 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 1251 of file hooks.txt.

◆ LogEventsListGetExtraInputs

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 whether this was an auto creation LogEventsListGetExtraInputs

Definition at line 1909 of file hooks.txt.

◆ login

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 before the output is cached one of login

Definition at line 2379 of file hooks.txt.

◆ LoginFormValidErrorMessages

this hook is for auditing only etc LoginFormValidErrorMessages

Definition at line 1951 of file hooks.txt.

◆ LogLine

this hook is for auditing only etc instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters LogLine

Definition at line 1966 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 2001 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 whether this was an auto creation 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

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace 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 inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel () must return $toModel. 'CustomEditor' you ll need to handle error messages ( )

Definition at line 1220 of file hooks.txt.

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

◆ MimeMagicGuessFromContent

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 or wrap existing services the preferred way to define a new service is the $wgServiceWiringFiles array change it to the message you want to define MimeMagicGuessFromContent

static

Definition at line 2045 of file hooks.txt.

◆ ModifyExportQuery

for adding new MIME types to the list ModifyExportQuery

Definition at line 2069 of file hooks.txt.

◆ name

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

Definition at line 12 of file hooks.txt.

◆ occur

return true to allow those checks to occur

Definition at line 1309 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

◆ otherwise

within a display generated by the Derivative if and wherever such third party notices normally appear The contents of the NOTICE file are for informational purposes only and do not modify the License You may add Your own attribution notices within Derivative Works that You alongside or as an addendum to the NOTICE text from the provided that such additional attribution notices cannot be construed as modifying the License You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for or distribution of Your or for any such Derivative Works as a provided Your and distribution of the Work otherwise complies with the conditions stated in this License Submission of Contributions Unless You explicitly state otherwise

Definition at line 2551 of file hooks.txt.

Referenced by or().

◆ page

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

Definition at line 2388 of file hooks.txt.

Referenced by DumpBackup::__construct(), TextPassDumper::__construct(), ThumbnailImage::__construct(), BlockListPager::__construct(), UpdateCollation::__construct(), EditPage::__construct(), Action::__construct(), LinksDeletionUpdate::__construct(), PoolWorkArticleView::__construct(), LinksDeletionUpdate::doUpdate(), PoolWorkArticleView::doWork(), UpdateLogging::execute(), PoolWorkArticleView::fallback(), HistoryAction::fetchRevisions(), LinksDeletionUpdate::getAsJobSpecification(), PoolWorkArticleView::getCachedWork(), CachedAction::getCacheKey(), EditPage::getContentObject(), Action::getContext(), CreditsAction::getContributors(), InfoAction::getContributors(), CreditsAction::getCredits(), EditPage::getCurrentContent(), MediaTransformOutput::getDescLinkAttribs(), UploadBase::getExistsWarning(), FormAction::getForm(), RevertAction::getFormFields(), SearchUpdate::getLatestPage(), User::getNewtalk(), RawAction::getOldId(), EditPage::getPreviewText(), ImportTest::getRedirectXML(), Action::getTitle(), ImportTest::getUnknownTagsXML(), SpecialContributions::getUserLinks(), CheckLanguageCLI::help(), EditPage::initialiseForm(), EditPage::internalAttemptSave(), Linker::normalizeSubpageLink(), PurgeAction::onSubmit(), RevertAction::onSubmit(), RevertAction::onSuccess(), CreditsAction::onView(), HistoryAction::onView(), InfoAction::onView(), RawAction::onView(), RollbackAction::onView(), InfoAction::pageInfo(), ApiEditPageTest::provideEditAppend(), WikiPageTest::provideGetAutosummary(), replaceInternalLinks2(), DjVuImage::retrieveMetaData(), EditPage::setPostEditCookie(), SpecialMIMESearchTest::setUp(), DeleteAction::show(), ProtectAction::show(), RenderAction::show(), UnprotectAction::show(), ViewAction::show(), EditPage::showDiff(), EditPage::showEditForm(), MovePageForm::showForm(), EditPage::showHeader(), SpecialMIMESearchTest::testMimeFiltering(), SideBarTest::testTrickyPipe(), wfPHPVersionError(), DumpLatestFilter::writeClosePage(), and DumpLatestFilter::writeOpenPage().

◆ PageContentSave

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

Definition at line 13 of file hooks.txt.

◆ PageContentSaveComplete

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

Definition at line 14 of file hooks.txt.

◆ 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 1850 of file hooks.txt.

◆ ParserLimitReportPrepare

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

Definition at line 2334 of file hooks.txt.

◆ ParserTestParser

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 ParserTestParser

Definition at line 2362 of file hooks.txt.

◆ part

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

Definition at line 1243 of file hooks.txt.

◆ performed

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been performed

Definition at line 874 of file hooks.txt.

Referenced by UpdateLogging::execute().

◆ PerformRetroactiveAutoblock

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 before the output is cached one of or reset PerformRetroactiveAutoblock

Definition at line 2382 of file hooks.txt.

◆ 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 before the output is cached one of or reset my talk my contributions etc etc PingLimiter

Definition at line 2394 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 1251 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 1819 of file hooks.txt.

Referenced by Exif::__construct(), and MediaWikiTitleCodec::splitTitleString().

◆ replace

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 replace

static

Definition at line 2026 of file hooks.txt.

◆ request

this hook is for auditing only etc instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters 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 1995 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 1594 of file hooks.txt.

Referenced by DatabaseBase::deadlockLoop(), DatabaseBase::doAtomicSection(), DatabasePostgres::reportQueryError(), DatabaseBase::runOnTransactionIdleCallbacks(), and DatabaseBase::upsert().

◆ rss

Allows to change the fields on the form that will be generated rss

Definition at line 314 of file hooks.txt.

Referenced by RSSFeed::outFooter(), and RSSFeed::outHeader().

◆ saved

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

Definition at line 176 of file hooks.txt.

◆ SearchableNamespaces

external SearchableNamespaces

Definition at line 2557 of file hooks.txt.

◆ SearchGetNearMatch

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

Definition at line 2566 of file hooks.txt.

◆ SearchGetNearMatchBefore

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

Definition at line 2571 of file hooks.txt.

◆ SearchGetNearMatchComplete

the value to return A Title object or null SearchGetNearMatchComplete

Definition at line 2576 of file hooks.txt.

◆ SecondaryDataUpdates

the value to return A Title object or null for latest SecondaryDataUpdates

Definition at line 2586 of file hooks.txt.

◆ SecuritySensitiveOperationStatus

the value to return A Title object or null for latest to be modified or replaced by the hook handler SecuritySensitiveOperationStatus

Definition at line 2598 of file hooks.txt.

◆ SelfLinkBegin

the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible SelfLinkBegin

Definition at line 2609 of file hooks.txt.

◆ set

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

Definition at line 2552 of file hooks.txt.

Referenced by release().

◆ ShortPagesQuery

the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set ShortPagesQuery

Definition at line 2639 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 local 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 29 of file hooks.txt.

◆ skipped

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be skipped

Definition at line 1046 of file hooks.txt.

Referenced by showUsage(), and SideBarTest::testTrickyPipe().

◆ source

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next refreshes the diff cache allow viewing deleted revs difference engine object to be used for diff 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 1472 of file hooks.txt.

Referenced by Exif::__construct(), ApiContinuationManager::__construct(), MergeHistory::__construct(), MergeHistory::checkPermissions(), JSTokenizer::getInput(), MergeHistory::getRevisionCount(), JSTokenizer::init(), MergeHistory::isValidMerge(), MergeHistory::merge(), 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 2551 of file hooks.txt.

◆ strategy

Using a hook running strategy

Definition at line 73 of file hooks.txt.

◆ string

This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki* some string

Definition at line 183 of file hooks.txt.

◆ true

return true

Definition at line 1811 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 1594 of file hooks.txt.

◆ up

bool $databaseSetupDone True if the database has been set ParserTest::up

static

Definition at line 2016 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 before the output is cached one of or reset 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(), extractSections(), Sanitizer::getRecognizedTagData(), CheckLanguageCLI::help(), CheckExtensionsCLI::help(), SearchPostgres::searchQuery(), showUsage(), and text().

◆ UserLogin

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

Definition at line 13 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 179 of file hooks.txt.

Referenced by Exif::__construct(), CheckLanguageCLI::help(), CheckExtensionsCLI::help(), and HtmlTest::testExpandAttributesSpaceSeparatedAttributesWithBoolean().

◆ 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(), MediaWiki\Logger\Monolog\AvroFormatter::__construct(), BatchRowUpdate::__construct(), WikiExporter::closeStream(), BatchRowUpdate::execute(), LCStoreCDB::finishWrite(), MediaWiki\Logger\Monolog\AvroFormatter::format(), WikiExporter::openStream(), WikiExporter::outputLogStream(), WikiExporter::outputPageStream(), LCStoreCDB::set(), and LCStoreCDB::startWrite().

◆ WRONG_PASS

this hook is for auditing only WRONG_PASS

Definition at line 1949 of file hooks.txt.

Typedefs

Functions

Variables

Typedef Documentation

◆ $result

◆ myext.tests

Function Documentation

◆ addExtraTypes()

◆ array() [1/2]

◆ array() [2/2]

◆ follows()

◆ if()

◆ ldapLogin()

◆ options()

◆ query()

◆ system()

◆ values()

◆ wfMessage()

Variable Documentation

◆ $abortMsg

◆ $article

◆ $attribs

◆ $auto

◆ $changesList

◆ $code

◆ $colours

◆ $content

◆ $customAttribs

◆ $differenceEngine

◆ $e

◆ $editor

◆ $extTypes

◆ $flags

◆ $generateHtml

◆ $handler

◆ $handlerParams

◆ $html

◆ $image

◆ $incrBy

◆ $ldapServer

◆ $limit

◆ $link

◆ $linksUpdate

◆ $localize

◆ $mimeMagic

◆ $modeName

◆ $name

◆ $namespaces

◆ $newtalks

◆ $options

◆ $out

◆ $output

◆ $page

◆ $parser

◆ $parserOutput

◆ $personal_urls

◆ $pre

◆ $query

◆ $refreshCache

◆ $req

◆ $request

◆ $requests

◆ $res

◆ $resourceLoader

◆ $ResourceLoader

◆ $response

◆ $ret

◆ $returnTo

◆ $returnToQuery

◆ $retval

◆ $rev

◆ $revert

◆ $revId

◆ $section

◆ $sectionContent

◆ $services

◆ $siteNotice

◆ $skin

◆ $special

◆ $status

◆ pad0