MediaWiki  1.29.1
docs/hooks.txt File Reference

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:Array with elements of the form "language:title" in the order that they will be output. & $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':DEPRECATED! Use HtmlPageLinkRendererBegin instead. 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)
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing groups (accessed through $special->getFilterGroup)
 
 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
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your own (ChangesListBooleanFilterGroup or ChangesListStringOptionsFilterGroup). If you create new groups
 
either a unescaped string or a HtmlArmor object 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
 
either a unescaped string or a HtmlArmor object 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 "&lt
 

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 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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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
 
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
 
null means default$customAttribs
 
null for the 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 as strings Extensions should add to this list prev or next refreshes the diff cache allow viewing deleted revs & $differenceEngine
 
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
 
passed in as a query string parameter to the various URLs constructed here(i.e. $prevlink) $ldel 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
 
the value to return A Title object or null for latest all implement SearchIndexField $engine
 
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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core 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
 
usually copyright or history_copyright This message must be in HTML not wikitext & $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 before processing starts Return false to skip default processing and return $ret $linkRenderer
 
either a unescaped string or a HtmlArmor object 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 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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core $modeName
 
Allows to change the fields on the form that will be generated $name
 
namespace and then decline to actually register it$namespaces
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core 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' also included in $newHeader if any $newminor
 
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
 
passed in as a query string parameter to the various URLs constructed here(i.e. $nextlink) $rdel also included in $oldHeader $oldminor
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 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 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 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 as strings Extensions should add to this list 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 and they can depend only on the ResourceLoaderContext 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 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 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 account incomplete not yet checked for validity & $retval
 
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
 
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException 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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core 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' also included in $newHeader $rollback
 
the value to return A Title object or null for latest all implement SearchIndexField must implement ResultSetAugmentor$rowAugmentors
 
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 services the preferred way to define a new service is the $wgServiceWiringFiles array $services
 
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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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
 
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' 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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist & $tables
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 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 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 as strings Extensions should add to this list 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 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 will often add custom code to the function with or without a global variable For someone wanting email notification when an article is shown may $wgCapitalizeTitle
 
 $wgHooks ['ArticleShow'][] = 'reverseArticleTitle'
 
An extension or a will often add custom code to the function with or without a global variable For someone wanting email notification when an article is shown may $wgNotifyArticle
 
error __pad0__
 
please add to it if you re going to add events to the MediaWiki code AbortAutoAccount
 
An extension or a will often add custom code to the function with or without a global variable For someone wanting email notification when an article is shown may add
 
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In addition
 
An extension or a admin
 
passed in as a query string parameter to the various URLs constructed here(i.e. $prevlink) $ldel 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 administrators to define code that will be run at certain points in the mainline and to modify the data run by that mainline code Hooks can keep mainline code and make it easier to write extensions Hooks are a principled alternative to patches for two options in MediaWiki One reverses the order of a title before displaying the article
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core 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
 
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException 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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 or overridable Default is either copyrightwarning or copyrightwarning2 overridable Default is editpage tos summary such as anonymity and the real check
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those classes
 
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and administrators to define code that will be run at certain points in the mainline code
 
if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect to be fed to an HTMLForm object and populate $result with the reason in the form of error messages should be plain text with no special coloring
 
Returning false makes less sense for events where the action is complete
 
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 administrators to define code that will be run at certain points in the mainline and to modify the data run by that mainline code Hooks can keep mainline code and make it easier to write extensions Hooks are a principled alternative to patches Consider
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core if desired ContentModelCanBeUsedOn
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core 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 and they can depend only on the ResourceLoaderContext such as when responding to a resource loader request or generating HTML output included in core
 
the other converts the title to all uppercase letters Currently
 
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
 
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing deleteAnArticle
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core 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' also included in $newHeader if any indicating whether we should show just the diff
 
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 or overridable Default is either copyrightwarning or copyrightwarning2 EditPageGetCheckboxesDefinition
 
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 or 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 userfalse
 
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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 wiki Added should default to null in handler functions
 
null for the wiki Added should default to null in handler for backwards compatibility GalleryGetModes
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist Generally
 
null for the 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 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 as strings Extensions should add to this list GetDefaultSortkey
 
null for the 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 as strings Extensions should add to this list 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 services However
 
either a unescaped string or a HtmlArmor object 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 wiki Added in
 
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and insert
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure Instead
 
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
 
either a unescaped string or a HtmlArmor object 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
 
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation LogEventsListGetExtraInputs
 
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException 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
 
divlt
 
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
 
either a unescaped string or a HtmlArmor object 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
 
passed in as a query string parameter to the various URLs constructed here(i.e. $prevlink) $ldel you ll need to handle error messages
 
for adding new MIME types to the list ModifyExportQuery
 
and how to run hooks for an and one after Each event has a name
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 Note
 
either a unescaped string or a HtmlArmor object
 
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 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
 
either a unescaped string or a HtmlArmor object 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 ParserTestTables
 
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 my talk my contributions etc etc PingLimiter
 
either a plain
 
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
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist RecentChangesLinked
 
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
 
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException 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 SearchIndexFields
 
it s the revision text itself In either if gzip is set
 
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and administrators to define code that will be run at certain points in the mainline and to modify the data run by that mainline code Hooks can keep mainline code simple
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 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 as strings Extensions should add to this list 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
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that structure
 
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing them
 
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
 

Typedef Documentation

◆ $result

namespace being checked & $result

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

Referenced by ReverseArrayIterator::__construct(), InputBox::__construct(), ResourceLoaderImage::__construct(), MediaWikiTitleCodec::__construct(), FSFileBackend::__construct(), BatchRowIterator::__construct(), IndexPager::__construct(), ResourceLoaderFileModule::__construct(), MagicWord::__construct(), MemcachedClient::__construct(), MemcachedClient::_flush_read_buffer(), MemcachedClient::_incrdecr(), MemcachedClient::_load_items(), ApiBase::addDeprecation(), OutputPage::addHeadItems(), LinkCache::addLinkObj(), ApiErrorFormatter::addMessagesFromStatus(), ApiResult::addMetadataToResultVars(), OutputPage::addModules(), ParserOutput::addModules(), OutputPage::addModuleScripts(), ParserOutput::addModuleScripts(), OutputPage::addModuleStyles(), ParserOutput::addModuleStyles(), OutputPage::addParserOutputMetadata(), MediaWikiTestCase::addTmpFiles(), ApiQueryBase::addWhereRange(), CologneBlueTemplate::afterContent(), ApiResult::applyTransformations(), ApiErrorFormatter::arrayFromStatus(), ApiQueryWatchlistIntegrationTest::assertArraySubsetsEqual(), MWHttpRequestTestCase::assertResponseFieldValue(), LinksDeletionUpdate::batchDeleteByPK(), CologneBlueTemplate::bottomLinks(), SpamRegexBatch::buildRegexes(), BaseBlacklist::buildSharedBlacklists(), PHPVersionCheck::checkExtensionExistence(), LocalRepo::checkRedirect(), ApiBase::checkTitleUserPermissions(), ApiBase::checkUserRightsAny(), ProcessCacheLRU::clear(), MapCacheLRU::clear(), ResourceLoaderFileModule::collateFilePathListByOption(), PdfImage::convertDumpToArray(), UpdateLogging::copyExactMatch(), ReverseArrayIterator::count(), User::createNew(), ReverseArrayIterator::current(), MonoBookTemplate::customBox(), MemcachedClient::disconnect_all(), RecompressTracked::dispatchToReplica(), FSFileBackend::doCopyInternal(), SwiftFileBackend::doCopyInternal(), FSFileBackend::doCreateInternal(), SwiftFileBackend::doCreateInternal(), FSFileBackend::doDeleteInternal(), SwiftFileBackend::doDeleteInternal(), SwiftFileBackend::doDescribeInternal(), WikiPage::doEditContent(), ExprParser::doExpression(), DBFileJournal::doGetChangeEntries(), SpamBlacklist::doLogging(), FSFileBackend::doMoveInternal(), SwiftFileBackend::doMoveInternal(), GenderCache::doQuery(), UserrightsPage::doSaveUserGroups(), FSFileBackend::doStoreInternal(), SwiftFileBackend::doStoreInternal(), FileBackendTest::doTestGetFileContents(), FileBackendTest::doTestGetLocalCopy(), FileBackendTest::doTestGetLocalReference(), PdfHandler::doTransform(), TextPassDumper::endElement(), ApiBase::errorArrayToStatus(), ApiProtect::execute(), ApiQueryTitleBlacklist::execute(), ApiQueryAllMessages::execute(), ApiQueryBlocks::execute(), ApiQueryLangLinks::execute(), ApiParse::execute(), ApiQueryIWLinks::execute(), PurgeModuleDeps::execute(), CleanupRemovedModules::execute(), ApiUserrights::execute(), ApiFeedWatchlist::execute(), ApiQueryUsers::execute(), Scribunto_LuaParserFunctionsLibrary::expr(), JSParser::Expression(), ExtensionProcessor::extractMessagesDirs(), InputBox::extractOptions(), WebRequest::extractTitle(), UploadStash::fetchFileMetadata(), SpamBlacklist::filter(), TextPassDumper::finalOptionCheck(), LocalRepo::findFiles(), User::findUsersByGroup(), Wikimedia\Rdbms\LBFactory::forEachLBCallMethod(), MemcachedClient::forget_dead_hosts(), FeedUtils::formatDiff(), ApiAuthManagerHelper::formatRequests(), JSParser::FunctionDefinition(), MemcachedClient::get(), JSTokenizer::get(), MemcachedClient::get_multi(), MemcachedClient::get_sock(), LegacyLogFormatter::getActionMessage(), ApiSpamBlacklist::getAllowedParams(), ApiQueryTitleBlacklist::getAllowedParams(), MediaWiki\Interwiki\ClassicInterwikiLookup::getAllPrefixesDB(), WebRequest::getArray(), BaseBlacklist::getArticleText(), Title::getAuthorsBetween(), SpamRegexBatch::getBadLines(), OOUIHTMLForm::getButtons(), VFormHTMLForm::getButtons(), HTMLForm::getButtons(), ApiQueryUsers::getCacheMode(), ApiQueryInfo::getCacheMode(), InputBox::getCommentForm(), LocalisationUpdate\Finder::getComponents(), SiteConfiguration::getConfig(), Wikimedia\Rdbms\LoadBalancer::getConnection(), InputBox::getCreateForm(), SpamBlacklist::getCurrentLinks(), ForeignDBFile::getDescriptionText(), File::getDescriptionText(), InputBox::getEditActionArgs(), ApiSpamBlacklist::getExamplesMessages(), ApiQueryTitleBlacklist::getExamplesMessages(), MediaWikiTestCase::getExternalStoreDatabaseConnections(), FileContentsHasher::getFileContentsHash(), ResourceLoaderModule::getFileDependencies(), GadgetDefinitionNamespaceRepo::getGadget(), GadgetDefinitionNamespaceRepo::getGadgetIds(), Language::getGenderNsText(), MWGrants::getGrantRights(), ApiSpamBlacklist::getHelpUrls(), TablePager::getHiddenFields(), PdfImage::getImageSize(), SpecialUpload::getInitialPageText(), HTMLCheckMatrix::getInputHTML(), HTMLAutoCompleteSelectField::getInputHTML(), HTMLFormFieldCloner::getInputHTML(), BaseBlacklist::getInstance(), ResourceLoaderClientHtml::getLoad(), PdfHandler::getMetaArray(), ApiParamInfo::getModuleInfo(), InputBox::getMoveForm(), WANObjectCache::getMulti(), WANObjectCache::getMultiWithSetCallback(), Language::getNamespaceAliases(), ParserOutput::getOutputHooks(), PdfImage::getPageSize(), PdfHandler::getParamMap(), FormatMetadata::getPriorityLanguages(), MWNamespace::getRestrictionLevels(), ApiResult::getResultData(), ResourceLoaderGeSHiVisualEditorModule::getScript(), PdfHandler::getScriptParams(), InputBox::getSearchForm(), InputBox::getSearchForm2(), BaseBlacklist::getSharedBlacklists(), ExternalStoreDB::getSlave(), ConverterRule::getTextInBidtable(), PdfHandler::getThumbType(), BaseBlacklist::getTypeFromTitle(), PdfHandler::getWarningConfig(), ConvertExtensionToRegistration::handleMessagesDirs(), Language::hebrewNumeral(), RequestContext::importScopedSession(), Poem::indentVerse(), User::inDnsBlacklist(), Poem::init(), JSTokenizer::init(), FileRepo::initZones(), CreatePdfThumbnailsJob::insertJobs(), Wikimedia\Rdbms\Database::insertSelect(), ExternalStore::insertToDefault(), BaseBlacklist::isLocalSource(), PdfHandler::isMetadataValid(), Title::isNamespaceProtected(), MediaWikiTestCase::isUsingExternalStoreDB(), Block::isWhitelistedFromAutoblocks(), ReverseArrayIterator::key(), LogPager::limitType(), Linker::link(), SpecialVersion::listAuthors(), ChangeTags::listExplicitlyDefinedTags(), ChangeTags::listSoftwareActivatedTags(), ChangeTags::listSoftwareDefinedTags(), TitleBlacklist::load(), MessageCache::load(), MediaWiki\Interwiki\ClassicInterwikiLookup::load(), ApiAuthManagerHelper::loadAuthenticationRequests(), LocalFile::loadFromCache(), User::loadFromCache(), MediaWiki\Auth\AuthenticationRequest::loadFromSubmission(), Title::loadRestrictions(), SpamBlacklist::logFilterHit(), TitleBlacklistHooks::logFilterHitUsername(), SpamBlacklist::logUrlChange(), MediaWiki\Auth\LegacyHookPreAuthenticationProvider::makeFailResponse(), LogEntryBase::makeParamBlob(), OutputPage::makeResourceLoaderLink(), ApiMain::markParamsSensitive(), ApiMain::markParamsUsed(), EditPage::matchSpamRegex(), EditPage::matchSummarySpamRegex(), JavaScriptMinifier::minify(), UserArray::newFromIDs(), UserArray::newFromNames(), TitleBlacklistEntry::newFromString(), Revision::newKnownCurrent(), ReverseArrayIterator::next(), SiteStats::numberingroup(), TitleBlacklistHooks::onAPIGetAllowedParams(), InterwikiHooks::onInterwikiLoadPrefix(), ImageMap::onParserFirstCallInit(), SpamBlacklistHooks::onUploadVerifyUpload(), Html::openElement(), CologneBlueTemplate::otherLanguages(), CologneBlueTemplate::pageTitleLinks(), TitleBlacklist::parseBlacklist(), parseHighlightLines(), PdfHandler::parseParamString(), JSMinPlus::parseTree(), ApiResult::path(), PdfImage::postProcessDump(), ResourceLoaderWikiModule::preloadTitleInfo(), CologneBlueTemplate::processBottomLink(), SpecialUpload::processVerificationError(), ExpressionTest::provideExpressions(), CologneBlueTemplate::quickBar(), TextPassDumper::readDump(), QueryPage::reallyDoQuery(), LocalisationCache::recache(), SpamRegexBatch::regexesFromMessage(), Scribunto_LuaTitleBlacklistLibrary::register(), Scribunto_LuaParserFunctionsLibrary::register(), InputBoxHooks::register(), PdfHandler::registerWarningModule(), ExtParserFunctions::rel2abs(), ApiResult::removeValue(), ImageMap::render(), InputBox::render(), CologneBlueTemplate::renderAfterPortlet(), Poem::renderPoem(), ReverseArrayIterator::rewind(), CreatePdfThumbnailsJob::run(), ApiQueryPrefixSearch::run(), ApiQueryCategories::run(), ApiQueryWatchlistRaw::run(), ApiQueryBacklinks::run(), MemcachedClient::run_command(), TableCleanup::runTable(), CologneBlueTemplate::searchForm(), ApiQueryBase::select(), Wikimedia\Rdbms\Database::selectRow(), Wikimedia\Rdbms\Database::selectSQLText(), DatabaseTestHelper::setExistingTables(), ApiResult::setPreserveKeysList(), ApiResult::setSubelementsList(), ApiQueryTitleBlacklistTest::setUp(), SkinMonoBook::setupSkinUserCss(), SpecialInterwiki::showList(), LogEventsList::showLogExtract(), LogEventsList::showOptions(), OutputPage::showPermissionsErrorPage(), CologneBlueTemplate::sidebarAdditions(), JSParser::Statement(), ApiResult::stripMetadata(), ApiResult::stripMetadataNonRecursive(), UpdateLogging::sync(), CologneBlueTemplate::sysLinks(), DatabaseTestHelper::tableExists(), Wikimedia\Rdbms\Database::tableNamesWithIndexClauseOrJOIN(), ChangeTags::tagUsageStatistics(), CologneBlueTemplate::talkLink(), Scribunto_LuaTitleBlacklistLibrary::test(), ApiQueryTitleBlacklistTest::testAntiSpoofIntegration(), ApiQueryTitleBlacklistTest::testCheckingBlackListedTitle(), ApiQueryTitleBlacklistTest::testCheckingUnlistedTitle(), WANObjectCacheTest::testGetMultiWithSetCallback(), TitleTest::testIsValidMoveOperation(), ExportTest::testPageByTitle(), LocalisationCacheTest::testRecacheFallbacksWithHooks(), SpecialSearchTest::testRewriteQueryWithSuggestion(), MediaWiki\Session\SessionBackendTest::testSave(), ImportTest::testSiteInfoContainsNamespaces(), ApiQueryTitleBlacklistTest::testTboverride(), TitleTest::testWgWhitelistReadRegexp(), ExtParserFunctions::timeCommon(), ImageMap::tokenizeCoords(), MonoBookTemplate::toolbox(), HTMLForm::trySubmit(), LocalFile::unprefixRow(), ApiResult::unsetPreserveKeysList(), ApiResult::unsetSubelementsList(), ChangeTags::updateTags(), TitleBlacklistHooks::userCan(), SpamBlacklistHooks::userCanSendEmail(), ReverseArrayIterator::valid(), TitleBlacklist::validate(), TitleBlacklistHooks::validateBlacklist(), PdfHandler::validateParam(), ApiResult::validateValue(), CologneBlueTemplate::variantLinks(), and wfInstallerMain().

◆ array() [2/2]

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

◆ follows()

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

Definition at line 35 of file hooks.txt.

References $article, $wgCapitalizeTitle, and global.

◆ groups()

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing groups ( accessed through $special->  getFilterGroup)

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

◆ own()

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your own ( ChangesListBooleanFilterGroup or  ChangesListStringOptionsFilterGroup)
new

◆ query()

either a unescaped string or a HtmlArmor object 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 ( )

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

◆ 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()

either a unescaped string or a HtmlArmor object 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 "&lt

Referenced by HTMLSelectOrOtherField::__construct(), MalformedTitleException::__construct(), HTMLAutoCompleteSelectField::__construct(), Licenses::__construct(), MessageContent::__construct(), ExprError::__construct(), MediaWiki\Widget\DateInputWidget::__construct(), MediaTransformError::__construct(), TransformParameterError::__construct(), TransformTooBigImageAreaError::__construct(), SpamBlacklistHooks::abortNewAccount(), Linker::accesskey(), LogPage::actionText(), Action::addHelpLink(), Article::addHelpLink(), MediaHandler::addMeta(), WikitextContent::addSectionHeader(), Skin::addToSidebar(), ParserOutput::addTrackingCategory(), CologneBlueTemplate::afterContent(), JsonContent::arrayTable(), SpecialVersion::arrayToString(), CologneBlueTemplate::beforeContent(), MediaWiki\Auth\AuthManager::beginAccountCreation(), MediaWiki\Auth\AuthManager::beginAccountLink(), MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::beginLinkAttempt(), Linker::blockLink(), OutputPage::buildBacklinkSubtitle(), AllMessagesTablePager::buildForm(), ProtectionForm::buildForm(), Xml::buildForm(), ChangesFeed::buildItems(), SpecialEditWatchlist::buildTools(), MediaWiki\Auth\AuthManager::checkAccountCreatePermissions(), SpecialPage::checkLoginSecurityLevel(), Title::checkSpecialsAndNSPermissions(), CleanupSpam::cleanupArticle(), Language::commaList(), Linker::commentBlock(), WikiPage::commitRollback(), EmailNotification::composeCommonMailtext(), Article::confirmDelete(), MediaWiki\Auth\AuthManager::continueAccountCreation(), MediaWiki\Auth\AuthManager::continueAccountLink(), MediaWiki\Auth\AuthManager::continueAuthentication(), MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::continueLinkAttempt(), Installer::createMainpage(), MonoBookTemplate::customBox(), Xml::dateMenu(), CoreParserFunctions::defaultsort(), Article::delete(), MediaWiki\Session\SessionProvider::describe(), MediaWiki\Auth\PasswordDomainAuthenticationRequest::describeCredentials(), MediaWiki\Auth\PasswordAuthenticationRequest::describeCredentials(), MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::describeCredentials(), MediaWiki\Session\SessionProvider::describeMessage(), TitleBlacklistHooks::displayBlacklistOverrideNotice(), CoreParserFunctions::displaytitle(), Block::doAutoblock(), FileDeleteForm::doDelete(), Article::doDelete(), Skin::doEditSectionLink(), PdfHandler::doThumbError(), MockDjVuHandler::doTransform(), TransformationalImageHandler::doTransform(), DjVuHandler::doTransform(), SvgHandler::doTransform(), WebInstaller::downloadLinkHook(), Linker::emailLink(), WebInstallerInstall::endStage(), Installer::envCheckDB(), ImageMap::error(), WebInstallerDBConnect::execute(), WebInstallerExistingWiki::execute(), WebInstallerName::execute(), WebInstallerRestart::execute(), WebInstallerWelcome::execute(), ApiImageRotate::execute(), WebInstallerInstall::execute(), WebInstallerUpgrade::execute(), ApiQueryTitleBlacklist::execute(), SpecialUnlinkAccounts::execute(), ApiEditPage::execute(), SpecialLinkAccounts::execute(), ApiQueryAllMessages::execute(), DumpMessages::execute(), ApiFeedContributions::execute(), CleanupSpam::execute(), ApiFeedWatchlist::execute(), FileDeleteForm::execute(), PasswordReset::execute(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::failResponse(), ApiFeedContributions::feedItemDesc(), MessageBlobStore::fetchMessage(), DeleteEqualMessages::fetchMessageInfo(), SimpleCaptcha::filterLink(), ChangesList::flag(), Linker::formatAutocomments(), BlockLogFormatter::formatBlockFlag(), BlockLogFormatter::formatBlockFlags(), FeedUtils::formatDiff(), FeedUtils::formatDiffRow(), LanguageZh_hans::formatDuration(), Language::formatDuration(), WikiPage::formatExpiry(), Linker::formatHiddenCategories(), Linker::formatRevisionSize(), ApiParse::formatSummary(), Language::formatTimePeriod(), ImageListPager::formatValue(), LogEventsList::getActionSelector(), SpecialChangeCredentials::getAuthForm(), ContentHandler::getAutoDeleteReason(), ContentHandler::getAutosummary(), TitleBlacklist::getBlacklistText(), User::getBlockedStatus(), ReCaptcha::getCaptchaInfo(), Skin::getCategoryLinks(), CategoryMembershipChange::getChangeMessageText(), WebInstaller::getCheckBox(), InputBox::getCommentForm(), OracleInstaller::getConnectForm(), PostgresInstaller::getConnectForm(), MysqlInstaller::getConnectForm(), MssqlInstaller::getConnectForm(), SpecialVersion::getCopyrightAndAuthorList(), EditPage::getCopyrightWarning(), InputBox::getCreateForm(), Title::getDefaultMessageText(), Gadget::getDescription(), Interwiki::getDescription(), LogPage::getDescription(), FeedUtils::getDiffLink(), ImageHandler::getDimensionsString(), Title::getEditNotices(), EditPage::getEditToolbar(), Status::getErrorMessage(), SpecialUpload::getExistsWarning(), SpecialVersion::getExtensionTypes(), LoginSignupSpecialPage::getFieldDefinitions(), TitleBlacklistAuthenticationRequest::getFieldInfo(), MediaWiki\Auth\CreationReasonAuthenticationRequest::getFieldInfo(), ReCaptchaAuthenticationRequest::getFieldInfo(), ReCaptchaNoCaptchaAuthenticationRequest::getFieldInfo(), MediaWiki\Auth\UsernameAuthenticationRequest::getFieldInfo(), MediaWiki\Auth\PasswordAuthenticationRequest::getFieldInfo(), CaptchaAuthenticationRequest::getFieldInfo(), MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::getFieldInfo(), MediaWiki\Auth\UserDataAuthenticationRequest::getFieldInfo(), MediaWiki\Auth\ConfirmLinkAuthenticationRequest::getFieldInfo(), MediaWiki\Auth\PasswordDomainAuthenticationRequest::getFieldInfo(), MediaWiki\Auth\RememberMeAuthenticationRequest::getFieldInfo(), WebInstallerDocument::getFileContents(), NumericUppercaseCollation::getFirstLetter(), IcuCollation::getFirstLetter(), FancyCaptcha::getFormInformation(), MediaHandler::getGeneralLongDesc(), User::getGrantName(), MWGrants::getGrantsWikiText(), UserGroupMembership::getGroupMemberName(), UserGroupMembership::getGroupName(), UserGroupMembership::getGroupPage(), WebInstaller::getHelpBox(), Language::getHumanTimestampInternal(), WikiTextStructure::getIgnoredHeadings(), WebInstaller::getInfoBox(), SpecialUpload::getInitialPageText(), Licenses::getInputHTML(), DatabaseInstaller::getInstallUserBox(), LogFormatter::getIRCActionComment(), LogFormatter::getIRCActionText(), SkinTemplate::getLanguages(), ContentHandler::getLocalizedName(), PNGHandler::getLongDesc(), GIFHandler::getLongDesc(), ImageHandler::getLongDesc(), SvgHandler::getLongDesc(), SpecialVersion::getMediaWikiCredits(), SimpleCaptcha::getMessage(), Status::getMessage(), ErrorPageError::getMessageObject(), MalformedTitleException::getMessageObject(), GenerateJqueryMsgData::getMessagesAndTests(), InputBox::getMoveForm(), Interwiki::getName(), LogPage::getName(), WebInstaller::getPageListItem(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::getPasswordResetData(), GadgetHooks::getPreferences(), EditPage::getPreviewLimitReport(), WebInstaller::getRadioElements(), Gadget::getRawDescription(), LogPage::getRcComment(), LogPage::getRcCommentIRC(), DatabaseInstaller::getReadableName(), Block::getRedactedName(), Article::getRedirectHeaderHtml(), MWTimestamp::getRelativeTimestamp(), User::getRightDescription(), InputBox::getSearchForm(), InputBox::getSearchForm2(), MysqlInstaller::getSettingsForm(), MssqlInstaller::getSettingsForm(), ImageHandler::getShortDesc(), SpecialBlock::getSuggestedDurations(), Preferences::getTimeZoneList(), MWTimestamp::getTimezoneMessage(), LogPage::getTitleLink(), TrackingCategories::getTrackingCategories(), CategoryMembershipChange::getUser(), DoubleRedirectJob::getUser(), Language::getVariantname(), SpecialVersion::getVersion(), FormatMetadata::getVisibleFields(), DatabaseInstaller::getWebUserBox(), Status::getWikiText(), MWGrants::grantName(), Title::hasSourceText(), CoreTagHooks::html(), CoreTagHooks::indicator(), WikiPage::insertProtectNullRevision(), DifferenceEngine::intermediateEditsMsg(), CoreParserFunctions::intFunction(), SimpleCaptcha::isIPWhitelisted(), User::isUsableName(), Block::isWhitelistedFromAutoblocks(), WebInstaller::label(), Xml::languageSelector(), SpecialUpload::loadRequest(), TitleBlacklist::loadWhitelist(), MediaWiki\Linker\LinkRenderer::makeBrokenLink(), CaptchaPreAuthenticationProvider::makeError(), Skin::makeI18nUrl(), IndexPager::makeLink(), ApiBase::makeMessage(), BaseTemplate::makeSearchInput(), Linker::makeThumbLink2(), AuthManagerSpecialPage::mapSingleFieldInfo(), MergeHistory::merge(), Xml::monthSelector(), MovePage::move(), MovePage::moveToInternal(), MWException::msg(), MWExceptionRenderer::msg(), Language::msg(), SearchEngineConfig::namespacesAsText(), Html::namespaceSelectorOptions(), PPFrame_Hash::newChild(), PPFrame_DOM::newChild(), TitleBlacklistEntry::newFromString(), Title::newMainPage(), WikiImporter::notice(), Language::numLink(), JsonContent::objectTable(), RenameuserHooks::onContributionsToolLinks(), SpamBlacklistHooks::onUploadVerifyUpload(), CologneBlueTemplate::otherLanguages(), WebInstallerOutput::outputFooter(), WebInstallerOutput::outputTitle(), FormatJson::parse(), ConverterRule::parse(), SearchEngine::parseNamespacePrefixes(), Language::pipeList(), FileDeleteForm::prepareMessage(), CologneBlueTemplate::processBottomLink(), WikiPage::protectDescription(), LogFormatterTest::provideApiParamFormatting(), ApiErrorFormatterTest::provideErrorFormatter(), ApiMainTest::provideExceptionErrors(), MediaWiki\Auth\AuthenticationRequestTest::provideLoadFromSubmission(), CologneBlueTemplate::quickBar(), TextPassDumper::readDump(), AllMessagesTablePager::reallyDoQuery(), SpamRegexBatch::regexesFromMessage(), ExtParserFunctions::rel2abs(), ImageMap::render(), InputBox::render(), VectorTemplate::renderPortal(), WikitextContent::replaceSection(), SpecialPageTest::requireLoginAnonProvider(), WikiEditorHooks::resourceLoaderGetConfigVars(), Linker::revComment(), Linker::revDeleteLink(), Linker::revDeleteLinkDisabled(), Linker::revUserLink(), Linker::revUserTools(), DoubleRedirectJob::run(), CologneBlueTemplate::searchForm(), Language::semicolonList(), User::sendConfirmationMail(), EmailNotification::sendImpersonal(), User::sendMail(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::sendNewAccountEmail(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::sendPasswordResetEmail(), User::setEmailWithConfirmation(), FileDeleteForm::setHeaders(), WikiImporter::setTargetRootPage(), Article::showDiffPage(), WebInstallerUpgrade::showDoneMessage(), WebInstaller::showError(), FileDeleteForm::showForm(), QuestyCaptcha::showHelp(), SimpleCaptcha::showHelp(), WebInstallerExistingWiki::showKeyForm(), WebInstaller::showMessage(), Article::showMissingArticle(), Article::showNamespaceHeader(), Article::showPatrolFooter(), SpecialUpload::showUploadWarning(), SpecialVersion::softwareInformation(), Linker::specialLink(), WebInstaller::startPageWrapper(), WebInstallerInstall::startStage(), UploadStash::stashFile(), WebInstallerName::submit(), SpecialEmailUser::submit(), CologneBlueTemplate::sysLinks(), MediaWiki\Auth\AuthManagerTest::testCreateFromLogin(), ApiErrorFormatterTest::testErrorFormatter(), ApiErrorFormatterTest::testErrorFormatterBC(), MediaWiki\Auth\LegacyHookPreAuthenticationProvider::testForAccountCreation(), MediaWiki\Auth\ThrottlePreAuthenticationProvider::testForAccountCreation(), MediaWiki\Auth\ThrottlePreAuthenticationProvider::testForAuthentication(), MediaWiki\Auth\ButtonAuthenticationRequestTest::testGetRequestByName(), MediaWiki\Auth\ButtonAuthenticationRequestTest::testGetUniqueId(), StatusTest::testHasMessage(), SpecialBlankPageTest::testHasWikiMsg(), XmlTest::testLanguageSelector(), LogFormatterTest::testLogParamsTypeMsg(), LogFormatterTest::testLogParamsTypeMsgContent(), MediaWiki\Auth\AuthenticationRequestTest::testMergeFieldInfo(), ResourcesTest::testMissingMessages(), CaptchaPreAuthenticationProviderTest::testPostAuthentication(), CaptchaPreAuthenticationProviderTest::testPostAuthentication_disabled(), MediaWiki\Auth\ThrottlePreAuthenticationProviderTest::testTestForAuthentication(), ExtraParserTest::testTrackingCategory(), MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProviderTest::testTryReset(), ExtParserFunctions::timeCommon(), Linker::titleAttrib(), Linker::tocList(), ExtParserFunctions::tooLongError(), File::transformErrorOutput(), BitmapHandler::transformGd(), MediaWikiI18N::translate(), Language::truncate(), Language::truncateHtml(), MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider::tryReset(), PageArchive::undeleteRevisions(), StripState::unstripCallback(), TitleBlacklistHooks::userCan(), Linker::userTalkLink(), Linker::userToolLinks(), SpamBlacklistHooks::validate(), TitleBlacklistHooks::validateBlacklist(), Article::view(), Language::viewPrevNext(), Article::viewRedirect(), wfGenerateThumbnail(), wfStreamThumb(), MediaWiki\Session\ImmutableSessionProviderWithCookie::whyNoSession(), and MediaWiki\Session\CookieSessionProvider::whyNoSession().

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

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

◆ $attribs

either a unescaped string or a HtmlArmor object & $attribs

Definition at line 1956 of file hooks.txt.

Referenced by PPNode_Hash_Tree::__toString(), OutputPage::addElement(), HTMLForm::addHiddenField(), MediaWiki\Tidy\Balancer::advance(), MediaWiki\Linker\LinkRenderer::buildAElement(), ProtectionForm::buildForm(), Xml::buildTable(), Xml::buildTableRow(), EditPage::buildTextboxAttribs(), Xml::check(), Html::check(), Xml::checkLabel(), EditPage::displayPreviewArea(), XMPReader::doAttribs(), WebInstaller::docLink(), Skin::doEditSectionLink(), Html::dropDefaults(), Xml::element(), Html::element(), Xml::elementClean(), XmlTypeCheck::elementClose(), XmlTypeCheck::elementOpen(), Xml::expandAttributes(), Html::expandAttributes(), Xml::fieldset(), CategoryViewer::formatList(), HTMLMultiSelectField::formatOptions(), HTMLRadioField::formatOptions(), SpecialUndelete::formatRevisionRow(), HTMLForm::formatSection(), HTMLComboboxField::getAttributes(), HTMLAutoCompleteSelectField::getAttributes(), OOUIHTMLForm::getButtons(), VFormHTMLForm::getButtons(), HTMLForm::getButtons(), DatabaseInstaller::getCheckBox(), EditPage::getCheckboxes(), MediaTransformOutput::getDescLinkAttribs(), EditPage::getEditButtons(), VFormHTMLForm::getFormAttributes(), HTMLForm::getFormAttributes(), HTMLForm::getHiddenFields(), ChangeTagsRevisionItem::getHTML(), ChangeTagsLogItem::getHTML(), CategoryViewer::getHTML(), RevDelRevisionItem::getHTML(), HTMLSizeFilterField::getInputHTML(), HTMLFancyCaptchaField::getInputHTML(), HTMLReCaptchaField::getInputHTML(), HTMLTextAreaField::getInputHTML(), HTMLTextField::getInputHTML(), HTMLCheckMatrix::getInputHTML(), Licenses::getInputHTML(), HTMLFormFieldCloner::getInputHTMLForKey(), HTMLComboboxField::getInputOOUI(), HTMLSelectField::getInputOOUI(), HTMLTextAreaField::getInputOOUI(), HTMLTextField::getInputOOUI(), UploadSourceField::getLabelHtml(), TablePager::getLimitSelect(), IRCColourfulRCFeedFormatter::getLine(), HTMLMultiSelectField::getOneCheckbox(), HTMLCheckMatrix::getOneCheckbox(), DatabaseInstaller::getPasswordBox(), EditPage::getPreviewText(), LogFormatter::getRestrictedElement(), DatabaseInstaller::getTextBox(), HTMLTextField::getType(), UserrightsPage::groupCheckboxes(), Html::hidden(), HistoryPager::historyLine(), Html::htmlHeader(), MediaWiki\Tidy\Balancer::inBodyMode(), MediaWiki\Tidy\Balancer::inCaptionMode(), MediaWiki\Tidy\Balancer::inCellMode(), MediaWiki\Tidy\Balancer::inColumnGroupMode(), Poem::indentVerse(), MediaWiki\Tidy\Balancer::inHeadMode(), Xml::input(), Html::input(), Xml::inputLabel(), Xml::inputLabelSep(), MediaWiki\Tidy\Balancer::inRowMode(), MediaWiki\Tidy\Balancer::inSelectInTableMode(), MediaWiki\Tidy\Balancer::inSelectMode(), MediaWiki\Tidy\BalanceStack::insertForeignElement(), MediaWiki\Tidy\Balancer::insertForeignToken(), MediaWiki\Tidy\BalanceStack::insertHTMLElement(), MediaWiki\Tidy\Balancer::insertToken(), MediaWiki\Tidy\Balancer::inTableBodyMode(), MediaWiki\Tidy\Balancer::inTableMode(), MediaWiki\Tidy\Balancer::inTableTextMode(), MediaWiki\Tidy\Balancer::inTemplateMode(), MediaWiki\Tidy\Balancer::inTextMode(), Xml::label(), Html::label(), Xml::listDropDown(), MediaWiki\Linker\LinkRenderer::makeBrokenLink(), TestRecentChangesHelper::makeCategorizationRecentChange(), TestRecentChangesHelper::makeDeletedEditRecentChange(), TestRecentChangesHelper::makeEditRecentChange(), DummyLinker::makeExternalLink(), Linker::makeExternalLink(), DummyLinker::makeHeadline(), TestRecentChangesHelper::makeLogRecentChange(), Linker::makeMediaLinkFile(), TestRecentChangesHelper::makeNewBotEditRecentChange(), MediaWiki\Linker\LinkRenderer::makePreloadedLink(), TestRecentChangesHelper::makeRecentChange(), SpecialInterwiki::makeTable(), MediaWiki\Linker\LinkRenderer::mergeAttribs(), Revision::newFromArchiveRow(), Xml::openElement(), Html::openElement(), Xml::option(), SpecialRecentChanges::optionsPanel(), Licenses::outputOption(), MediaWiki\Tidy\Balancer::parseRawText(), Xml::password(), CoreTagHooks::pre(), Xml::radio(), Html::radio(), Xml::radioLabel(), Html::rawElement(), ImageMap::render(), Poem::renderPoem(), LinkHolderArray::replaceInternal(), RecentChange::setAttribs(), ImageGalleryBase::setAttributes(), SpecialImport::showForm(), EditPage::showTextbox(), EditPage::showTextbox1(), Xml::span(), TextPassDumper::startElement(), XMPReader::startElement(), XMPReader::startElementModeInitial(), XMPReader::startElementModeLi(), XMPReader::startElementModeLiLang(), XMPReader::startElementModeSimple(), XMPReader::startElementModeStruct(), LogFormatter::styleRestricedElement(), Xml::submitButton(), MediaWiki\Tidy\Balancer::switchModeAndReprocess(), Xml::tags(), SideBarTest::testRespectExternallinktarget(), SideBarTest::testRespectWgnofollowlinks(), SideBarTest::testTestAttributesAssertionHelper(), Xml::textarea(), Html::textarea(), TraditionalImageGallery::toHTML(), ThumbnailImage::toHtml(), Linker::tooltipAndAccesskeyAttribs(), Linker::userToolLinks(), 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

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

Referenced by ChangesList::getArticleLink().

◆ $code

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

Definition at line 783 of file hooks.txt.

Referenced by LocalisationUpdate\JSONReader::__construct(), UsageException::__construct(), MediaWiki\Session\MetadataMergeException::__construct(), LocalizedException::__construct(), ApiQueryBacklinks::__construct(), ApiMain::__construct(), ApiMessage::__construct(), ApiRawMessage::__construct(), ZipDirectoryReaderError::__construct(), ApiErrorFormatter::addError(), ApiBase::addError(), Language::addMagicWordsByLang(), ApiErrorFormatter::addWarning(), ApiBase::addWarning(), ApiTestCase::apiExceptionHasCode(), EmailConfirmation::attemptConfirm(), EmailInvalidation::attemptInvalidate(), SkinTemplate::buildContentNavigationUrls(), Language::classFromCode(), MessageCache::clear(), ApiMessage::create(), Language::dateTimeObjFormat(), ApiBase::dieWithError(), ApiBase::dieWithErrorOrDebug(), RebuildLocalisationCache::doRebuild(), ImagePage::doRenderLangOpt(), ApiCSPReport::error(), ZipDirectoryReader::error(), ApiMain::errorMessagesFromException(), PageExists::execute(), EmailInvalidation::execute(), DateFormats::execute(), GenerateNormalizerDataAr::execute(), Digit2Html::execute(), EmailConfirmation::execute(), FindDeprecated::execute(), SpecialPageExecutor::executeSpecialPage(), SpecialJavaScriptTest::exportQUnit(), Language::factory(), SpecialNewpages::feedTitle(), QueryPage::feedTitle(), LocalisationUpdate\HttpFetcher::fetchDirectory(), Language::fetchLanguageName(), SpecialMyLanguage::findTitle(), Language::firstChar(), TagHookTest::functionTagCallback(), LCStoreDB::get(), LCStoreCDB::get(), LCStoreStaticArray::get(), MessageCache::getAllMessageKeys(), ClassCollector::getClasses(), LocalisationCache::getCompiledPluralRules(), SpecialCiteThisPage::getContentText(), Language::getFallbackFor(), Language::getFallbacksFor(), Language::getFallbacksIncludingSiteLanguage(), LCStoreCDB::getFileName(), Language::getFileName(), SpecialPageLanguage::getFormFields(), LocalisationCacheBulkLoad::getItem(), LocalisationCache::getItem(), Language::getJsonMessagesFileName(), RequestContext::getLanguage(), WebInstallerLanguage::getLanguageSelector(), WANObjectCache::getLastError(), MessageCache::getLocalCache(), HttpStatus::getMessage(), Language::getMessageFor(), MessageCache::getMessageForLang(), Language::getMessageKeysFor(), Language::getMessagesFileName(), Language::getMessagesFor(), MessageCache::getMsgFromNamespace(), Language::getParentLanguage(), LocalisationCache::getPluralRules(), LocalisationCache::getPluralRuleTypes(), LocalisationUpdate\ReaderFactory::getReader(), SpecialPageAliasTest::getSpecialPageAliases(), LocalisationCacheBulkLoad::getSubitem(), LocalisationCache::getSubitem(), LocalisationCache::getSubitemList(), MessageCache::getValidationHash(), Language::getVariantname(), HttpStatus::header(), LocalisationCache::initLanguage(), EditPage::internalAttemptSave(), LocalisationCache::isExpired(), Language::isSupportedLanguage(), Language::isValidBuiltInCode(), Language::isValidCode(), Language::isWellFormedLanguageTag(), CoreParserFunctions::language(), Xml::languageSelector(), MessageCache::load(), MessageCache::loadFromDB(), MessageCache::loadFromDBWithLock(), LocalisationCache::loadItem(), LocalisationCache::loadPluralFile(), LocalisationCache::loadSubitem(), LocalisationCache::mergeExtensionItem(), Language::newFromCode(), User::newFromConfirmationCode(), ApiUsageException::newWithMessage(), SwiftFileBackend::onError(), LocalisationUpdate::onRecache(), LocalisationUpdate::onRecacheFallback(), OutputPage::output(), FormatJson::parse(), XMPReader::parse(), ApiStashEdit::parseAndStash(), SpecialUpload::processUpload(), SpecialUpload::processVerificationError(), Preferences::profilePreferences(), LocalisationUpdate\Updater::readMessages(), LocalisationCache::readSourceFilesAndRegisterDeps(), LocalisationCacheBulkLoad::recache(), LocalisationCache::recache(), MessageCache::replace(), DbTestPreviewer::report(), ApiQueryBacklinks::run(), RequestContext::sanitizeLangCode(), MessageCache::saveToCaches(), MessageCache::saveToLocalCache(), setApiCode(), Language::setCode(), ApiFormatBase::setHttpStatus(), AjaxResponse::setResponseCode(), LoginSignupSpecialPage::setSessionUserForCurrentRequest(), MWHttpRequest::setStatus(), MessageCache::setValidationHash(), ChangesList::showCharacterDifference(), SpecialUploadStash::showUpload(), Language::sprintfDate(), LCStoreStaticArray::startWrite(), LCStoreDB::startWrite(), LCStoreCDB::startWrite(), WebResponse::statusHeader(), MWException::statusHeader(), MWExceptionRenderer::statusHeader(), WfBCP47Test::testBCP47(), LanguageTest::testBuiltInCodeValidation(), LanguageTest::testGetParentLanguage(), ApiMessageTest::testInvalidCode(), LanguageTest::testIsSupportedLanguage(), JavaScriptMinifierTest::testJavaScriptMinifierOutput(), LanguageTest::testKnownLanguageTag(), LanguageTest::testMalformedLanguageTag(), LocalisationCacheTest::testRecacheFallbacksWithHooks(), LanguageTest::testUnknownLanguageTag(), LanguageTest::testWellFormedLanguageTag(), LocalisationCacheBulkLoad::trimCache(), LocalisationCacheBulkLoad::unload(), LocalisationCache::unload(), and SpecialPageAliasTest::validSpecialPageAliasesProvider().

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

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

◆ $content

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 1049 of file hooks.txt.

Referenced by InfoAction::addTable(), EditPageTest::assertEdit(), ResourceLoaderModule::buildContent(), ApiStashEdit::checkCache(), Revision::checkContentModel(), XMPReader::checkParseSafety(), CleanupSpam::cleanupArticle(), ConfirmEditHooks::confirmEditMerged(), SimpleCaptcha::confirmEditMerged(), Installer::createMainpage(), WikiPageTest::createPage(), RevisionStorageTest::createPage(), TestPageProps::createPage(), EditPage::displayPermissionsError(), EditPage::displayViewSourcePage(), ApiQueryWatchlistIntegrationTest::doAnonPageEdit(), ApiQueryWatchlistIntegrationTest::doBotPageEdit(), WikiPage::doCreate(), WikiPage::doDeleteArticleReal(), Article::doDeleteUpdates(), WikiPage::doDeleteUpdates(), WikiPage::doEditContent(), Article::doEditContent(), DifferenceEngineTest::doEdits(), WikiPage::doEditUpdates(), ApiQueryWatchlistIntegrationTest::doMinorPageEdit(), WikiPage::doModify(), ApiQueryWatchlistIntegrationTest::doPageEdit(), ApiQueryWatchlistIntegrationTest::doPatrolledPageEdit(), EditPage::doPreviewParse(), FileBackendTest::doTestGetFileContents(), FileBackendTest::doTestGetFileHttpUrl(), FileBackendTest::doTestGetFileStat(), FileBackendTest::doTestGetLocalCopy(), FileBackendTest::doTestGetLocalReference(), FileBackendTest::doTestStreamFile(), FileBackendTest::doTestStreamFileRange(), CompareParserCache::execute(), ApiEditPage::execute(), ViewCLI::execute(), ApiPurge::execute(), MakeTestEdits::execute(), GetTextMaint::execute(), ImportSiteScripts::execute(), EditCLI::execute(), ApiStashEdit::execute(), ApiQueryRevisionsBase::extractRevisionInfo(), ApiFeedContributions::feedItemDesc(), Article::fetchContentObject(), Xml::fieldset(), SpamBlacklistHooks::filterMergedContent(), WikiImporter::finishImportPage(), RefreshLinks::fixLinksFromArticle(), RefreshLinks::fixRedirect(), FormatMetadata::flattenArrayReal(), CoreTagHooks::gallery(), AutoloadGenerator::generatePHPAutoload(), BaseTemplate::getAfterPortlet(), ContentHandler::getAutoDeleteReason(), FindHooks::getBadHooksFromFile(), CategoryMembershipChangeJob::getCategoriesAtRev(), ResourceLoaderWikiModule::getContent(), ApiStashEdit::getContentHash(), ResourceLoaderWikiModule::getContentObj(), Article::getContentObject(), EditPage::getContentObject(), ContentHandler::getContentText(), EditPage::getCurrentContent(), ContentHandler::getDataForSearchIndex(), Article::getDeletionUpdates(), WikiPage::getDeletionUpdates(), LocalFile::getDescriptionText(), ContentHandler::getForContent(), GadgetDefinitionNamespaceRepo::getGadget(), FindHooks::getHooksFromFile(), FindHooks::getHooksFromLocalDoc(), ChangeTagsRevisionItem::getHTML(), ChangeTagsLogItem::getHTML(), RevDelRevisionItem::getHTML(), BaseTemplate::getIndicators(), MessageCache::getMessageTextFromContent(), PNGMetadataExtractor::getMetadata(), MessageCache::getMsgFromNamespace(), EditPage::getOriginalContent(), ContentHandler::getPageViewLanguage(), WikitextStructureTest::getParserOutput(), EditPage::getPreloadedContent(), EditPage::getPreviewText(), RawAction::getRawText(), LogFormatter::getRestrictedElement(), BaseTemplate::getSidebar(), ResourceLoaderFileModule::getTemplates(), FileBackendGroup::guessMimeInternal(), DumpRenderer::handleRevision(), FixDefaultJsonContentPages::handleRow(), CoreTagHooks::html(), CheckStorage::importRevision(), CoreTagHooks::indicator(), EditPage::initialiseForm(), WikiPage::insertRedirect(), EditPage::internalAttemptSave(), WikiPage::isCountable(), MovePage::isValidMoveTarget(), Title::isValidMoveTarget(), JobRunner::loadBackoffs(), SimpleCaptcha::loadText(), MessageCacheTest::makePage(), LinkFilter::matchEntry(), Gadget::newFromDefinitionContent(), RevisionTest::newTestRevision(), CoreTagHooks::nowiki(), ConfirmEditHooks::onAlternateEditPreview(), onContentGetParserOutput(), GadgetHooks::onEditFilterMergedContent(), SpamBlacklistHooks::onUploadVerifyUpload(), InfoAction::onView(), SpecialUploadStash::outputContents(), XMPReader::parse(), ApiStashEdit::parseAndStash(), XMPReader::parseExtended(), RebuildTextIndex::populateSearchIndex(), CoreTagHooks::pre(), WikiPage::prepareContentForEdit(), Article::prepareContentForEdit(), PreprocessDump::processRevision(), CompareParsers::processRevision(), FileBackendTest::provider_testConcatenate(), CologneBlueTemplate::renderAfterPortlet(), MonoBookTemplate::renderPortals(), VectorTemplate::renderPortals(), DoubleRedirectJob::run(), RefreshLinksJob::runForTitle(), BenchmarkParse::runParser(), EditPage::runPostMergeFilters(), DummyNonTextContentHandler::serializeContent(), DummyContentHandlerForTesting::serializeContent(), TextContentHandler::serializeContent(), ParserOutput::setIndicator(), EditPage::setPreloadedContent(), ParserOptions::setupFakeRevision(), BaseDumpTest::setUpPrefetch(), TextPassDumperDatabaseTest::setUpStub(), SimpleCaptcha::shouldCheck(), EditPage::showEditForm(), SpecialBookSources::showList(), SpecialUndelete::showRevision(), LogFormatter::styleRestricedElement(), JobRunner::syncBackoffDeltas(), JavaScriptContentTest::testAddSectionHeader(), TextContentTest::testCopy(), EditPageTest::testCreatePage(), EditPageTest::testCreatePageTrx(), TextContentTest::testDeletionUpdates(), WikiPageTest::testDoEditContent(), ApiEditPageTest::testEditAppend(), ContentHandlerTest::testGetAutosummary(), WikiPageTest::testGetContent(), RevisionTest::testGetContent(), RevisionTest::testGetContentClone(), CssContentTest::testGetContentHandler(), JavaScriptContentTest::testGetContentHandler(), TextContentTest::testGetContentHandler(), ContentHandlerTest::testGetContentText_NonTextContent_fail(), ContentHandlerTest::testGetContentText_NonTextContent_ignore(), ContentHandlerTest::testGetContentText_NonTextContent_serialize(), ContentHandlerTest::testGetContentText_Null(), ContentHandlerTest::testGetContentText_TextContent(), RevisionTest::testGetContentUncloned(), FileBackendTest::testGetFileContents(), FileBackendTest::testGetFileHttpUrl(), FileBackendTest::testGetFileStat(), HttpErrorTest::testGetHtml(), FileBackendTest::testGetLocalCopy(), FileBackendTest::testGetLocalReference(), CssContentTest::testGetModel(), JavaScriptContentTest::testGetModel(), TextContentTest::testGetModel(), TextContentTest::testGetNativeData(), TextContentTest::testGetParserOutput(), CssContentTest::testGetRedirectTarget(), TextContentTest::testGetRedirectTarget(), JavaScriptContentTest::testGetRedirectTarget(), WikitextContentTest::testGetSecondaryDataUpdates(), TextContentTest::testGetSize(), TextContentTest::testGetTextForSearchIndex(), TextContentTest::testGetTextForSummary(), TextContentTest::testGetWikitextForTransclusion(), TextContentTest::testIsCountable(), TextContentTest::testIsEmpty(), TextContentTest::testIsRedirect(), ContentHandlerTest::testMakeContent(), JsonContentHandlerTest::testMakeEmptyContent(), ContentHandlerSanityTest::testMakeEmptyContent(), WikitextContentHandlerTest::testMakeEmptyContent(), CssContentHandlerTest::testMakeRedirectContent(), JavaScriptContentHandlerTest::testMakeRedirectContent(), WikitextContentHandlerTest::testMakeRedirectContent(), JavaScriptContentTest::testMatchMagicWord(), TextContentTest::testPreloadTransform(), TextContentTest::testPreSaveTransform(), RefreshLinksPartitionTest::testRefreshLinks(), WikitextContentHandlerTest::testSerializeContent(), MWHttpRequestTestCase::testSetCallback(), FileBackendTest::testStreamFile(), WikitextContentHandlerTest::testUnserializeContent(), EditPageTest::testUpdatePage(), EditPageTest::testUpdatePageTrx(), JavaScriptContentTest::testUpdateRedirect(), Xml::textarea(), EditPage::toEditContent(), EditPage::toEditText(), PageArchive::undeleteRevisions(), MessageCache::updateMessageOverride(), WikiPage::updateRevisionOn(), PopulateRevisionLength::upgradeRow(), Article::view(), and wfThumbError().

◆ $context

error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context

Definition at line 2612 of file hooks.txt.

Referenced by LogPage::addEntry(), MWDebug::appendDebugInfoToApiResult(), ChangesListSpecialPageTest::assertConditions(), ResourceLoaderModule::buildContent(), SpecialBookSources::buildForm(), ProtectionForm::buildForm(), ChangesListSpecialPage::buildQuery(), DummyLinker::buildRollbackLink(), Linker::buildRollbackLink(), ChangeTags::buildTagFilterSelector(), SpecialPageFactory::capturePath(), SpecialPageLanguage::changePageLanguage(), ResourceLoaderFileModule::compileLessFile(), ConfirmEditHooks::confirmEditMerged(), SimpleCaptcha::confirmEditMerged(), ResourceLoaderUserTokensModule::contextUserTokens(), ContentHandler::createDifferenceEngine(), RevisionDeleter::createList(), ApiPageSetTest::createPageSetWithRedirect(), Preferences::datetimePreferences(), MWDebug::debugMsg(), Article::delete(), ApiTestCase::doApiRequest(), SimpleCaptcha::doConfirmEdit(), Article::doDelete(), SpecialWatchlist::doHeader(), HttpError::doLog(), ActionTest::dummyActionCallback(), Preferences::editingPreferences(), SimpleCaptcha::editShowCaptcha(), ApiFormatTestBase::encodeData(), SpecialAutoblockList::execute(), SpecialBlockList::execute(), RebuildFileCache::execute(), PhpHttpRequest::execute(), SpecialEmailUser::execute(), SpecialPageFactory::executePath(), SpecialPageExecutor::executeSpecialPage(), Preferences::filesPreferences(), SpamBlacklistHooks::filterMergedContent(), DiffFormatter::format(), FeedUtils::formatDiffRow(), GIFHandler::formatMetadata(), PNGHandler::formatMetadata(), ExifBitmapHandler::formatMetadata(), PdfHandler::formatMetadata(), File::formatMetadata(), MediaHandler::formatMetadataHelper(), ChangeTags::formatSummaryRow(), MWCryptHKDF::generate(), MWCryptHKDF::generateHex(), DummyLinker::generateRollback(), Linker::generateRollback(), Preferences::generateSkinOptions(), ResourceLoaderStartUpModule::getAllModuleHashes(), AuthManagerSpecialPage::getAuthForm(), LoginSignupSpecialPage::getAuthForm(), CacheHelper::getCachedNotice(), SpecialEditWatchlist::getClearForm(), ResourceLoaderStartUpModule::getConfigSettings(), ActionTest::getContext(), OldChangesListTest::getContext(), RCCacheEntryFactoryTest::getContext(), ResourceLoaderLanguageDataModule::getData(), ResourceLoaderLanguageNamesModule::getData(), Preferences::getDateOptions(), MWDebug::getDebugHTML(), MWDebug::getDebugInfo(), CiteDataModule::getDefinitionSummary(), ResourceLoaderSkinModule::getDefinitionSummary(), ResourceLoaderWikiModule::getDefinitionSummary(), ResourceLoaderStartUpModule::getDefinitionSummary(), ResourceLoaderImageModule::getDefinitionSummary(), ResourceLoaderFileModule::getDefinitionSummary(), ResourceLoaderForeignApiModule::getDependencies(), ResourceLoaderModule::getFileDependencies(), ResourceLoaderImageModule::getFileHashes(), ResourceLoaderFileModule::getFileHashes(), MWDebug::getFilesIncluded(), ResourceLoaderModule::getFlip(), ResourceLoaderFileModule::getFlip(), HTMLFancyCaptchaFieldTest::getForm(), Preferences::getFormObject(), ResourceLoaderImageModule::getGlobalVariants(), ResourceLoaderImage::getImageData(), ResourceLoaderImageModule::getImages(), Preferences::getImageSizes(), DummyLinker::getInvalidTitleDescription(), Linker::getInvalidTitleDescription(), ResourceLoaderEditToolbarModule::getLessVars(), UserGroupMembership::getLink(), ApiContinuationManagerTest::getManager(), ResourceLoaderModule::getMessageBlob(), ResourceLoaderModule::getModuleContent(), ResourceLoaderStartUpModule::getModuleRegistrations(), SpecialEditWatchlist::getNormalForm(), OldChangesListTest::getOldChangesList(), User::getOptionKinds(), ResourceLoaderUserModule::getPages(), ResourceLoaderUserStylesModule::getPages(), ResourceLoaderSiteModule::getPages(), ResourceLoaderSiteStylesModule::getPages(), ResourceLoaderImage::getPath(), Block::getPermissionsError(), Preferences::getPreferences(), SpecialEditWatchlist::getRawForm(), ManualLogEntry::getRecentChange(), CiteDataModule::getScript(), ResourceLoaderGeSHiVisualEditorModule::getScript(), ResourceLoaderUploadDialogModule::getScript(), ResourceLoaderJqueryMsgModule::getScript(), ResourceLoaderRawFileModule::getScript(), ResourceLoaderLanguageNamesModule::getScript(), ResourceLoaderUserOptionsModule::getScript(), ResourceLoaderLanguageDataModule::getScript(), ResourceLoaderStartUpModule::getScript(), ResourceLoaderFileModule::getScriptFiles(), ResourceLoaderGeSHiVisualEditorModule::getScriptURLsForDebug(), ResourceLoaderJqueryMsgModule::getScriptURLsForDebug(), ResourceLoaderModule::getScriptURLsForDebug(), ResourceLoaderStartUpModule::getStartupModulesUrl(), ChangesListSpecialPage::getStructuredFilterJsData(), ResourceLoaderImageModule::getStyleDeclarations(), ResourceLoaderFileModule::getStyleFiles(), ResourceLoaderSkinModule::getStyles(), ResourceLoaderImageModule::getStyles(), ResourceLoaderFileModule::getStyles(), ResourceLoaderModule::getStyleURLsForDebug(), ResourceLoaderFileModule::getStyleURLsForDebug(), TestRecentChangesHelper::getTestContext(), Preferences::getThumbSizes(), Preferences::getTimezoneOptions(), SpecialUpload::getUploadForm(), ResourceLoaderImage::getUrl(), ResourceLoaderModule::getVersionHash(), RequestContext::importScopedSession(), WikitextContent::isCountable(), HTMLFileCache::loadFromFileCache(), Preferences::loadPreferenceValues(), TestLogger::log(), ChangesListSpecialPage::makeLegend(), ContentHandler::makeParserOptions(), WikiPage::makeParserOptions(), Article::makeParserOptions(), SpecialPageExecutor::newContext(), EnhancedChangesListTest::newEnhancedChangesList(), RequestContext::newExtraneousContext(), ResourceFileCache::newFromContext(), ParserOptions::newFromContext(), Article::newFromTitle(), Article::newFromWikiPage(), ApiTestContext::newTestContext(), onApiFormatHighlight(), GadgetHooks::onEditFilterMergedContent(), SpecialRecentChanges::optionsPanel(), ResourceLoaderWikiModule::preloadTitleInfo(), SpecialTags::processCreateTagForm(), SpecialBlock::processForm(), SpecialTags::processTagForm(), SpecialUnblock::processUnblock(), Preferences::profilePreferences(), Preferences::rcPreferences(), ResourceLoaderFileModule::readStyleFile(), ResourceLoaderFileModule::readStyleFiles(), Preferences::renderingPreferences(), UserNotLoggedIn::report(), Wikimedia\Rdbms\LoadBalancer::reportConnectionError(), User::resetOptions(), AssembleUploadChunksJob::run(), PublishStashedFileJob::run(), ResourceLoaderModule::saveFileDependencies(), ResourceLoaderImage::sendResponseHeaders(), SpecialPage::setContext(), Article::setContext(), SpecialPageExecutor::setEditTokenFromUser(), ResourceLoaderModule::setFileDependencies(), Article::setOldSubtitle(), LoginSignupSpecialPage::setSessionUserForCurrentRequest(), SpecialMIMESearchTest::setUp(), ActionTest::setUp(), UploadFromUrlTestSuite::setUp(), SimpleCaptcha::shouldCheck(), Article::showRedirectedFromHeader(), SpecialPreferences::showResetForm(), SpecialUploadStash::showUploads(), Preferences::skinPreferences(), SpecialEmailUser::submit(), ChangeTags::tagDescription(), DerivativeResourceLoaderContextTest::testAccessors(), ActionTest::testActionFactory(), ApiMainTest::testApiErrorFormatterCreation(), MWDebugTest::testAppendDebugInfoToApiResultXmlFormat(), ResourceLoaderFileModuleTest::testBomConcatenation(), SpecialPreferencesTest::testBug41337(), ApiMainTest::testCheckConditionalRequestHeaders(), ResourceLoaderImageModuleTest::testContext(), ApiFormatPhpTest::testCrossDomainMangling(), ActionTest::testDisabledAction_isNotResolved(), ApiMainTest::testExceptionErrors(), SpecialWatchlistTest::testFetchOptionsFromRequest(), HTMLRestrictionsFieldTest::testForm(), ActionTest::testGetActionName(), ActionTest::testGetActionName_editredlinkWorkaround(), ActionTest::testGetActionName_historysubmitWorkaround(), ActionTest::testGetActionName_revisiondeleteWorkaround(), ActionTest::testGetActionName_whenCanNotUseWikiPage_defaultsToView(), ResourceLoaderTest::testGetCombinedVersion(), ResourceLoaderWikiModuleTest::testGetContent(), ResourceLoaderWikiModuleTest::testGetContentForRedirects(), ChangesListSpecialPageTest::testGetFilterConflicts(), ResourceLoaderImageTest::testGetImageData(), ResourceLoaderStartUpModuleTest::testGetModuleRegistrations(), ApiBaseTest::testGetParameterFromSettings(), ResourceLoaderImageTest::testGetPath(), ResourceLoaderWikiModuleTest::testGetPreloadedBadTitle(), ResourceLoaderWikiModuleTest::testGetPreloadedTitleInfo(), ResourceLoaderWikiModuleTest::testGetPreloadedTitleInfoEmpty(), ResourceLoaderImageModuleTest::testGetStyleDeclarations(), ResourceLoaderWikiModuleTest::testGetTitleInfo(), ResourceLoaderModuleTest::testGetVersionHash(), ApiPageSetTest::testHandleNormalization(), RequestContextTest::testImportScopedSession(), ResourceLoaderWikiModuleTest::testIsKnownEmpty(), DerivativeResourceLoaderContextTest::testLanguage(), ResourceLoaderTest::testLessFileCompilation(), ResourceLoaderTest::testMakeModuleResponseError(), ResourceLoaderTest::testMakeModuleResponseStartupError(), ActionTest::testNull_defaultsToView(), AbstractChangesListSpecialPageTestCase::testParseParameters(), SpecialSearchTest::testProfileAndNamespaceLoading(), ResourceLoaderStartUpModuleTest::testRegistrationsMinified(), ResourceLoaderStartUpModuleTest::testRegistrationsUnminified(), ApiPageSetTest::testSpecialRedirects(), HTMLReCaptchaNoCaptchaFieldTest::testSubmit(), HTMLSubmittedValueFieldTest::testSubmit(), MediaWikiTest::testTryNormaliseRedirect(), ResourceLoaderModuleTest::testValidateScriptFile(), RequestContextTest::testWikiPageTitle(), Preferences::tryUISubmit(), ResourceFileCache::useFileCache(), HTMLFileCache::useFileCache(), Preferences::watchlistPreferences(), and wfThumbError().

◆ $customAttribs

◆ $differenceEngine

null for the 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 as strings Extensions should add to this list prev or next refreshes the diff cache allow viewing deleted revs& $differenceEngine

Definition at line 1572 of file hooks.txt.

Referenced by ContentHandler::createDifferenceEngine().

◆ $e

div flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Examples
/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 2122 of file hooks.txt.

Referenced by RedisConnRef::__call(), DatabaseTestHelper::__construct(), FakeDatabaseMysqlBase::__construct(), ORAResult::__construct(), SVGReader::__construct(), Wikimedia\Rdbms\LBFactory::__construct(), Wikimedia\Rdbms\LoadBalancer::__construct(), FSFileBackendList::__construct(), MemcachedClient::_flush_read_buffer(), RedisBagOStuff::add(), UploadFromChunks::addChunk(), BackupDumperPageTest::addDBData(), TextPassDumperDatabaseTest::addDBData(), BackupDumperLoggerTest::addDBData(), ApiQueryContinue2Test::addDBDataOnce(), ApiQueryContinueTest::addDBDataOnce(), ApiQueryBasicTest::addDBDataOnce(), FetchTextTest::addDBDataOnce(), MediaWikiPHPUnitTestListener::addError(), MediaWikiPHPUnitTestListener::addFailure(), MediaWikiPHPUnitTestListener::addIncompleteTest(), MediaWikiPHPUnitTestListener::addSkippedTest(), ApiTestCase::apiExceptionHasCode(), SVGMetadataExtractorTest::assertMetadata(), ApiQueryTestBase::assertResult(), MediaWiki\Tidy\Balancer::balance(), GadgetHooks::beforePageDisplay(), Wikimedia\Rdbms\LoadBalancer::beginMasterChanges(), SqlBagOStuff::cas(), RedisBagOStuff::changeTTL(), SqlBagOStuff::changeTTL(), ApiMain::checkConditionalRequestHeaders(), Sqlite::checkSqlSyntax(), CategoryViewer::clearCategoryState(), Wikimedia\Rdbms\LoadBalancer::commitAll(), Wikimedia\Rdbms\LBFactory::commitMasterChanges(), Wikimedia\Rdbms\LoadBalancer::commitMasterChanges(), Maintenance::commitTransaction(), UploadFromChunks::concatenateChunks(), SwiftFileBackend::convertSwiftDate(), Installer::createMainpage(), Preferences::datetimePreferences(), Wikimedia\Rdbms\Database::deadlockLoop(), RedisBagOStuff::delete(), SqlBagOStuff::delete(), Wikimedia\Rdbms\DatabaseMssql::delete(), Article::delete(), SqlBagOStuff::deleteAll(), Wikimedia\Rdbms\DatabaseMssql::deleteJoin(), SqlBagOStuff::deleteObjectsExpiringBefore(), Installer::dirIsExecutable(), profile_point::display(), EditPage::displayViewSourcePage(), JobQueueRedis::doAck(), JobQueueDB::doAck(), BitmapMetadataHandler::doApp13(), Wikimedia\Rdbms\Database::doAtomicSection(), JobQueueFederated::doBatchPush(), JobQueueRedis::doBatchPush(), JobQueueDB::doBatchPushInternal(), JobQueueFederated::doDeduplicateRootJob(), JobQueueRedis::doDeduplicateRootJob(), JobQueueFederated::doDelete(), JobQueueRedis::doDelete(), JobQueueDB::doDelete(), RedisBagOStuff::doGet(), JobQueueDB::doGetAbandonedCount(), JobQueueRedis::doGetAbandonedCount(), JobQueueDB::doGetAcquiredCount(), JobQueueRedis::doGetAcquiredCount(), JobQueueAggregatorRedis::doGetAllReadyWikiQueues(), JobQueueRedis::doGetDelayedCount(), JobQueueFederated::doGetSiblingQueueSizes(), JobQueueRedis::doGetSiblingQueueSizes(), JobQueueFederated::doGetSiblingQueuesWithJobs(), JobQueueDB::doGetSize(), JobQueueRedis::doGetSize(), ImportLinkCacheIntegrationTest::doImport(), SpecialImport::doImport(), JobQueueDB::doIsEmpty(), JobQueueFederated::doIsEmpty(), JobQueueFederated::doIsRootJobOldDuplicate(), JobQueueRedis::doIsRootJobOldDuplicate(), DBFileJournal::doLogChangeBatch(), EventRelayerKafka::doNotify(), TestFileOpPerformance::doPerfTest(), JobQueueDB::doPop(), JobQueueFederated::doPop(), JobQueueRedis::doPop(), MediaWiki::doPostOutputShutdown(), AutoCommitUpdate::doUpdate(), DatabaseInstaller::doUpgrade(), WikiPage::doViewUpdates(), JobQueueFederated::doWaitForBackups(), TextPassDumper::dump(), WikiExporter::dumpFrom(), ApiMain::errorMessagesFromException(), MediaWiki\Logger\Monolog\LineFormatter::exceptionAsArray(), ValidateRegistrationFile::execute(), ApiQueryStashImageInfo::execute(), ApiImport::execute(), ApiUpload::execute(), JSParseHelper::execute(), DeleteArchivedFiles::execute(), InvalidateUserSesssions::execute(), GenerateCommonPassword::execute(), ApiFeedWatchlist::execute(), PPFuzzTester::execute(), GenerateFancyCaptchas::execute(), RefreshImageMetadata::execute(), ZipDirectoryReader::execute(), ApiMain::executeActionWithErrorHandling(), JobRunner::executeJob(), Scribunto_LuaParserFunctionsLibrary::expr(), ExtParserFunctions::expr(), Wikimedia\Rdbms\Database::factory(), DatabaseOracle::fieldInfoMulti(), Preferences::filterTimezoneInput(), TrackBlobs::findOrphanBlobs(), LCStoreDB::finishWrite(), LCStoreCDB::finishWrite(), MediaWiki\Logger\Monolog\LineFormatter::format(), MediaWiki\Logger\Monolog\AvroFormatter::format(), MediaWiki\Logger\LegacyLogger::format(), DeletedContribsPager::formatRow(), ContribsPager::formatRow(), MediaWikiTitleCodec::formatTitle(), RedisLockManager::freeLocksOnServer(), LCStoreCDB::get(), JobQueueRedis::getAllAbandonedJobs(), JobQueueRedis::getAllAcquiredJobs(), JobQueueRedis::getAllDelayedJobs(), MediaWiki\Interwiki\ClassicInterwikiLookup::getAllPrefixesCached(), JobQueueRedis::getAllQueuedJobs(), LocalisationCache::getCompiledPluralRules(), RedisConnectionPool::getConnection(), RedisBagOStuff::getConnection(), JobQueueFederated::getCrossPartitionSum(), ReverseChronologicalPager::getDateCond(), UploadForm::getDescriptionSection(), Status::getErrorMessageArray(), GadgetResourceLoaderModule::getGadget(), MWExceptionRenderer::getHTML(), BmpHandler::getImageSize(), MediaWiki\Interwiki\ClassicInterwikiLookup::getInterwikiCacheEntry(), JobQueueRedis::getJobFromUidInternal(), JobQueueDB::getJobIterator(), Wikimedia\Rdbms\LoadBalancer::getLaggedReplicaMode(), RequestContext::getLanguage(), RedisLockManager::getLocksOnServer(), MWExceptionHandler::getLogContext(), MWExceptionHandler::getLogMessage(), JobQueueDB::getMasterDB(), Wikimedia\Rdbms\DatabaseMysqlBase::getMasterServerInfo(), MimeAnalyzer::getMediaType(), GIFHandler::getMetadata(), PNGHandler::getMetadata(), TiffHandler::getMetadata(), JpegHandler::getMetadata(), SvgHandler::getMetadata(), DjVuHandler::getMetaTree(), ResourceLoaderStartUpModule::getModuleRegistrations(), RedisBagOStuff::getMulti(), SqlBagOStuff::getMulti(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::getPassword(), MediaWikiTitleCodec::getPrefixedDBkey(), MWExceptionHandler::getPublicLogMessage(), MediaWiki\Logger\Monolog\KafkaHandler::getRandomPartition(), MWExceptionHandler::getRedactedTrace(), MWExceptionHandler::getRedactedTraceAsString(), JobQueueDB::getReplicaDB(), SearchEngine::getSearchIndexFields(), JobQueueRedis::getServerQueuesWithJobs(), MWExceptionRenderer::getShowBacktraceError(), NewFilesPager::getStartBody(), MWExceptionHandler::getStructuredExceptionData(), GadgetRepo::getStructuredList(), MWExceptionRenderer::getText(), TextPassDumper::getText(), LocalFile::getThumbnails(), SpecialRandomInCategory::getTimestampOffset(), ContentHandler::getUndoContent(), ParserFuzzTest::guessVarSize(), ApiMain::handleApiBeforeMainException(), MWExceptionHandler::handleError(), RedisConnectionPool::handleError(), MWExceptionHandler::handleException(), RedisBagOStuff::handleException(), ApiMain::handleException(), VersionChecker::handleExtensionDependency(), Wikimedia\Rdbms\Database::handleSessionLoss(), ApiUpload::handleStashException(), ExtParserFunctions::ifexpr(), EditPage::importFormData(), Installer::includeExtensions(), RedisBagOStuff::incr(), SqlBagOStuff::incr(), Wikimedia\Rdbms\DatabaseMssql::insert(), DatabaseOracle::insertOneRow(), DBLockManager::isServerUp(), SiteStats::jobs(), MWExceptionHandler::jsonSerializeException(), DatabaseOracle::lastErrno(), DatabaseOracle::lastError(), Wikimedia\Rdbms\DatabaseSqlite::lastError(), HTMLRestrictionsField::loadDataFromRequest(), MimeAnalyzer::loadFiles(), ExtensionRegistry::loadFromQueue(), ProfilerOutputDb::log(), MWExceptionHandler::logError(), JobQueueFederated::logException(), MWExceptionHandler::logException(), FileOp::logFailure(), ApiMain::logRequest(), FormatMetadata::makeFormattedData(), Wikimedia\Rdbms\LoadBalancer::masterRunningReadOnly(), LocalFile::maybeUpgradeRow(), MediaWiki\Session\SessionProvider::mergeMetadata(), JSMinPlus::min(), MWException::msg(), MWExceptionRenderer::msg(), Wikimedia\Rdbms\DatabaseMssql::nativeInsertSelect(), FSFileBackendList::next(), MediaWiki\Logger\Monolog\LogstashFormatter::normalizeException(), MediaWiki\Logger\Monolog\LineFormatter::normalizeException(), MediaWiki\Logger\Monolog\LineFormatter::normalizeExceptionArray(), MWTimestamp::offsetForUser(), SpecialChangeContentModel::onSubmit(), Wikimedia\Rdbms\Database::onTransactionPreCommitOrIdle(), MysqlInstaller::openConnection(), OracleInstaller::openConnection(), SqliteInstaller::openConnection(), MssqlInstaller::openConnection(), PostgresInstaller::openConnectionWithParams(), Wikimedia\Rdbms\DatabaseSqlite::openFile(), OracleInstaller::openSYSDBAConnection(), MWExceptionRenderer::output(), OutputPage::output(), XMPReader::parse(), Installer::parse(), AjaxDispatcher::performAction(), ApiUpload::performStash(), JobQueue::pop(), PopulateContentModel::populateRevisionOrArchive(), PreprocessDump::processRevision(), MediaWiki\Logger\LegacyLoggerTest::provideInterpolate(), RecentChangesUpdateJob::purgeExpiredRows(), JobQueueGroup::pushLazyJobs(), ApiQueryContinueTestBase::query(), LocalisationUpdate\Updater::readMessages(), Wikimedia\Rdbms\LoadBalancer::reallyOpenConnection(), QueryPage::recache(), Wikimedia\Rdbms\Database::reconnect(), JobQueueDB::recycleAndDeleteStaleJobs(), PoolCounterRedis::release(), PoolCounterRedis::releaseAll(), PostgreSqlLockManager::releaseAllLocks(), MySqlLockManager::releaseAllLocks(), MWExceptionHandler::report(), MWExceptionRenderer::reportHTML(), MWExceptionRenderer::reportOutageHTML(), FSFileBackendList::rewind(), MWExceptionHandler::rollbackMasterChangesAndLog(), TextPassDumper::rotateDb(), AssembleUploadChunksJob::run(), PublishStashedFileJob::run(), ApiQueryWatchlist::run(), RefreshLinksJob::run(), JobRunner::run(), ApiQueryRecentChanges::run(), MediaWiki::run(), MWExceptionRenderer::runHooks(), Wikimedia\Rdbms\LoadBalancer::runMasterPostTrxCallbacks(), Wikimedia\Rdbms\Database::runOnTransactionIdleCallbacks(), Wikimedia\Rdbms\Database::runOnTransactionPreCommitCallbacks(), Wikimedia\Rdbms\Database::runTransactionListenerCallbacks(), DeferredUpdates::runUpdate(), MediaWiki\MediaWikiServices::salvage(), ResourceLoaderModule::saveFileDependencies(), DatabaseOracle::selectDB(), Wikimedia\Rdbms\DatabaseMssql::selectDB(), SamplingStatsdClient::send(), MediaWiki\Logger\Monolog\KafkaHandler::send(), UserMailer::sendInternal(), RedisBagOStuff::set(), LCStoreCDB::set(), VersionChecker::setCoreVersion(), RedisBagOStuff::setMulti(), SqlBagOStuff::setMulti(), MWHttpRequestTestCase::setUp(), JobQueueTest::setUp(), SqliteInstaller::setupDatabase(), PostgresInstaller::setupPLpgSQL(), PostgresInstaller::setupSchema(), MysqlInstaller::setupUser(), PostgresInstaller::setupUser(), MWExceptionRenderer::showBackTrace(), SpecialGadgets::showExportForm(), SpecialUploadStash::showUpload(), SpecialUploadStash::showUploads(), Wikimedia\Rdbms\Database::sourceFile(), MwSql::sqlDoQuery(), WebInstaller::startSession(), LCStoreCDB::startWrite(), MediaWikiTestCase::stashMwGlobals(), SpecialEmailUser::submit(), MssqlInstaller::submitSettingsForm(), MysqlInstaller::submitSettingsForm(), ApiMain::substituteResultWithError(), ApiOptionsTest::testAnon(), ApiMainTest::testAssert(), ApiMainTest::testAssertUser(), UserNotLoggedInTest::testConstruction(), ReadOnlyErrorTest::testConstruction(), ErrorPageErrorTest::testConstruction(), ApiEditPageTest::testEditSection(), BadTitleErrorTest::testExceptionSetsStatusCode(), ThrottledErrorTest::testExceptionSetsStatusCode(), MediaWiki\Auth\ThrottlePreAuthenticationProvider::testForAuthentication(), ResourceLoaderTest::testGetLoadScript(), MWExceptionHandlerTest::testGetRedactedTrace(), DatabaseTest::testGetScopedLock(), MWExceptionTest::testisCommandLine(), MWExceptionTest::testIsLogable(), ApiOptionsTest::testNoChanges(), ApiOptionsTest::testNoOptionname(), ExtensionJsonValidationTest::testPassesValidation(), HtmlCheckMatrixTest::testPlainInstantiation(), MediaWiki\Auth\AuthPluginPrimaryAuthenticationProviderTest::testProviderChangeAuthenticationData(), ErrorPageErrorTest::testReport(), MWExceptionTest::testRunHooks(), WikitextContentHandlerTest::testSerializeContent(), UploadFromUrlTest::testSetupUrlDownload(), ApiQueryTest::testTitlePartToKey(), WikitextContentHandlerTest::testUnserializeContent(), ApiUploadTest::testUpload(), ApiUploadTest::testUploadChunks(), ApiUploadTest::testUploadMissingParams(), ApiUploadTest::testUploadRequiresToken(), ApiUploadTest::testUploadSameContent(), ApiUploadTest::testUploadSameFileName(), ApiUploadTest::testUploadStash(), ApiUploadTest::testUploadZeroLength(), MWExceptionTest::testUseMessageCache(), MWExceptionTest::testUseOutputPage(), JobQueueDB::throwDBException(), JobQueueRedis::throwRedisException(), BitmapHandler::transformImageMagickExt(), MediaWiki::triggerJobs(), JobQueueFederated::tryJobInsertions(), UploadFromChunks::tryStashFile(), Wikimedia\Rdbms\DatabaseMssql::update(), DatabaseOracle::update(), PopulateRevisionSha1::upgradeLegacyArchiveRow(), PopulateRevisionSha1::upgradeRow(), Wikimedia\Rdbms\Database::upsert(), MWExceptionRenderer::useOutputPage(), Language::userAdjust(), HTMLTitleTextField::validate(), TitleBlacklist::validate(), XmlTypeCheck::validateFromInput(), ResourceLoaderModule::validateScriptFile(), PoolCounterRedis::waitForSlotOrNotif(), SpecialEditWatchlist::watchTitles(), wfGenerateThumbnail(), and wfStreamThumb().

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

◆ $engine

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

Referenced by GanConverter::__construct(), ZhConverter::__construct(), KkConverter::__construct(), AutoloadGenerator::__construct(), ParserTestTopLevelSuite::__construct(), ProfilerXhprof::__construct(), GenericArrayObject::__construct(), ApiPageSet::__construct(), LanguageShi::__construct(), LanguageIu::__construct(), LanguageSr::__construct(), MemcachedClient::_load_items(), MemcachedClient::_set(), ApiResult::addContentField(), ApiResult::addContentValue(), ApiResult::addValue(), ApiPageSet::addValues(), ApiErrorFormatter::addWarningOrError(), ConfirmEditHooks::APIGetAllowedParams(), ReCaptcha::APIGetAllowedParams(), MWLBFactory::applyDefaultConfig(), MediaWiki\Auth\AuthManager::autoCreateUser(), JobQueue::batchPush(), SpecialBlock::blockLogFlags(), PPFrame_Hash::cachedExpand(), PPFrame_DOM::cachedExpand(), PPTemplateFrame_Hash::cachedExpand(), PPTemplateFrame_DOM::cachedExpand(), Preprocessor::cacheGetTree(), Preprocessor::cacheSetTree(), MediaWiki\Auth\AuthManager::canCreateAccount(), CentralIdLookup::centralIdFromLocalUser(), CentralIdLookup::centralIdFromName(), CheckStorage::check(), WikiPage::checkFlags(), Article::checkFlags(), TrackBlobs::checkIntegrity(), FileRepo::cleanupBatch(), WikiPage::commitRollback(), CompressOld::compressPage(), Revision::compressRevisionText(), FileRepo::concatenate(), WebPHandler::decodeExtendedChunkHeader(), Revision::decompressRevisionText(), CachedBagOStuff::delete(), StringUtils::delimiterReplace(), StringUtils::delimiterReplaceCallback(), JobQueueFederated::doBatchPush(), JobQueueDB::doBatchPush(), JobQueueRedis::doBatchPush(), JobQueueDB::doBatchPushInternal(), WikiPage::doCreate(), WikiPage::doEditContent(), Article::doEditContent(), CachedBagOStuff::doGet(), MemcachedBagOStuff::doGet(), ReplicatedBagOStuff::doGet(), MultiWriteBagOStuff::doGet(), SqlBagOStuff::doGet(), WikiPage::doModify(), FileBackendStore::doStreamFile(), SwiftFileBackend::doStreamFile(), MockSvgHandler::doTransform(), MockBitmapHandler::doTransform(), TransformationalImageHandler::doTransform(), PdfHandler::doTransform(), DjVuHandler::doTransform(), SvgHandler::doTransform(), SquidPurgeClient::doWrites(), Xhprof::enable(), StorageTypeStats::execute(), DumpRev::execute(), ApiCSPReport::execute(), FixT22757::execute(), ImportImages::execute(), Title::exists(), PPFrame_Hash::expand(), PPFrame_DOM::expand(), Revision::fetchFromConds(), Revision::fetchText(), FileRepo::findFile(), RepoGroup::findFiles(), LocalRepo::findFiles(), FileRepo::findFiles(), BlockLogFormatter::formatBlockFlags(), OldChangesList::formatChangeLine(), ContribsPager::formatRow(), File::generateAndSaveThumb(), File::generateBucketsIfNeeded(), ApiCSPReport::generateLogLine(), BagOStuff::get(), ApiPurge::getAllowedParams(), ApiWatch::getAllowedParams(), ApiImageRotate::getAllowedParams(), ApiSetNotificationTimestamp::getAllowedParams(), ApiFeedWatchlist::getAllowedParams(), ApiQueryLogEvents::getAllowedParams(), ApiQuery::getAllowedParams(), ApiPageSet::getAllowedParams(), Title::getArticleID(), ContentHandler::getAutosummary(), Title::getContentModel(), Title::getEarliestRevTime(), ApiBase::getFinalParams(), Title::getFirstRevision(), ApiCSPReport::getFlags(), DerivativeRequest::getHeader(), WebRequest::getHeader(), ApiQueryGeneratorBase::getHelpFlags(), ApiBase::getHelpFlags(), ApiHelp::getHelpInternal(), HTMLButtonField::getInputHTML(), LogFormatter::getIRCActionText(), Title::getLatestRevID(), Title::getLength(), ReplicatedBagOStuff::getMulti(), Title::getNextRevisionID(), User::getOptions(), Title::getPreviousRevisionID(), Revision::getRecentChange(), Revision::getRevisionText(), UIDGenerator::getSequentialPerNodeIDs(), HistoryBlobStub::getText(), Revision::getTimestampFromId(), SpecialVersion::getVersion(), BagOStuff::getWithSetCallback(), DBAccessObjectUtils::hasFlags(), User::idForName(), User::idFromName(), PPFrame_Hash::implodeWithFlags(), PPFrame_DOM::implodeWithFlags(), CheckStorage::importRevision(), WikiRevision::importUpload(), FSFileBackendList::initIterator(), Revision::insertOn(), EditPage::internalAttemptSave(), Title::isRedirect(), FixT22757::isUnbrokenStub(), User::load(), LocalFile::load(), Revision::loadFromConds(), User::loadFromDatabase(), OldLocalFile::loadFromDB(), LocalFile::loadFromDB(), User::loadFromId(), WikiPage::loadLastEdit(), SimpleCaptcha::loadText(), CentralIdLookup::localUserFromCentralId(), ApiCSPReport::logReport(), LocalIdLookup::lookupCentralIds(), LocalIdLookup::lookupUserNames(), WinCacheBagOStuff::merge(), ReplicatedBagOStuff::merge(), BagOStuff::merge(), SqlBagOStuff::merge(), BagOStuff::mergeViaLock(), moveToExternal(), CentralIdLookup::nameFromCentralId(), Revision::newFromConds(), User::newFromConfirmationCode(), Revision::newFromId(), Title::newFromID(), Revision::newFromPageId(), Revision::newFromTitle(), UIDGenerator::newRawUUIDv4(), UIDGenerator::newSequentialPerNodeID(), UIDGenerator::newSequentialPerNodeIDs(), UIDGenerator::newUUIDv4(), SpecialChangeContentModel::onSubmit(), SpecialUploadStash::outputLocallyScaledThumb(), SpecialUploadStash::outputThumbFromStash(), ConverterRule::parse(), ConverterRule::parseFlags(), JobQueueGroup::pop(), MediaWiki::preOutputCommit(), Preprocessor_Hash::preprocessToObj(), Preprocessor_DOM::preprocessToObj(), Preprocessor_DOM::preprocessToXml(), FileRepo::publish(), LocalFile::publish(), FileRepo::publishBatch(), LocalFile::publishTo(), JobQueue::push(), ChangesList::recentChangesFlags(), ApiResult::removeValue(), resolveStub(), DoubleRedirectJob::run(), MediaWiki\Session\SessionBackend::save(), StreamFile::send404Message(), HTTPFileStreamer::send404Message(), CachedBagOStuff::set(), ReplicatedBagOStuff::set(), MultiWriteBagOStuff::set(), SqlBagOStuff::set(), ApiResult::setContentField(), ApiResult::setContentValue(), ParserDiffTest::setFunctionHook(), ApiResult::setValue(), FileRepo::store(), FileRepo::storeBatch(), StoreBatchTest::storeit(), StreamFile::stream(), HTTPFileStreamer::stream(), ParserTestTopLevelSuite::suite(), EditPageTest::testCreatePage(), EditPageTest::testCreatePageTrx(), WikitextContentHandlerTest::testGetAutosummary(), EditPageTest::testUpdatePage(), EditPageTest::testUpdatePageTrx(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider::testUserExists(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::testUserExists(), File::thumbName(), ForeignAPIFile::transform(), File::transform(), File::transformErrorOutput(), JobQueueFederated::tryJobInsertions(), WANObjectCache::unwrap(), LocalFile::upload(), MediaWiki\Auth\AuthManager::userExists(), DummyLinker::userToolLinks(), and Linker::userToolLinks().

◆ $generateHtml

this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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

◆ $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
inline
Examples
/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 783 of file hooks.txt.

Referenced by EditPage::__construct(), Revision::__construct(), Revision::checkContentModel(), CleanupSpam::cleanupArticle(), MediaWiki\Logger\MonologSpi::createLogger(), FSFileBackend::doCopyInternal(), SwiftFileBackend::doCopyInternal(), FSFileBackend::doCreateInternal(), SwiftFileBackend::doCreateInternal(), FSFileBackend::doDeleteInternal(), SwiftFileBackend::doDeleteInternal(), SwiftFileBackend::doDescribeInternal(), WikiPage::doEditContent(), FSFileBackend::doMoveInternal(), SwiftFileBackend::doMoveInternal(), FSFileBackend::doStoreInternal(), SwiftFileBackend::doStoreInternal(), MovePageForm::doSubmit(), ApiImageRotate::execute(), ApiStashEdit::execute(), ImportImages::execute(), TextPassDumper::exportTransform(), ApiQueryRevisionsBase::extractRevisionInfo(), Article::generateReason(), ContentHandler::getAllContentFormats(), GadgetDefinitionContent::getAssocArray(), ResourceLoaderWikiModule::getContent(), WikiRevision::getContent(), Revision::getContentFormat(), Revision::getContentInternal(), EditPage::getCurrentContent(), FileContentHandler::getDataForSearchIndex(), ContentHandler::getForModelID(), MediaHandlerFactory::getHandler(), MediaWiki\Logger\MonologSpi::getHandler(), SpecialChangeContentModel::getOptionsForTitle(), EditPage::getOriginalContent(), EditPage::getPreloadedContent(), MWFileProps::getPropsFromPath(), SearchEngine::getSearchIndexFields(), WikiPage::getUndoContent(), EditPage::importFormData(), ContentHandler::makeContent(), EditPage::mergeChangesIntoContent(), LogFormatter::newFromEntry(), ImagePage::openShowImage(), SpecialUploadStash::parseKey(), PopulateContentModel::populateRevisionOrArchive(), WikiImporter::processRevision(), ResourceLoaderImage::rasterize(), MediaWikiTestCase::setTemporaryHook(), MediaWiki\Session\SessionManager::setupPHPSessionHandler(), EditPage::showConflict(), MovePageForm::showForm(), MediaWiki\Logger\Monolog\KafkaHandlerTest::testBatchHandlesNullFormatterResult(), ContentHandlerTest::testDataIndexFields(), MediaWiki\Session\PHPSessionHandlerTest::testDisabled(), MediaWiki\Session\PHPSessionHandlerTest::testEnableFlags(), TextContentHandlerTest::testFieldsForIndex(), MediaWiki\Logger\Monolog\KafkaHandlerTest::testGetAvailablePartitionsException(), ResourceLoaderWikiModuleTest::testGetContentForRedirects(), ContentHandlerTest::testGetFieldsForSearchIndex(), ContentHandlerTest::testGetForTitle(), MediaWiki\Session\SessionManagerTest::testGetGlobalSession(), WebPHandlerTest::testGetImageSize(), ContentHandlerTest::testGetModelForID(), ContentHandlerTest::testGetPageLanguage(), MediaWiki\Logger\Monolog\KafkaHandlerTest::testHandlesNullFormatterResult(), BitmapScalingTest::testImageArea(), JsonContentHandlerTest::testMakeEmptyContent(), ContentHandlerSanityTest::testMakeEmptyContent(), BitmapScalingTest::testNormaliseParams(), BitmapMetadataHandlerTest::testPNGNative(), BitmapMetadataHandlerTest::testPNGXMP(), MediaWiki\Session\SessionBackendTest::testResetIdOfGlobalSession(), MediaWiki\Logger\Monolog\KafkaHandlerTest::testSendException(), MediaWiki\Session\PHPSessionHandlerTest::testSessionHandling(), ContentHandlerTest::testSupportsCategories(), TextContentHandlerTest::testSupportsDirectEditing(), ContentHandlerTest::testSupportsDirectEditing(), MediaWiki\Session\SessionBackendTest::testTakeOverGlobalSession(), BitmapMetadataHandlerTest::testTiffByteOrder(), BitmapScalingTest::testTooBigImage(), BitmapScalingTest::testTooBigMustRenderImage(), MediaWiki\Logger\Monolog\KafkaHandlerTest::testTopicNaming(), MediaWiki\Session\SessionBackendTest::testUnpersistOfGlobalSession(), MediaWiki\Session\PHPSessionHandlerTest::testWrongInstance(), TraditionalImageGallery::toHTML(), and wfExtractThumbParams().

◆ $handlerParams

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

Referenced by GeSHi::__construct(), ImageGalleryBase::add(), CachedAction::addCachedHTML(), MathCaptcha::addCaptchaAPI(), WebInstallerOutput::addHTML(), WebInstallerOutput::addHTMLNoFlush(), MediaWikiTestCase::assertValidHtmlDocument(), MediaWikiTestCase::assertValidHtmlSnippet(), BenchmarkTidy::benchmark(), MediaWiki\Linker\LinkRenderer::buildAElement(), SpecialEditTags::buildCheckBoxes(), SpecialRevisionDelete::buildCheckBoxes(), Linker::buildRollbackLink(), HTMLForm::displaySection(), WebInstallerInstall::endStage(), BenchmarkTidy::execute(), ApiHelp::execute(), SpecialTrackingCategories::execute(), SpecialPageExecutor::executeSpecialPage(), ApiFeedContributions::feedItemDesc(), MathCaptcha::fetchMath(), TextContent::fillParserOutput(), ApiHelp::fixHelpLinks(), OldChangesList::formatChangeLine(), FeedUtils::formatDiffRow(), HTMLMultiSelectField::formatOptions(), HTMLRadioField::formatOptions(), SpecialGadgetUsage::formatResult(), HTMLForm::formatSection(), MediaWiki\Widget\Search\FullSearchResultWidget::generateFileHtml(), CategoryViewer::generateLink(), LogEventsList::getActionSelector(), BaseTemplate::getAfterPortlet(), PreferencesForm::getButtons(), EditPage::getCheckboxesOOUI(), SpecialVersion::getCreditsForExtension(), MWDebug::getDebugHTML(), HTMLFormField::getDiv(), Title::getEditNotices(), BaseTemplate::getFooter(), ApiHelp::getHelp(), WebInstaller::getHelpBox(), HTMLForm::getHiddenFields(), JavaScriptContent::getHtml(), CssContent::getHtml(), QuickTemplate::getHTML(), MWExceptionRenderer::getHTML(), HTMLForm::getHTML(), SpecialPageExecutor::getHTMLFromSpecialPage(), HTMLFormField::getInline(), HTMLSizeFilterField::getInputHTML(), HTMLFancyCaptchaField::getInputHTML(), HTMLRadioField::getInputHTML(), HTMLMultiSelectField::getInputHTML(), HTMLCheckMatrix::getInputHTML(), HTMLFormFieldCloner::getInputHTML(), HTMLFormFieldCloner::getInputHTMLForKey(), HTMLFormField::getLabelHtml(), SkinTemplateTest::getMockOutputPage(), LoginSignupSpecialPage::getPageHtml(), MessageContent::getParserOutput(), SkinTemplate::getPersonalToolsList(), HTMLFormField::getRaw(), Article::getRedirectHeaderHtml(), HTMLCheckMatrix::getTableRow(), HTMLFormField::getTableRow(), BaseTemplate::getTrail(), ForeignAPIRepo::httpGetCached(), ImageGalleryBase::insert(), Xml::isWellFormedXmlFragment(), DummyLinker::link(), Linker::link(), DummyLinker::linkKnown(), Linker::linkKnown(), Skin::makeFooterIcon(), DummyLinker::makeHeadline(), BaseTemplate::makeLink(), BaseTemplate::makeListItem(), DummyLinker::makeMediaLinkFile(), Linker::makeMediaLinkFile(), DummyLinker::makeMediaLinkObj(), Linker::makeMediaLinkObj(), LogFormatter::makePageLink(), DummyLinker::makeSelfLinkObj(), Linker::makeSelfLinkObj(), ConfirmEditHooks::onAlternateEditPreview(), MediaWiki\Widget\Search\SearchFormWidget::optionsHtml(), CologneBlueTemplate::otherLanguages(), SpecialGadgetUsage::outputResults(), QueryPage::outputResults(), SpecialGadgetUsage::outputTableStart(), Installer::parse(), GeSHi::parse_code(), SpecialJavaScriptTest::plainQUnit(), BalancerTest::provideBalancerTests(), OldChangesList::recentChangesLine(), LogFormatterTestCase::removeSomeHtml(), MediaWiki\Widget\Search\DidYouMeanWidget::render(), MediaWiki\Widget\Search\FullSearchResultWidget::render(), CologneBlueTemplate::renderAfterPortlet(), MWExceptionRenderer::reportOutageHTML(), Linker::revDeleteLink(), Linker::revDeleteLinkDisabled(), MediaWiki\Linker\LinkRenderer::runLegacyBeginHook(), MediaWiki\Widget\Search\SearchFormWidget::shortDialogHtml(), WebInstaller::showHelpBox(), FileDuplicateSearchPage::showList(), WebInstaller::showMessage(), LogEventsList::showOptions(), SpecialTags::showTagList(), EnhancedChangesListTest::testBeginRecentChangesList_html(), EnhancedChangesListTest::testCategorizationLineFormatting(), EnhancedChangesListTest::testCategorizationLineFormattingWithRevision(), SpecialEditWatchlistTest::testClearPage_hasClearButtonForm(), SpecialEditWatchlistTest::testEditRawPage_hasTitlesBox(), EnhancedChangesListTest::testEndRecentChangesList(), SpecialBooksourcesTest::testExecute(), HTMLFancyCaptchaFieldTest::testGetHTML(), 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(), ParserTestPrinter::wellFormed(), VFormHTMLForm::wrapForm(), OOUIHTMLForm::wrapForm(), HTMLForm::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
inline

Definition at line 783 of file hooks.txt.

Referenced by ApiQueryImageInfo::checkParameterNormalise(), MockBitmapHandler::doClientImage(), MockImageHandler::doFakeTransform(), MockBitmapHandler::doTransform(), MockSvgHandler::doTransform(), MockDjVuHandler::doTransform(), BitmapHandler_ClientOnly::doTransform(), TransformationalImageHandler::doTransform(), PdfHandler::doTransform(), DjVuHandler::doTransform(), SvgHandler::doTransform(), InitSiteStats::execute(), ImportImages::execute(), UploadDumper::fetchUsed(), RepoGroup::findFile(), RepoGroup::findFiles(), GIFHandler::formatMetadata(), PNGHandler::formatMetadata(), ExifBitmapHandler::formatMetadata(), PdfHandler::formatMetadata(), TransformationalImageHandler::getClientScalingThumbnailImage(), GIFHandler::getCommonMetaArray(), PNGHandler::getCommonMetaArray(), DjVuHandler::getDjVuImage(), ResourceLoaderImageModule::getFileHashes(), GIFHandler::getImageArea(), ImageHandler::getImageArea(), ResourceLoaderImageModuleTest::getImageMock(), ResourceLoaderImageModule::getImages(), ExifBitmapHandler::getImageSize(), PdfHandler::getImageSize(), DjVuHandler::getImageSize(), PNGHandler::getLongDesc(), GIFHandler::getLongDesc(), PdfHandler::getMetaArray(), PdfHandler::getMetadata(), DjVuHandler::getMetadata(), DjVuHandler::getMetaTree(), SearchNearMatcher::getNearMatchInternal(), MediaHandler::getPageDimensions(), PdfHandler::getPdfImage(), ImageHandler::getScriptedTransform(), ResourceLoaderImageModule::getStyleDeclarations(), ResourceLoaderImageModule::getStyles(), MediaHandler::getTransform(), PNGHandler::isAnimatedImage(), GIFHandler::isAnimatedImage(), WebPHandler::isAnimatedImage(), SpecialNuke::listForm(), ApiQueryImageInfo::mergeThumbParams(), JpegHandler::normaliseParams(), BitmapHandler_ClientOnly::normaliseParams(), TransformationalImageHandler::normaliseParams(), ImageHandler::normaliseParams(), BitmapHandler::normaliseParams(), SvgHandler::normaliseParams(), ConfirmEditHooks::onTitleReadWhitelist(), ImageMap::render(), ApiQueryDuplicateFiles::run(), ResourceLoaderImageTest::testGetExtension(), ResourceLoaderImageTest::testGetImageData(), ResourceLoaderImageTest::testGetPath(), ResourceLoaderImageModuleTest::testGetStyleDeclarations(), 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 my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled $incrBy

Definition at line 2536 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 Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 please use GetContentModels hook to make them known to core 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 1049 of file hooks.txt.

Referenced by ApiResult::addParsedLimit(), Maintenance::adjustMemoryLimit(), Wikimedia\Rdbms\LoadBalancer::approveMasterChanges(), IndexPager::buildQueryInfo(), buildSearchEngine(), ImageListPager::combineResult(), Title::countAuthorsBetween(), PrefixSearch::defaultSearchBackend(), DBFileJournal::doGetChangeEntries(), SpecialRecentChangesLinked::doMainQuery(), WikiPage::doUpdateRestrictions(), Article::doUpdateRestrictions(), Installer::envCheckMemory(), SpecialNuke::execute(), ApiQueryTags::execute(), ApiQueryDeletedrevs::execute(), ApiQueryFilearchive::execute(), SpecialExport::execute(), ApiFeedContributions::execute(), UpdateSpecialPages::execute(), ApiQueryLogEvents::execute(), ApiQueryPagePropNames::execute(), ApiQueryContributions::execute(), ApiQueryAllUsers::execute(), GenerateCommonPassword::execute(), ImportImages::execute(), ApiBase::explodeMultiValue(), ApiQueryInfo::extractPageInfo(), IndexPager::extractResultInfo(), HistoryAction::feed(), SpecialNewpages::feed(), HistoryAction::fetchRevisions(), DiffEngine::find_middle_snake(), LocalRepo::findFilesByPrefix(), DiffEngine::findMostProgress(), User::findUsersByGroup(), WikiPage::flattenRestrictions(), Title::getAuthorsBetween(), FileJournal::getChangeEntries(), SwiftFileBackend::getDirListPageInternal(), SwiftFileBackend::getFileListPageInternal(), LocalFile::getHistory(), IndexPager::getLimitLinks(), WebRequest::getLimitOffset(), TablePager::getLimitSelectList(), HashRing::getLiveLocations(), HashRing::getLocations(), Category::getMembers(), DifferenceEngine::getMultiNotice(), SpecialNuke::getNewPages(), SpecialWhatLinksHere::getPrevNext(), Title::getSubpages(), Pingback::getSystemInfo(), WANCacheReapUpdate::getTitleChangeEvents(), WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo(), PrefixSearch::handleResultFromHook(), ImagePage::imageLinks(), Article::insertProtectNullRevision(), DifferenceEngine::intermediateEditsMsg(), Wikimedia\Rdbms\DatabaseMssql::limitResult(), Wikimedia\Rdbms\Database::limitResult(), SpecialNuke::listForm(), Preprocessor_DOM::memCheck(), Maintenance::memoryLimit(), Language::numLink(), SwiftFileBackend::objectListing(), SpecialRecentChanges::outputChangesList(), PurgeChangedPages::pageableSortedRows(), SwiftFileBackendDirList::pageFromList(), SwiftFileBackendFileList::pageFromList(), Wikimedia\Rdbms\DatabasePostgres::pg_array_parse(), User::pingLimiter(), SpecialPage::prefixSearchArray(), SpecialPage::prefixSearchString(), SpecialCiteThisPage::prefixSearchSubpages(), SpecialListFiles::prefixSearchSubpages(), SpecialUnblock::prefixSearchSubpages(), SpecialPageLanguage::prefixSearchSubpages(), SpecialRecentChangesLinked::prefixSearchSubpages(), SpecialChangeContentModel::prefixSearchSubpages(), SpecialPrefixindex::prefixSearchSubpages(), SpecialNuke::prefixSearchSubpages(), SpecialAllPages::prefixSearchSubpages(), SpecialRenameuser::prefixSearchSubpages(), SpecialPage::prefixSearchSubpages(), SpecialEmailUser::prefixSearchSubpages(), SpecialWhatLinksHere::prefixSearchSubpages(), SpecialContributions::prefixSearchSubpages(), MovePageForm::prefixSearchSubpages(), UserrightsPage::prefixSearchSubpages(), SpecialBlock::prefixSearchSubpages(), SpecialUndelete::prefixSearchSubpages(), Article::protectDescription(), WikiPage::protectDescription(), Article::protectDescriptionLog(), WikiPage::protectDescriptionLog(), ImagePage::queryImageLinks(), DeletedContribsPager::reallyDoQuery(), ContribsPager::reallyDoQuery(), AllMessagesTablePager::reallyDoQuery(), ImageListPager::reallyDoQuery(), IndexPager::reallyDoQuery(), MagicWord::replace(), SearchExactMatchRescorer::rescore(), ApiQueryPrefixSearch::run(), ApiQueryExtLinksUsage::run(), ApiQuerySearch::run(), ApiQueryPagesWithProp::run(), ApiQueryCategoryMembers::run(), ApiQueryAllPages::run(), ApiQueryAllImages::run(), ApiQueryAllLinks::run(), ApiQueryRandom::runQuery(), ExtParserFunctions::runReplace(), UserNamePrefixSearch::search(), PrefixSearch::search(), PrefixSearch::searchBackend(), SearchEnginePrefixTest::searchProvision(), PrefixSearchTest::searchProvision(), PrefixSearch::searchWithVariants(), IndexPager::setLimit(), SpecialWhatLinksHere::showIndirectLinks(), SearchSuggestionSet::shrink(), PrefixSearch::specialSearch(), SyncFileBackend::syncBackends(), WatchedItemStoreUnitTest::testCountUnreadNotifications_withUnreadLimit_overLimit(), WatchedItemStoreUnitTest::testCountUnreadNotifications_withUnreadLimit_underLimit(), MergeHistoryTest::testIsValidMergeRevisionLimit(), PrefixSearch::titleSearch(), ApiBase::truncateArray(), Article::updateRestrictions(), and Language::viewPrevNext().

◆ $link

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

Definition at line 2929 of file hooks.txt.

Referenced by LinksUpdate::__construct(), ImageGalleryBase::add(), OutputPage::addHelpLink(), OutputPage::addReturnTo(), Skin::addToSidebarPlain(), RCCacheEntryFactoryTest::assertQueryLink(), SkinTemplate::buildContentNavigationUrls(), OutputPage::buildCssLinksArray(), ProtectionForm::buildForm(), SpecialEditWatchlist::buildRemoveLine(), Article::confirmDelete(), DifferenceEngine::deletedIdMarker(), MovePageForm::doSubmit(), SpecialRenameuser::execute(), SpecialApiHelp::execute(), VectorTemplate::execute(), DumpLinks::execute(), SpecialNewpages::filterLinks(), ShiConverter::findVariantLink(), SrConverter::findVariantLink(), IuConverter::findVariantLink(), KuConverter::findVariantLink(), StubUserLang::findVariantLink(), KkConverter::findVariantLink(), Language::findVariantLink(), Linker::formatAutocomments(), ApiParse::formatCategoryLinks(), DateFormatter::formatDate(), ApiParse::formatLangLinks(), AncientPagesPage::formatResult(), MostcategoriesPage::formatResult(), MostinterwikisPage::formatResult(), MostlinkedPage::formatResult(), DeletedContribsPager::formatRevisionRow(), SpecialProtectedtitles::formatRow(), CategoryPager::formatRow(), ContribsPager::formatRow(), ImageListPager::formatValue(), CategoryViewer::generateLink(), MediaWiki\Widget\Search\FullSearchResultWidget::generateMainLinkHtml(), Skin::getCategoryLinks(), CreditsAction::getContributors(), Skin::getCopyright(), SpecialUndelete::getFileComment(), SpecialUndelete::getFileLink(), SpecialUndelete::getFileUser(), LogEventsList::getFilterLinks(), BaseTemplate::getFooterLinks(), OutputPage::getHeadLinksArray(), ApiHelp::getHelpInternal(), EnhancedChangesList::getLineData(), RevDelArchivedFileItem::getLink(),