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	$status = Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, 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. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any)

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

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction 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 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

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

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

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

namespace and then decline to actually register it &	$namespaces

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

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

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

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

do that in ParserLimitReportFormat instead	$parser

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

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction 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

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction 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

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

also included in $newHeader	$rollback

the value to return A Title object or null for latest all implement SearchIndexField must implement ResultSetAugmentor &	$rowAugmentors

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction	$rows

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

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

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

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

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

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

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid	bugs

it s the revision text itself In either	case

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff 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

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction 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

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

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults	error

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

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

how to add hooks for an	event

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

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

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

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

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

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

div &	lt

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

hooks txt This document describes how event hooks work in	MediaWiki

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

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

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

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

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

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

◆ $status

return $status

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

Function Documentation

◆ addExtraTypes()

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

◆ array() [1/2]

the array ( )

Referenced by ReverseArrayIterator::__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(), OutputPage::addBodyClasses(), 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(), ApiResult::applyTransformations(), ApiErrorFormatter::arrayFromStatus(), ApiQueryWatchlistIntegrationTest::assertArraySubsetsEqual(), MWHttpRequestTestCase::assertResponseFieldValue(), LinksDeletionUpdate::batchDeleteByPK(), PHPVersionCheck::checkExtensionExistence(), LocalRepo::checkRedirect(), ApiBase::checkTitleUserPermissions(), ApiBase::checkUserRightsAny(), ProcessCacheLRU::clear(), MapCacheLRU::clear(), ResourceLoaderFileModule::collateFilePathListByOption(), UpdateLogging::copyExactMatch(), ReverseArrayIterator::count(), User::createNew(), ReverseArrayIterator::current(), CommentStore::decodeMessage(), MemcachedClient::disconnect_all(), RecompressTracked::dispatchToReplica(), FSFileBackend::doCopyInternal(), SwiftFileBackend::doCopyInternal(), FSFileBackend::doCreateInternal(), SwiftFileBackend::doCreateInternal(), FSFileBackend::doDeleteInternal(), SwiftFileBackend::doDeleteInternal(), SwiftFileBackend::doDescribeInternal(), WikiPage::doEditContent(), DBFileJournal::doGetChangeEntries(), FSFileBackend::doMoveInternal(), SwiftFileBackend::doMoveInternal(), GenderCache::doQuery(), UserrightsPage::doSaveUserGroups(), FSFileBackend::doStoreInternal(), SwiftFileBackend::doStoreInternal(), FileBackendTest::doTestGetFileContents(), FileBackendTest::doTestGetLocalCopy(), FileBackendTest::doTestGetLocalReference(), TextPassDumper::endElement(), ApiBase::errorArrayToStatus(), ApiProtect::execute(), ApiQueryAllMessages::execute(), ApiQueryBlocks::execute(), ApiQueryLangLinks::execute(), ApiQueryIWLinks::execute(), PurgeModuleDeps::execute(), ApiParse::execute(), CleanupRemovedModules::execute(), ApiUserrights::execute(), ApiFeedWatchlist::execute(), ApiQueryUsers::execute(), JSParser::Expression(), ExtensionProcessor::extractMessagesDirs(), WebRequest::extractTitle(), UploadStash::fetchFileMetadata(), 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(), MediaWiki\Interwiki\ClassicInterwikiLookup::getAllPrefixesDB(), WebRequest::getArray(), Title::getAuthorsBetween(), OOUIHTMLForm::getButtons(), VFormHTMLForm::getButtons(), HTMLForm::getButtons(), ApiQueryUsers::getCacheMode(), ApiQueryInfo::getCacheMode(), CommentStore::getCommentInternal(), LocalisationUpdate\Finder::getComponents(), SiteConfiguration::getConfig(), Wikimedia\Rdbms\LoadBalancer::getConnection(), SpamBlacklist::getCurrentLinks(), ForeignDBFile::getDescriptionText(), File::getDescriptionText(), MediaWikiTestCase::getExternalStoreDatabaseConnections(), FileContentsHasher::getFileContentsHash(), ResourceLoaderModule::getFileDependencies(), GadgetDefinitionNamespaceRepo::getGadget(), GadgetDefinitionNamespaceRepo::getGadgetIds(), Language::getGenderNsText(), MWGrants::getGrantRights(), TablePager::getHiddenFields(), SpecialUpload::getInitialPageText(), HTMLCheckMatrix::getInputHTML(), HTMLAutoCompleteSelectField::getInputHTML(), HTMLFormFieldCloner::getInputHTML(), ResourceLoaderClientHtml::getLoad(), ApiParamInfo::getModuleInfo(), WANObjectCache::getMulti(), Language::getNamespaceAliases(), ParserOutput::getOutputHooks(), ApiBase::getParameterFromSettings(), PHPVersionCheck::getPHPInfo(), FormatMetadata::getPriorityLanguages(), MWNamespace::getRestrictionLevels(), ApiResult::getResultData(), ExternalStoreDB::getSlave(), ConverterRule::getTextInBidtable(), ConvertExtensionToRegistration::handleMessagesDirs(), Language::hebrewNumeral(), RequestContext::importScopedSession(), User::inDnsBlacklist(), JSTokenizer::init(), FileRepo::initZones(), Wikimedia\Rdbms\Database::insertSelect(), ExternalStore::insertToDefault(), Title::isNamespaceProtected(), MediaWikiTestCase::isUsingExternalStoreDB(), Block::isWhitelistedFromAutoblocks(), SiteStats::jobs(), ReverseArrayIterator::key(), LogPager::limitType(), Linker::link(), SpecialVersion::listAuthors(), ChangeTags::listExplicitlyDefinedTags(), ChangeTags::listSoftwareActivatedTags(), ChangeTags::listSoftwareDefinedTags(), MessageCache::load(), MediaWiki\Interwiki\ClassicInterwikiLookup::load(), ApiAuthManagerHelper::loadAuthenticationRequests(), LocalFile::loadFromCache(), User::loadFromCache(), MediaWiki\Auth\AuthenticationRequest::loadFromSubmission(), Title::loadRestrictions(), MediaWiki\Auth\LegacyHookPreAuthenticationProvider::makeFailResponse(), LogEntryBase::makeParamBlob(), OutputPage::makeResourceLoaderLink(), ApiMain::markParamsSensitive(), ApiMain::markParamsUsed(), EditPage::matchSpamRegex(), EditPage::matchSummarySpamRegex(), MigrateComments::migrate(), JavaScriptMinifier::minify(), ChangeTags::modifyDisplayQuery(), UserArray::newFromIDs(), UserArray::newFromNames(), Revision::newKnownCurrent(), ReverseArrayIterator::next(), SiteStats::numberingroup(), InterwikiHooks::onInterwikiLoadPrefix(), Html::openElement(), JSMinPlus::parseTree(), ApiResult::path(), ResourceLoaderWikiModule::preloadTitleInfo(), SpecialUpload::processVerificationError(), JobTest::provideTestJobFactory(), TextPassDumper::readDump(), ShortPagesPage::reallyDoQuery(), QueryPage::reallyDoQuery(), LocalisationCache::recache(), ApiResult::removeValue(), ReverseArrayIterator::rewind(), ApiQueryPrefixSearch::run(), ApiQueryWatchlistRaw::run(), ApiQueryCategories::run(), ApiQueryBacklinks::run(), MemcachedClient::run_command(), TableCleanup::runTable(), ApiQueryBase::select(), Wikimedia\Rdbms\Database::selectRow(), Wikimedia\Rdbms\Database::selectSQLText(), DatabaseTestHelper::setExistingTables(), ApiResult::setPreserveKeysList(), ApiResult::setSubelementsList(), SpecialInterwiki::showList(), LogEventsList::showLogExtract(), LogEventsList::showOptions(), OutputPage::showPermissionsErrorPage(), JSParser::Statement(), ApiResult::stripMetadata(), ApiResult::stripMetadataNonRecursive(), UpdateLogging::sync(), DatabaseTestHelper::tableExists(), Wikimedia\Rdbms\Database::tableNamesWithIndexClauseOrJOIN(), ChangeTags::tagUsageStatistics(), ResourceLoaderTest::testGetModuleFactory(), WANObjectCacheTest::testGetMultiWithSetCallback(), WANObjectCacheTest::testGetMultiWithUnionSetCallback(), TitleTest::testIsValidMoveOperation(), ExportTest::testPageByTitle(), LocalisationCacheTest::testRecacheFallbacksWithHooks(), SpecialSearchTest::testRewriteQueryWithSuggestion(), MediaWiki\Session\SessionBackendTest::testSave(), ImportTest::testSiteInfoContainsNamespaces(), TitleTest::testWgWhitelistReadRegexp(), HTMLForm::trySubmit(), Wikimedia\Rdbms\Database::unionConditionPermutations(), LocalFile::unprefixRow(), ApiResult::unsetPreserveKeysList(), ApiResult::unsetSubelementsList(), ChangeTags::updateTags(), ReverseArrayIterator::valid(), ApiResult::validateValue(), 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 )

Referenced by Wikimedia\Rdbms\ConnectionManager::__construct(), ActiveUsersPager::__construct(), GenerateCollationData::generateFirstChars(), Wikimedia\Rdbms\ConnectionManager::getConnection(), Wikimedia\Rdbms\ConnectionManager::getConnectionRef(), ActiveUsersPager::getQueryInfo(), Wikimedia\Rdbms\ConnectionManager::getReadConnection(), and Wikimedia\Rdbms\ConnectionManager::getReadConnectionRef().

◆ if()

if ( $wgReverseTitle )

Definition at line 58 of file hooks.txt.

References $article.

◆ ldapLogin()

function ldapLogin	(	$username,
		$password
	)

Definition at line 192 of file hooks.txt.

◆ options()

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

Referenced by CleanupEmptyCategories::__construct(), PopulateCategory::__construct(), MediaWiki\Logger\Monolog\KafkaHandler::__construct(), FormOptions::add(), MediaWiki\Logger\Monolog\KafkaHandler::addMessages(), XmlSelect::addOption(), ApiQueryBase::addOption(), XmlSelect::addOptions(), BatchRowIterator::addOptions(), ApiQueryBase::addWhereRange(), CompareParsers::checkOptions(), FormOptions::consumeValue(), FormOptions::consumeValues(), FormOptions::delete(), SpecialBlockList::execute(), FormOptions::fetchValuesFromRequest(), FormOptions::getAllValues(), SpecialBlockList::getBlockListPager(), FormOptions::getChangedValues(), XmlSelect::getHTML(), ParserOptions::getOption(), FormOptions::getUnconsumedValues(), FormOptions::getValue(), ParserOptions::initialiseFromUser(), ParserOptions::isSafeToCache(), ParserOptions::matches(), BatchRowIterator::next(), FormOptions::offsetExists(), CompareParsers::processRevision(), FormOptions::reset(), ApiQueryBase::resetQueryParams(), ApiQueryBase::select(), ParserOptions::setOption(), ParserOptions::setOptionLegacy(), ExtraParserTest::setUp(), FormOptions::setValue(), UserOptions::showUsageAndExit(), HtmlAutoCompleteSelectFieldTest::testGetAttributes(), ExtraParserTest::testGetPreloadText(), ExtraParserTest::testParse(), ExtraParserTest::testPreprocess(), ExtraParserTest::testPreSaveTransform(), XmlSelectTest::testSetDefaultAfterAddingOptions(), ExtraParserTest::testTrackingCategory(), ExtraParserTest::testTrackingCategorySpecial(), FormOptions::validateBounds(), FormOptions::validateName(), and MediaWiki\Logger\Monolog\KafkaHandler::warning().

◆ 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

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 244 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 change it to an object instance and return false override the list derivative used the name of the old file & $article

Initial value:

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

Definition at line 77 of file hooks.txt.

Referenced by ProtectionForm::__construct(), EditPage::__construct(), EditPageTest::assertEdit(), Orphans::checkSeparation(), TitleBlacklistHooks::clearBlacklist(), CategoryViewer::columnList(), SpecialNuke::doDelete(), WikiEditorHooks::doEventLogging(), WikiEditorHooks::editPageAttemptSave(), WikiEditorHooks::editPageAttemptSaveAfter(), WikiEditorHooks::editPageShowEditFormInitial(), ApiParse::execute(), RebuildFileCache::execute(), follows(), ParserCache::get(), BaseBlacklist::getArticleText(), ParserCache::getDirty(), ParserCache::getETag(), ParserCache::getKey(), ParserCache::getParserOutputKey(), ListredirectsPage::getRedirectTarget(), if(), MediaWiki::initializeArticle(), Article::newFromWikiPage(), SpamBlacklistHooks::onArticleDelete(), GadgetHooks::onPageContentSaveComplete(), RenameuserHooks::onShowMissingArticle(), MediaWiki::performRequest(), DoubleRedirectJob::run(), CategoryFinder::run(), EditPageTest::testCheckDirectEditingDisallowed_forNonTextContent(), TitleTest::testExists(), and PageArchive::undeleteRevisions().

◆ $attribs

either a unescaped string or a HtmlArmor object & $attribs

Definition at line 1965 of file hooks.txt.

◆ $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 change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped true if there is text before this autocomment $auto

Definition at line 1472 of file hooks.txt.

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

◆ $changesList

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

Definition at line 1472 of file hooks.txt.

Referenced by ChangesList::getArticleLink(), OldChangesListTest::testRecentChangesLine_prefix(), and EnhancedChangesListTest::testRecentChangesPrefix().

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

◆ $colours

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

Definition at line 1639 of file hooks.txt.

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

◆ $context

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow (e.g. with the RejectParserCacheValue hook) because MediaWiki won't do it for you. &$defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context

Definition at line 2581 of file hooks.txt.

◆ $customAttribs

null means default & $customAttribs

Definition at line 1965 of file hooks.txt.

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

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

Definition at line 2141 of file hooks.txt.

◆ $editor

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

Definition at line 1265 of file hooks.txt.

Referenced by TestFileEditor::edit(), ConfirmEditHooks::onAlternateEditPreview(), EnotifNotifyJob::run(), RecentChange::save(), EditAction::show(), WatchedItemStore::updateNotificationTimestamp(), and TitleBlacklistHooks::validateBlacklist().

◆ $engine

the value to return A Title object or null for latest all implement SearchIndexField $engine

Definition at line 2834 of file hooks.txt.

Referenced by ContentHandler::addSearchField(), ApiQueryRevisionsBase::extractRevisionInfo(), WikitextContentHandler::getDataForSearchIndex(), TextContentHandler::getDataForSearchIndex(), ContentHandler::getDataForSearchIndex(), FileContentHandler::getFieldsForSearchIndex(), WikitextContentHandler::getFieldsForSearchIndex(), TextContentHandler::getFieldsForSearchIndex(), ContentHandler::getFieldsForSearchIndex(), DummySearchIndexFieldDefinition::getMapping(), PageArchive::listPagesBySearch(), ParserFunctionsHooks::onScribuntoExternalLibraries(), ApiOpenSearchTest::replaceSearchEngine(), TitleBlacklistHooks::scribuntoExternalLibraries(), ContentHandlerTest::testDataIndexFields(), ApiOpenSearchTest::testGetAllowedParams(), and SearchEngineTest::testSearchIndexFields().

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

Referenced by Wikimedia\Rdbms\DBConnRef::__call(), 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(), Preprocessor::cacheGetTree(), Preprocessor::cacheSetTree(), MediaWiki\Auth\AuthManager::canCreateAccount(), CentralIdLookup::centralIdFromLocalUser(), CentralIdLookup::centralIdFromName(), CentralIdLookup::centralIdsFromNames(), 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(), JobQueueSecondTestQueue::doBatchPush(), 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(), MockBitmapHandler::doTransform(), MockSvgHandler::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(), 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(), Wikimedia\Rdbms\LoadBalancer::getConnection(), Wikimedia\Rdbms\LoadBalancer::getConnectionRef(), 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(), Wikimedia\Rdbms\LoadBalancer::getLazyConnectionRef(), Title::getLength(), Wikimedia\Rdbms\LoadBalancer::getMaintenanceConnectionRef(), ReplicatedBagOStuff::getMulti(), Title::getNextRevisionID(), User::getOptions(), Title::getPreviousRevisionID(), Revision::getRecentChange(), Title::getRelativeRevisionID(), Revision::getRevisionText(), UIDGenerator::getSequentialPerNodeIDs(), HistoryBlobStub::getText(), Revision::getTimestampFromId(), SpecialVersion::getVersion(), BagOStuff::getWithSetCallback(), DBAccessObjectUtils::hasFlags(), User::idForName(), User::idFromName(), 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(), CentralIdLookup::namesFromCentralIds(), Revision::newFromConds(), User::newFromConfirmationCode(), Revision::newFromId(), Title::newFromID(), Revision::newFromPageId(), Revision::newFromTitle(), UIDGenerator::newRawUUIDv4(), UIDGenerator::newSequentialPerNodeID(), UIDGenerator::newSequentialPerNodeIDs(), UIDGenerator::newUUIDv4(), SpecialChangeContentModel::onSubmit(), Wikimedia\Rdbms\LoadBalancer::openConnection(), Wikimedia\Rdbms\LoadBalancer::openForeignConnection(), SpecialUploadStash::outputLocallyScaledThumb(), SpecialUploadStash::outputThumbFromStash(), ConverterRule::parse(), ConverterRule::parseFlags(), JobQueueGroup::pop(), MediaWiki::preOutputCommit(), Preprocessor_Hash::preprocessToObj(), Preprocessor_DOM::preprocessToObj(), Preprocessor_DOM::preprocessToXml(), CSSMin::processUrlMatch(), 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().

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

Definition at line 781 of file hooks.txt.

◆ $handlerParams

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

Definition at line 1776 of file hooks.txt.

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

◆ $html

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

Definition at line 1965 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::getCheckboxesWidget(), SpecialVersion::getCreditsForExtension(), MWDebug::getDebugHTML(), HTMLFormField::getDiv(), Title::getEditNotices(), BaseTemplate::getFooter(), ApiHelp::getHelp(), WebInstaller::getHelpBox(), HTMLForm::getHiddenFields(), JavaScriptContent::getHtml(), CssContent::getHtml(), MWExceptionRenderer::getHTML(), QuickTemplate::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(), VectorTemplate::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(), EnhancedChangesListTest::testRecentChangesPrefix(), SpecialSearchTest::testRewriteQueryWithSuggestion(), SpecialEditWatchlistTest::testRootPage_displaysExplanationMessage(), SpecialWatchlistTest::testUserWithNoWatchedItems_displaysNoWatchlistMessage(), ImagePage::view(), ParserTestPrinter::wellFormed(), PreferencesForm::wrapForm(), VFormHTMLForm::wrapForm(), OOUIHTMLForm::wrapForm(), HTMLForm::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 781 of file hooks.txt.

◆ $ldapServer

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

Definition at line 190 of file hooks.txt.

◆ $link

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

Definition at line 2981 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(), ResourceLoaderModule::getHeaders(), OutputPage::getHeadLinksArray(), ApiHelp::getHelpInternal(), EnhancedChangesList::getLineData(), RevDelArchivedFileItem::getLink(), RevDelFileItem::getLink(), RenameuserLogFormatter::getMessageParameters(), ApiParamInfo::getModuleInfo(), SpecialUndelete::getPageLink(), WebInstaller::getPageListItem(), Block::getPermissionsError(), TablePager::getStartBody(), RevDelFileItem::getUserTools(), HistoryPager::historyLine(), ImagePage::imageDupes(), ImagePage::imageLinks(), ImageGalleryBase::insert(), SpecialWhatLinksHere::listItem(), Linker::makeCommentLink(), Linker::makeExternalLink(), DummyLinker::makeHeadline(), Linker::makeHeadline(), BaseTemplate::makeListItem(), LogFormatter::makePageLink(), ChangesList::maybeWatchedLink(), RenameuserLogFormatter::myPageLink(), ImportStreamSource::newFromInterwiki(), ComposerPackageModifier::newMediaWikiLink(), Language::numLink(), ImagePage::openShowImage(), SpecialRecentChanges::optionsPanel(), SpecialSpecialpages::outputPageList(), SkinTemplate::prepareQuickTemplate(), SpecialBlock::preText(), Preferences::profilePreferences(), CologneBlueTemplate::quickBar(), MediaWiki\Widget\Search\SimpleSearchResultWidget::render(), MediaWiki\Widget\Search\InterwikiSearchResultWidget::render(), MediaWiki\Widget\Search\FullSearchResultWidget::render(), ImageMap::render(), LinkHolderArray::replaceInternal(), LinkHolderArray::replaceInterwiki(), Linker::revDeleteLink(), DifferenceEngine::revisionDeleteLink(), HistoryPager::revLink(), Linker::revUserLink(), Linker::revUserTools(), ComposerPackageModifier::setLinkAsProvides(), Article::showDeletedRevisionHeader(), DifferenceEngine::showDiffPage(), FileDeleteForm::showForm(), SpecialRevisionDelete::showForm(), SpecialAutoblockList::showList(), SpecialBlockList::showList(), Article::showPatrolFooter(), SpecialPrefixindex::showPrefixChunk(), SpecialUndelete::showRevision(), MovePageForm::showSubpagesList(), SpecialUpload::showViewDeletedLinks(), OutputPage::styleLink(), Skin::subPageSubtitle(), ApiMain::substituteResultWithError(), MediaWiki\Auth\AuthManagerTest::testAuthentication(), TraditionalImageGallery::toHTML(), SpecialUndelete::undelete(), CreditsAction::userLink(), and CologneBlueTemplate::variantLinks().

◆ $linkRenderer

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

Definition at line 1965 of file hooks.txt.

Referenced by UploadForm::__construct(), OutputPage::addCategoryLinks(), OutputPage::addReturnTo(), OutputPage::buildBacklinkSubtitle(), ProtectionForm::buildForm(), SpecialPageFactory::capturePath(), MediaWiki\Linker\LinkRendererFactory::createForUser(), MediaWiki\Linker\LinkRendererFactory::createFromLegacyOptions(), LinkHolderArray::doVariants(), SpecialPageFactory::executePath(), DeletedContribsPager::formatRevisionRow(), ContribsPager::formatRow(), BlockListPager::formatValue(), AllMessagesTablePager::formatValue(), ImageListPager::formatValue(), CategoryViewer::generateLink(), Preferences::generateSkinOptions(), PreferencesForm::getButtons(), InfoAction::getContributors(), RevisionItem::getDiffLink(), MWGrants::getGrantsLink(), Linker::getLinkColour(), RevisionItem::getRevisionLink(), HistoryPager::lastLink(), Linker::link(), InfoAction::pageInfo(), CategoryViewer::pagingLinks(), SpecialBlock::postText(), MarkpatrolledAction::preText(), Preferences::profilePreferences(), LinkHolderArray::replaceInternal(), LinkHolderArray::replaceInterwiki(), ImportReporter::reportPage(), MediaWiki\Widget\Search\DidYouMeanWidget::rewrittenHtml(), FileDeleteForm::showForm(), OutputPage::showPermissionsErrorPage(), Preferences::skinPreferences(), LinkRendererFactoryTest::testCreateForUser(), LinkRendererFactoryTest::testCreateFromLegacyOptions(), and Preferences::watchlistPreferences().

◆ $linksUpdate

either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables & $linksUpdate

Definition at line 2044 of file hooks.txt.

Referenced by LinksUpdate::__construct(), LinksUpdate::doUpdate(), CiteHooks::onLinksUpdate(), and CiteHooks::onLinksUpdateComplete().

◆ $localize

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

Definition at line 2296 of file hooks.txt.

◆ $mimeMagic

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array change it to the message you want to define you are encouraged to submit patches to MediaWiki s core to add new MIME types to mime types $mimeMagic

static

Definition at line 2198 of file hooks.txt.

Referenced by File::checkExtensionCompatibility().

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

inline

Definition at line 302 of file hooks.txt.

◆ $namespaces

namespace and then decline to actually register it& $namespaces

Definition at line 932 of file hooks.txt.

Referenced by ChangesListSpecialPage::buildQuery(), PrefixSearch::defaultSearchBackend(), FixDefaultJsonContentPages::doDBUpdates(), SpecialPrefixindex::execute(), SpecialAllPages::execute(), MWNamespace::getCanonicalNamespaces(), MediaWikiTestCase::getDefaultWikitextNS(), ApiHelp::getHelpInternal(), InputBox::getSearchForm(), PrefixSearch::handleResultFromHook(), Title::inNamespaces(), SearchEngineConfig::namespacesAsText(), ShortPagesPage::reallyDoQuery(), SearchExactMatchRescorer::rescore(), ApiQueryAllDeletedRevisions::run(), ApiQueryDuplicateFiles::run(), PrefixSearch::search(), PrefixSearch::searchBackend(), PrefixSearchTest::searchProvision(), SearchEnginePrefixTest::searchProvision(), PrefixSearch::searchWithVariants(), Language::setNamespaces(), BackupReader::setNsfilter(), SpecialAllPages::showChunk(), SpecialPrefixindex::showPrefixChunk(), PrefixSearchTest::testSearch(), PrefixSearchTest::testSearchWithOffset(), ImportTest::testSiteInfoContainsNamespaces(), PrefixSearch::titleSearch(), and PrefixSearch::validateNamespaces().

◆ $newminor

also included in $newHeader if any $newminor

Definition at line 1246 of file hooks.txt.

Referenced by DifferenceEngine::showDiffPage().

◆ $newtalks

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

Definition at line 1639 of file hooks.txt.

Referenced by Skin::getNewtalks().

◆ $oldminor

passed in as a query string parameter to the various URLs constructed here (i.e. $nextlink) $rdel also included in $oldHeader $oldminor

Definition at line 1250 of file hooks.txt.

Referenced by DifferenceEngine::showDiffPage().

◆ $options

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

Definition at line 1965 of file hooks.txt.

◆ $out

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

inline

Definition at line 781 of file hooks.txt.

◆ $output

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

static

Definition at line 2198 of file hooks.txt.

Referenced by Maintenance::activateProfiler(), ProtectionForm::buildForm(), WikiExporter::closeStream(), StringUtils::delimiterReplaceCallback(), LinkHolderArray::doVariants(), SpecialRenameuser::execute(), SpecialContributions::execute(), SpecialWatchlist::execute(), SpecialExpandTemplates::execute(), SpecialEditTags::execute(), DumpCategoriesAsRdf::execute(), SpecialRevisionDelete::execute(), BlockLevelPass::execute(), SpecialPageExecutor::executeSpecialPage(), GadgetDefinitionContent::fillParserOutput(), JsonContent::fillParserOutput(), DummyContentForTesting::fillParserOutput(), DummyNonTextContent::fillParserOutput(), TextContent::fillParserOutput(), WikitextContent::fillParserOutput(), MediaWiki\Logger\Monolog\LineFormatter::format(), AutoloadGenerator::generatePHPAutoload(), CategoryMembershipChangeJob::getCategoriesAtRev(), TextContentHandler::getDataForSearchIndex(), ContentHandler::getDataForSearchIndex(), SpecialPageExecutor::getHTMLFromSpecialPage(), ChangesListBooleanFilter::getJsData(), ChangesListStringOptionsFilterGroup::getJsData(), ChangesListFilterGroup::getJsData(), ChangesListFilter::getJsData(), WebInstallerLanguage::getLanguageSelector(), EditPage::getPreviewLimitReport(), ChangesListSpecialPage::getStructuredFilterJsData(), PageDataRequestHandler::handleRequest(), DumpRenderer::handleRevision(), CryptHKDF::HKDFExpand(), PageDataRequestHandler::httpContentNegotiation(), StringUtils::hungryDelimiterReplace(), Profiler::logData(), Profiler::logDataPageOutputOnly(), MediaWiki::main(), SpecialExpandTemplates::makeOutput(), PageDataRequestHandlerTest::makeOutputPage(), Maintenance::maybeHelp(), mccGetHelp(), onApiFormatHighlight(), onContentGetParserOutput(), InputBoxHooks::onMediaWikiPerformAction(), SpamBlacklistHooks::onParserOutputStashForEdit(), SpamBlacklistHooks::onUploadVerifyUpload(), ImagePage::openShowImage(), WikiExporter::openStream(), SpecialWatchlist::outputChangesList(), WikiExporter::outputLogStream(), WikiExporter::outputPageStream(), MediaWiki::performAction(), MediaWiki::performRequest(), Wikimedia\Rdbms\DatabasePostgres::pg_array_parse(), MediaWiki::preOutputCommit(), ParserTestPrinter::quickDiff(), SectionProfiler::remapCallTree(), ImageMap::render(), LinkHolderArray::replaceInternal(), LinkHolderArray::replaceInterwiki(), UserNotLoggedIn::report(), SpecialAllPages::showChunk(), SpecialGadgets::showExportForm(), UserrightsPage::showLogFragment(), SpecialGadgets::showMainForm(), SpecialPrefixindex::showPrefixChunk(), SpecialEditWatchlist::showTitles(), JpegHandler::swapICCProfile(), BalancerTest::testBalancer(), WfShellExecTest::testBug67870(), ContentHandlerTest::testDataIndexFields(), SpecialPageDataTest::testExecute(), ArrayDiffFormatterTest::testFormat(), BaseBlacklistTest::testGetTypeFromTitle(), PageDataRequestHandlerTest::testHandleRequest(), PageDataRequestHandlerTest::testHttpContentNegotiation(), WfTimestampTest::testHttpDate(), WfTimestampTest::testNormalTimestamps(), WfTimestampTest::testOldTimestamps(), JpegPixelFormatTest::testPixelFormatRendering(), PreprocessorTest::testPreprocessorOutputFiles(), LocalisationUpdate\UpdaterTest::testReadMessages(), FormatMetadataTest::testResolveMultivalueValue(), SpecialPageDataTest::testSpecialPageWithoutParameters(), CommandTest::testT69870(), ApiResultTest::testTransformations(), AbstractChangesListSpecialPageTestCase::testValidateOptions(), WfAssembleUrlTest::testWfAssembleUrl(), WfShorthandToIntegerTest::testWfShorthandToInteger(), TraditionalImageGallery::toHTML(), MediaWiki::tryNormaliseRedirect(), and GenerateJqueryMsgData::writeJavascriptFile().

◆ $parser

function wfGetCustomMagicWordValue $parser

Initial value:

{

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

Definition at line 2572 of file hooks.txt.

◆ $pre

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped $pre

Definition at line 1472 of file hooks.txt.

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

◆ $query

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

Definition at line 1581 of file hooks.txt.

◆ $refreshCache

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

Definition at line 1581 of file hooks.txt.

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

◆ $req

this hook is for auditing only $req

Definition at line 988 of file hooks.txt.

◆ $request

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow (e.g. with the RejectParserCacheValue hook) because MediaWiki won't do it for you. &$defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request

Definition at line 2581 of file hooks.txt.

◆ $requests

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

Definition at line 304 of file hooks.txt.

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

◆ $res

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

Definition at line 932 of file hooks.txt.

◆ $resourceLoader

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow (e.g. with the RejectParserCacheValue hook) because MediaWiki won't do it for you. &$defaults also a ContextSource after deleting those rows but within the same transaction 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

Definition at line 2581 of file hooks.txt.

Referenced by LessTestSuite::__construct(), OutputPage::filterModules(), WebInstallerOutput::getCSS(), ResourceLoaderStartUpModule::getModuleRegistrations(), ResourceLoaderTestCase::getResourceLoaderContext(), ResourceLoaderModule::getScriptURLsForDebug(), ResourceLoaderModule::getStyleURLsForDebug(), CiteHooks::onResourceLoaderRegisterModules(), onResourceLoaderRegisterModules(), CiteHooks::onResourceLoaderTestModules(), GadgetHooks::registerModules(), PdfHandler::registerWarningModule(), ResourceLoaderTest::testConstructRegistrationHook(), ResourceLoaderTest::testGetModuleNames(), ResourceLoaderTest::testRegisterEmptyString(), ResourceLoaderTest::testRegisterInvalidName(), ResourceLoaderTest::testRegisterInvalidType(), ResourceLoaderTest::testRegisterValidArray(), and ResourceLoaderTest::testRegisterValidObject().

◆ $ResourceLoader

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

Definition at line 2794 of file hooks.txt.

◆ $response

this hook is for auditing only $response

Definition at line 781 of file hooks.txt.

◆ $ret

either a unescaped string or a HtmlArmor object after in associative array form & $ret

Definition at line 1965 of file hooks.txt.

◆ $retval

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

Definition at line 244 of file hooks.txt.

Referenced by ExternalStoreMedium::batchFetchFromURLs(), ExternalStore::batchFetchFromURLs(), MediaWiki\Tidy\RaggettExternal::cleanWrapped(), MediaWiki\Tidy\RaggettInternalHHVM::cleanWrapped(), MediaWiki\Tidy\RaggettInternalPHP::cleanWrapped(), HTMLForm::displaySection(), PdfHandler::doTransform(), DjVuHandler::doTransform(), ApiUndelete::execute(), ApiEmailUser::execute(), ApiPatrol::execute(), ApiExpandTemplates::execute(), ApiUnblock::execute(), ApiBlock::execute(), ApiRollback::execute(), NamespaceConflictChecker::execute(), MediaWiki\Shell\Command::execute(), ResourceLoaderContext::expandModuleNames(), Wikimedia\Rdbms\Database::fieldNamesWithAlias(), ArrayDiffFormatter::format(), ApiQueryBacklinks::getAllowedParams(), MediaWiki\Interwiki\ClassicInterwikiLookup::getAllPrefixesDB(), FindHooks::getHooksFromOnlineDocCategory(), TransformationalImageHandler::getMagickVersion(), UnusedimagesPage::getQueryInfo(), LinkSearchPage::getQueryInfo(), ApiQueryUserInfo::getRateLimits(), SiteConfiguration::getSetting(), Maintenance::getTermSize(), WikiPage::insertRedirect(), MediaHandler::logErrorForExternalProcess(), ApiMove::moveSubpages(), Title::moveSubpages(), RecentChange::parseToRCType(), ApiQueryImageInfo::processMetaData(), WfExpandUrlTest::provideExpandableUrls(), SvgHandler::rasterize(), Maintenance::readlineEmulation(), DoubleRedirectsPage::reallyGetQueryInfo(), MediaHandler::removeBadFile(), PdfImage::retrieveMetaData(), JpegHandler::rotate(), BitmapHandler::rotate(), Hooks::run(), Hooks::runWithoutAbort(), SpecialInterwiki::showList(), EmailConfirmation::showRequestForm(), JpegHandler::swapICCProfile(), Wikimedia\Rdbms\Database::tableNamesWithAlias(), MediaWiki\Session\SessionTest::testMethods(), JpegPixelFormatTest::testPixelFormatRendering(), BitmapHandler::transformCustom(), BitmapHandler::transformImageMagick(), MediaWiki\Tidy\RaggettBase::validate(), RandomImageGenerator::writeImageWithApi(), and RandomImageGenerator::writeImageWithCommandLine().

◆ $rev

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

Definition at line 1750 of file hooks.txt.

◆ $revert

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

Definition at line 2141 of file hooks.txt.

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

◆ $rollback

also included in $newHeader $rollback

Definition at line 1246 of file hooks.txt.

Referenced by DifferenceEngine::showDiffPage().

◆ $rowAugmentors

the value to return A Title object or null for latest all implement SearchIndexField must implement ResultSetAugmentor& $rowAugmentors

Definition at line 2834 of file hooks.txt.

Referenced by SearchEngineTest::addAugmentors(), and SearchEngine::augmentSearchResults().

◆ $rows

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow (e.g. with the RejectParserCacheValue hook) because MediaWiki won't do it for you. &$defaults also a ContextSource after deleting those rows but within the same transaction $rows

Definition at line 2581 of file hooks.txt.

◆ $section

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

Definition at line 2981 of file hooks.txt.

Referenced by JobQueueFederated::__construct(), HTMLForm::__construct(), HTMLForm::addFooterText(), CategoryViewer::addFragmentToTitle(), HTMLForm::addHeaderText(), ParserOutput::addHeadItem(), ApiQuerySearch::addInterwikiResults(), SkinTemplate::buildContentNavigationUrls(), HTMLForm::displaySection(), SimpleCaptcha::doConfirmEdit(), Skin::doEditSectionLink(), IndexPager::doQuery(), TestFileEditor::emitTest(), TestFileEditor::execute(), ApiEditPage::execute(), Linker::formatAutocomments(), DummyLinker::formatTemplates(), Linker::formatTemplates(), Linker::generateTOC(), Wikimedia\Rdbms\LBFactoryMulti::getAllMainLBs(), HTMLForm::getFooterText(), OOUIHTMLForm::getHeaderText(), HTMLForm::getHeaderText(), Wikimedia\Rdbms\LBFactoryMulti::getMainLB(), GadgetHooks::getPreferences(), RawAction::getRawText(), Wikimedia\Rdbms\LBFactoryMulti::getSectionForDomain(), MediaWikiGadgetsDefinitionRepo::listFromDefinition(), SimpleCaptcha::loadText(), Exif::makeFilteredData(), Wikimedia\Rdbms\LBFactoryMulti::newMainLB(), WebInstallerOutput::outputFooter(), TestFileEditor::parseTest(), EditPageTest::provideAutoMerge(), MediaWiki\Widget\Search\FullSearchResultWidget::render(), ProfilerSectionOnly::scopedProfileIn(), SectionProfiler::scopedProfileIn(), ProfilerXhprof::scopedProfileIn(), SectionProfiler::scopedProfileOut(), Profiler::scopedProfileOut(), FileBackend::scopedProfileSection(), HTMLForm::setFooterText(), HTMLForm::setHeaderText(), SimpleCaptcha::shouldCheck(), SpecialGadgets::showMainForm(), EditPageTest::testExtractSectionTitle(), EditPageTest::testSectionEdit(), Exif::validate(), OOUIHTMLForm::wrapFieldSetSection(), and HTMLForm::wrapFieldSetSection().

◆ $services

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services

static

Definition at line 2198 of file hooks.txt.

◆ $skin

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

Definition at line 1965 of file hooks.txt.

Referenced by LogPage::actionText(), SkinFallbackTemplate::buildHelpfulInformationMessage(), ApiParse::execute(), ResourceLoaderOOUIFileModule::extendSkinSpecific(), ResourceLoaderImageModule::getGlobalVariants(), ResourceLoaderImageModule::getImages(), ParserOutput::getText(), ResourceLoaderOOUIImageModule::loadFromDefinition(), ResourceLoaderImageModule::loadFromDefinition(), SkinFactory::makeSkin(), SpecialGadgetUsage::outputResults(), QueryPage::outputResults(), SkinFactoryTest::testMakeSkinWithValidCallback(), and MonoBookTemplate::toolbox().

◆ $special

◆ $suppressed

div flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException $suppressed

Definition at line 2141 of file hooks.txt.

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

◆ $tabindex

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

Definition at line 1411 of file hooks.txt.

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

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

Definition at line 988 of file hooks.txt.

◆ $template

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

inline

Definition at line 781 of file hooks.txt.

Referenced by TitleBlacklistHooks::addOverrideCheckbox(), OutputPage::addTemplate(), TemplatesOnThisPageFormatter::format(), LoginSignupSpecialPage::getBCFieldDefinitions(), LoginSignupSpecialPage::getFakeTemplate(), LoginSignupSpecialPage::getFieldDefinitions(), HTMLFormFieldCloner::getInputHTML(), SpecialExport::getLinks(), GenerateJqueryMsgData::getMessagesAndTests(), ApiOpenSearch::getOpenSearchTemplate(), PPFuzzTest::getReport(), BaseTemplate::getSidebar(), EditPage::getTemplates(), BaseTemplate::getToolbox(), Wikimedia\Rdbms\LBFactoryMulti::makeServerArray(), AuthPlugin::modifyUITemplate(), Wikimedia\Rdbms\LBFactoryMulti::newExternalLB(), Wikimedia\Rdbms\LBFactoryMulti::newLoadBalancer(), Wikimedia\Rdbms\LBFactoryMulti::newMainLB(), SkinTemplateTest::testMakeListItem(), and TemplateCategoriesTest::testTemplateCategories().

◆ $term

external whereas SearchGetNearMatch runs after $term

Definition at line 2811 of file hooks.txt.

◆ $time

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

Definition at line 1778 of file hooks.txt.

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

◆ $title

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

Definition at line 932 of file hooks.txt.

◆ $unhide

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

Definition at line 1581 of file hooks.txt.

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

◆ $user

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 or null $user

Definition at line 244 of file hooks.txt.

◆ $username

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

Definition at line 781 of file hooks.txt.

◆ $vars

configuration should be added through ResourceLoaderGetConfigVars instead& $vars

static

Definition at line 2198 of file hooks.txt.

◆ $wgCapitalizeTitle

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

Definition at line 51 of file hooks.txt.

Referenced by follows().

◆ $wgHooks

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

◆ $wgNotifyArticle

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

Definition at line 51 of file hooks.txt.

◆ AbortAutoAccount

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

Definition at line 244 of file hooks.txt.

◆ add

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

Definition at line 51 of file hooks.txt.

Referenced by TextPassDumper::__construct(), MemcachedPeclBagOStuff::add(), CheckLanguageCLI::help(), PoolCounterRedis::initAndPopPoolSlotList(), and FancyCaptcha::pickImageFromList().

◆ addition

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

Definition at line 84 of file hooks.txt.

Referenced by RedisLockManager::getLocksOnServer().

◆ admin

An extension or a admin

Definition at line 51 of file hooks.txt.

◆ Alternatively

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

Definition at line 1265 of file hooks.txt.

Referenced by RecountCategories::__construct().

◆ article

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

Definition at line 23 of file hooks.txt.

◆ ATTENTION

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

inline

Definition at line 781 of file hooks.txt.

◆ AuthPluginAutoCreate

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

Definition at line 781 of file hooks.txt.

◆ AutopromoteCondition

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

Definition at line 781 of file hooks.txt.

◆ becomes

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

Definition at line 73 of file hooks.txt.

◆ BeforeDisplayNoArticleText

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

inline

Definition at line 781 of file hooks.txt.

◆ BeforeInitialize

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

inline

Definition at line 781 of file hooks.txt.

◆ BeforeParserFetchFileAndTitle

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

inline

Definition at line 781 of file hooks.txt.

◆ BitmapHandlerTransform

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

inline

Definition at line 781 of file hooks.txt.

◆ block

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

Definition at line 2141 of file hooks.txt.

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

◆ BlockIp

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

inline

Definition at line 781 of file hooks.txt.

◆ BlockIpComplete

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

inline

Definition at line 781 of file hooks.txt.

◆ bolding

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

Definition at line 1730 of file hooks.txt.

◆ broken

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

Definition at line 1965 of file hooks.txt.

Referenced by CleanupInvalidDbKeys::__construct(), and CheckLanguageCLI::help().

◆ bugs

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid bugs

Definition at line 2572 of file hooks.txt.

◆ case

it s the revision text itself In either case

Definition at line 2801 of file hooks.txt.

◆ check

</code > has no name attribute ! end ! article vol XXI</ref >< references group="klingon"/> ! html Wikipedia rocks< a href="#cite_note-1"> &< div class="mw-references-wrap">< ol class="references">< li id="cite_note-1">< a href="#cite_ref-1"> ↑</a > Proceeds of vol XXI</li ></ol ></div > ! end ! test Bug regression check

Definition at line 1411 of file hooks.txt.

Referenced by BrokenRedirectsPage::formatResult(), CheckLanguageCLI::help(), ParserOutput::isLinkInternal(), and MWRestrictionsTest::testCheck().

◆ classes

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

Definition at line 988 of file hooks.txt.

◆ code

Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object code

Definition at line 23 of file hooks.txt.

Referenced by LocalisationUpdate\JSONReader::__construct(), CheckLanguageCLI::__construct(), CheckLanguageCLI::doChecks(), DatabaseOracle::doQuery(), FauxResponse::header(), CheckLanguageCLI::help(), LocalisationUpdate\JSONReader::parse(), EditPageTest::provideAutoMerge(), and FauxResponse::statusHeader().

◆ coloring

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

Definition at line 1730 of file hooks.txt.

◆ complete

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

Definition at line 197 of file hooks.txt.

Referenced by XhprofData::getCompleteMetrics(), and CheckLanguageCLI::help().

◆ conditional

namespace addition is conditional

inline

Definition at line 930 of file hooks.txt.

◆ Consider

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

Definition at line 23 of file hooks.txt.

◆ core

do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow (e.g. with the RejectParserCacheValue hook) because MediaWiki won't do it for you. &$defaults also a ContextSource after deleting those rows but within the same transaction 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

Definition at line 2581 of file hooks.txt.

Referenced by LocalisationUpdate\Finder::__construct().

◆ Currently

the other converts the title to all uppercase letters Currently

Definition at line 34 of file hooks.txt.

◆ data

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

Definition at line 6 of file hooks.txt.

◆ deleteAnArticle

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

Definition at line 91 of file hooks.txt.

◆ diff

passed in as a query string parameter to the various URLs constructed here (i.e. $nextlink) $rdel also included in $oldHeader indicating whether we should show just the diff

Definition at line 1246 of file hooks.txt.

Referenced by EditPage::edit(), EditPage::getEditPermissionErrors(), MWTimestamp::getRelativeTimestamp(), EditPage::getSummaryPreview(), EditPage::importFormData(), EditPage::showEditForm(), and EditPage::showHeader().

◆ do

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

Definition at line 190 of file hooks.txt.

◆ e

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

Definition at line 1411 of file hooks.txt.

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

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

Definition at line 1411 of file hooks.txt.

◆ EmailConfirmed

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

Definition at line 1411 of file hooks.txt.

◆ error

</code > has conflicting group attribute Cite error

Definition at line 2581 of file hooks.txt.

Referenced by HTMLReCaptchaField::__construct(), Wikimedia\Rdbms\DBQueryError::__construct(), PathRouterPatternReplacer::callback(), MediaWiki\Logger\Monolog\LegacyHandler::errorTrap(), HTMLReCaptchaField::getInputHTML(), MediaWiki\Logger\Monolog\LegacyHandler::openSink(), SpecialUpload::processVerificationError(), PathRouterPatternReplacer::replace(), Job::setLastError(), BitmapHandler::transformCustom(), BitmapHandler::transformGd(), and BitmapHandler::transformImageMagick().

◆ errors

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

Definition at line 1730 of file hooks.txt.

Referenced by PermissionsError::__construct(), StatusValue::__toString(), CheckStorage::check(), StatusValue::error(), CheckStorage::error(), MWDocGen::execute(), StatusValue::fatal(), StatusValue::getErrorsByType(), StatusValue::hasMessage(), CheckLanguageCLI::help(), CheckStorage::importRevision(), StatusValue::merge(), StatusValue::replaceMessage(), PermissionsError::report(), StatusValue::splitByErrorType(), and StatusValue::warning().

◆ etc

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

Definition at line 91 of file hooks.txt.

◆ event

and how to run hooks for an event

Initial value:

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

Definition at line 4 of file hooks.txt.

◆ example

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 example

Definition at line 6 of file hooks.txt.

◆ exportArticle

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

Definition at line 91 of file hooks.txt.

◆ false

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

inline

Definition at line 187 of file hooks.txt.

◆ feeds

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

Definition at line 302 of file hooks.txt.

◆ file

to their LocalSettings php file

Definition at line 91 of file hooks.txt.

Referenced by LessFileCompilationTest::__construct(), Wikimedia\Rdbms\MySQLMasterPos::__construct(), RevDelArchivedFileItem::__construct(), RevDelFileItem::__construct(), BackupReader::__construct(), FileDeleteForm::__construct(), CleanupInvalidDbKeys::__construct(), TestFileReader::__construct(), Exif::__construct(), ThumbnailImage::__construct(), LocalFileDeleteBatch::__construct(), LocalFileRestoreBatch::__construct(), LocalFileMoveBatch::__construct(), LocalFileDeleteBatch::addCurrent(), LocalFileDeleteBatch::addOld(), LocalFileDeleteBatch::addOlds(), RevDelFileItem::canView(), RevDelFileItem::canViewContent(), TestFileReader::checkSection(), LocalFileRestoreBatch::cleanup(), LocalFileRestoreBatch::cleanupFailedBatch(), LocalFileMoveBatch::cleanupSource(), LocalFileMoveBatch::cleanupTarget(), LocalFileDeleteBatch::doDBDeletes(), LocalFileDeleteBatch::doDBInserts(), ApiFileRevert::execute(), InvalidateUserSesssions::execute(), FileDeleteForm::execute(), FileDuplicateSearchPage::execute(), MWDocGen::execute(), ZipDirectoryReader::execute(), LocalFileDeleteBatch::execute(), LocalFileRestoreBatch::execute(), LocalFileMoveBatch::execute(), RevDelFileItem::getBits(), RevDelFileItem::getComment(), MediaTransformOutput::getDescLinkAttribs(), ZipDirectoryReader::getFileLength(), LocalFileDeleteBatch::getHashes(), RevDelFileItem::getHTML(), RevDelArchivedFileItem::getLink(), RevDelFileItem::getLink(), MediaTransformOutput::getLocalCopyPath(), LocalFileMoveBatch::getMoveTriplets(), ZipDirectoryReader::getSegment(), RevDelFileItem::getUserTools(), CheckLanguageCLI::help(), RevDelFileItem::isDeleted(), User::isLocallyBlockedProxy(), RevDelFileItem::lock(), DatabaseInstaller::populateInterwikiTable(), FileDeleteForm::prepareMessage(), DumpBackup::processOptions(), MergeMessageFileList::readFile(), LocalFileDeleteBatch::removeNonexistentFiles(), LocalFileRestoreBatch::removeNonexistentFiles(), LocalFileMoveBatch::removeNonexistentFiles(), LocalFileRestoreBatch::removeNonexistentFromCleanup(), RevDelFileItem::setBits(), MediaTransformOutput::streamFileWithStatus(), TextSuppressor::suppress(), CheckStyleSuppressor::suppress(), LessFileCompilationTest::testLessFileCompilation(), ThumbnailImage::toHtml(), RevDelFileItem::unlock(), ApiFileRevert::validateParameters(), and LocalFileMoveBatch::verifyDBUpdates().

◆ FileDeleteComplete

return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used FileDeleteComplete

Definition at line 1472 of file hooks.txt.

◆ form

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

Definition at line 1965 of file hooks.txt.

Referenced by SkinFallbackTemplate::execute(), MWExceptionRenderer::googleSearchForm(), CheckLanguageCLI::help(), and MonoBookTemplate::searchBox().

◆ format

usually copyright or history_copyright This message must be in HTML format

Definition at line 1639 of file hooks.txt.

Referenced by DumpBackup::__construct(), ChangesFeed::__construct(), ApiErrorFormatter::__construct(), ResourceLoaderContext::__construct(), ApiErrorFormatter::addWarningOrError(), ApiErrorFormatter::arrayFromStatus(), UpdateLogging::execute(), ChangesFeed::execute(), QueryPage::execute(), MediaWiki\Logger\Monolog\LegacyFormatter::format(), MediaWiki\Logger\Monolog\LineFormatter::format(), ApiErrorFormatter::formatMessage(), SpecialVersion::getCopyrightAndAuthorList(), ChangesFeed::getFeedObject(), ApiOpenSearch::getFormat(), WikiRevision::getFormat(), ImportTest::getRedirectXML(), MWTimestamp::getTimezoneMessage(), ImportTest::getUnknownTagsXML(), HistoryAction::onView(), CoreParserFunctions::revisionday(), CoreParserFunctions::revisionday2(), CoreParserFunctions::revisionmonth(), CoreParserFunctions::revisionmonth1(), CoreParserFunctions::revisiontimestamp(), CoreParserFunctions::revisionyear(), and WikiRevision::setFormat().

◆ framework

For QUnit framework

Definition at line 2794 of file hooks.txt.

◆ functions

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

Definition at line 1581 of file hooks.txt.

◆ GalleryGetModes

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

Definition at line 1581 of file hooks.txt.

◆ Generally

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

Definition at line 988 of file hooks.txt.

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

Definition at line 1581 of file hooks.txt.

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

Definition at line 1581 of file hooks.txt.

◆ GetDoubleUnderscoreIDs

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

Definition at line 1581 of file hooks.txt.

◆ GetLocalURL

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

Definition at line 1639 of file hooks.txt.

◆ GetRelativeTimestamp

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

Definition at line 1639 of file hooks.txt.

◆ getUserPermissionsErrorsExpensive

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

Definition at line 1736 of file hooks.txt.

◆ GitViewers

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

Definition at line 1750 of file hooks.txt.

◆ gzip

gzip

Definition at line 2805 of file hooks.txt.

◆ handler

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

inline

Definition at line 781 of file hooks.txt.

◆ herself

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

Initial value:

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

Definition at line 129 of file hooks.txt.

◆ history

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

Definition at line 1750 of file hooks.txt.

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

◆ hook

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

Initial value:

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

Definition at line 23 of file hooks.txt.

Referenced by SpecialStatistics::execute().

◆ hooks

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

Definition at line 73 of file hooks.txt.

Referenced by SpecialUpload::processVerificationError().

◆ However

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services However

static

Definition at line 2198 of file hooks.txt.

◆ imagelinks

either a unescaped string or a HtmlArmor object after in associative array form imagelinks

Definition at line 2044 of file hooks.txt.

◆ ImageOpenShowImageInlineBefore

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

Definition at line 1778 of file hooks.txt.

◆ in

null for the wiki Added in

Definition at line 1581 of file hooks.txt.

Referenced by PopulateCategory::__construct(), PopulateInterwiki::__construct(), PopulateIpChanges::__construct(), RecountCategories::__construct(), UpdateCollation::__construct(), BackupReader::__construct(), CleanupInvalidDbKeys::__construct(), Exif::__construct(), CleanupInvalidDbKeys::cleanupTable(), SpecialContributions::contributionsSub(), ModernTemplate::execute(), RedisLockManager::freeLocksOnServer(), Title::getContentModel(), Title::getLatestRevID(), Title::getLength(), RedisLockManager::getLocksOnServer(), Title::getSkinFromCssJsSubpage(), User::getStubThreshold(), DeletedContributionsPage::getSubTitle(), MWExceptionHandler::handleFatalError(), CheckLanguageCLI::help(), PoolCounterRedis::initAndPopPoolSlotList(), ParserOutput::isLinkInternal(), Title::isRedirect(), MessageCache::load(), Title::loadFromRow(), Title::makeTitle(), SpecialUpload::processVerificationError(), EditPageTest::provideAutoMerge(), RevisionStorageTest::provideUserWasLastToEdit(), JobQueueRedis::pushBlobs(), EditPage::showIntro(), SpecialBookSources::showList(), Article::showMissingArticle(), WikitextStructureTest::testHeadings(), WikitextStructureTest::testTexts(), and UserOptions::warn().

◆ insert

either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and insert

Definition at line 2044 of file hooks.txt.

Referenced by Wikimedia\Rdbms\DatabaseSqlite::insert().

◆ Instead

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

Definition at line 988 of file hooks.txt.

◆ isolated

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

Definition at line 115 of file hooks.txt.

◆ it

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

Definition at line 1736 of file hooks.txt.

◆ key

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

Definition at line 2133 of file hooks.txt.

◆ link

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

Definition at line 2981 of file hooks.txt.

Referenced by ParserOutput::isLinkInternal(), AtomFeed::outHeader(), outItem(), AtomFeed::outItem(), IPTest::provideIsPublic(), EnhancedChangesList::recentChangesBlockGroup(), and LogEventsList::showLogExtract().

◆ Live

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

Definition at line 1411 of file hooks.txt.

◆ LogEventsListGetExtraInputs

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

Definition at line 2044 of file hooks.txt.

◆ LogLine

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

Definition at line 2141 of file hooks.txt.

◆ lt

logged in & lt

Initial value:

{{int:0750ed4b}}
</td></tr><tr><td>
[http:
 
</td><td>
&amp

Definition at line 2140 of file hooks.txt.

◆ MarkPatrolled

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

static

Definition at line 2198 of file hooks.txt.

◆ MediaWiki

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

Definition at line 3 of file hooks.txt.

◆ message

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

◆ messages

passed in as a query string parameter to the various URLs constructed here (i.e. $prevlink) $ldel you ll need to handle error messages

Definition at line 1265 of file hooks.txt.

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

◆ ModifyExportQuery

for adding new MIME types to the list ModifyExportQuery

Definition at line 2293 of file hooks.txt.

◆ name

the value to return A Title object or null for latest all implement SearchIndexField must implement ResultSetAugmentor must implement ResultAugmentor Note that lists should be in the format name

Definition at line 6 of file hooks.txt.

◆ object

either a unescaped string or a HtmlArmor object

Definition at line 2026 of file hooks.txt.

◆ occur

return true to allow those checks to occur

Definition at line 1472 of file hooks.txt.

Referenced by CleanupInvalidDbKeys::__construct().

◆ occurs

When an event occurs

Definition at line 148 of file hooks.txt.

◆ on

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

Definition at line 84 of file hooks.txt.

Referenced by CleanupEmptyCategories::__construct(), PopulateCategory::__construct(), PopulateInterwiki::__construct(), CleanupInvalidDbKeys::__construct(), TextPassDumper::__construct(), Revision::__construct(), PHPVersionCheck::checkVendorExistence(), Wikimedia\Rdbms\PostgresField::fromText(), MWExceptionHandler::handleFatalError(), CheckLanguageCLI::help(), PoolCounterRedis::initAndPopPoolSlotList(), mccShowUsage(), JSTokenizer::newSyntaxError(), PoolCounterRedis::registerAcquisitionTime(), PoolCounterRedis::release(), GlobalTest::testReadOnlySet(), and wfStreamThumb().

◆ otherwise

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

Definition at line 2801 of file hooks.txt.

◆ PageContentSave

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

Definition at line 6 of file hooks.txt.

◆ PageContentSaveComplete

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

Definition at line 6 of file hooks.txt.

◆ pagelinks

either a unescaped string or a HtmlArmor object after in associative array form pagelinks

Definition at line 2044 of file hooks.txt.

◆ ParserLimitReportPrepare

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

Definition at line 2296 of file hooks.txt.

◆ part

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

Definition at line 1411 of file hooks.txt.

Referenced by Preprocessor_Hash::preprocessToObj().

◆ performed

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

inline

Definition at line 781 of file hooks.txt.

Referenced by UpdateLogging::execute().

◆ plain

either a plain

◆ Preview

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

Definition at line 1411 of file hooks.txt.

◆ processing

either a unescaped string or a HtmlArmor object after processing

Definition at line 1965 of file hooks.txt.

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

◆ RecentChangesLinked

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

Definition at line 988 of file hooks.txt.

◆ replace

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

static

Definition at line 2198 of file hooks.txt.

◆ request

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

Definition at line 2141 of file hooks.txt.

◆ rollback

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

Definition at line 1750 of file hooks.txt.

◆ rss

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

Definition at line 302 of file hooks.txt.

Referenced by outFooter().

◆ saved

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

Definition at line 175 of file hooks.txt.

◆ SearchableNamespaces

external SearchableNamespaces

Definition at line 2811 of file hooks.txt.

◆ SearchGetNearMatch

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

Definition at line 2819 of file hooks.txt.

◆ SearchGetNearMatchBefore

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

Definition at line 2824 of file hooks.txt.

◆ SearchGetNearMatchComplete

the value to return A Title object or null SearchGetNearMatchComplete

Definition at line 2834 of file hooks.txt.

◆ SearchIndexFields

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

Definition at line 2834 of file hooks.txt.

◆ set

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

Definition at line 2801 of file hooks.txt.

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

◆ simple

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

Definition at line 23 of file hooks.txt.

◆ source

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

Initial value:

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

Definition at line 1635 of file hooks.txt.

Referenced by PopulateInterwiki::__construct(), ApiContinuationManager::__construct(), MergeHistory::__construct(), Exif::__construct(), MergeHistory::checkPermissions(), PopulateInterwiki::execute(), PopulateInterwiki::fetchLinks(), JSTokenizer::getInput(), MergeHistory::getRevisionCount(), JSTokenizer::init(), MergeHistory::isValidMerge(), MergeHistory::merge(), and Site::setSource().

◆ storage

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

Definition at line 2794 of file hooks.txt.

◆ strategy

Using a hook running strategy

Definition at line 73 of file hooks.txt.

◆ string

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

Definition at line 175 of file hooks.txt.

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

Definition at line 988 of file hooks.txt.

Referenced by RedisLockManager::freeLocksOnServer().

◆ them

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

Definition at line 988 of file hooks.txt.

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

◆ true

return true

Definition at line 1965 of file hooks.txt.

◆ understand

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

Definition at line 114 of file hooks.txt.

◆ undo

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

Definition at line 1750 of file hooks.txt.

◆ up

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

static

Definition at line 2198 of file hooks.txt.

Referenced by CleanupEmptyCategories::__construct(), UpdateCollation::__construct(), CleanupInvalidDbKeys::__construct(), PoolCounterRedis::initAndPopPoolSlotList(), PoolCounterRedis::registerAcquisitionTime(), and PoolCounterRedis::release().

◆ used

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

Definition at line 115 of file hooks.txt.

Referenced by PopulateInterwiki::__construct(), Exif::__construct(), ModernTemplate::execute(), CheckLanguageCLI::help(), and SearchPostgres::searchQuery().

◆ UserLogin

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

Definition at line 6 of file hooks.txt.

◆ values

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

Definition at line 175 of file hooks.txt.

Referenced by LocalSettingsGenerator::__construct(), Exif::__construct(), LocalSettingsGenerator::buildMemcachedServerList(), LocalSettingsGenerator::getDefaultText(), and CheckLanguageCLI::help().

◆ weird

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

Definition at line 84 of file hooks.txt.

◆ writer

An extension writer

Definition at line 51 of file hooks.txt.

Referenced by MediaWiki\Logger\Monolog\AvroFormatter::__construct(), BatchRowUpdate::__construct(), WikiExporter::__construct(), WikiExporter::closeStream(), BatchRowUpdate::execute(), LCStoreCDB::finishWrite(), MediaWiki\Logger\Monolog\AvroFormatter::format(), WikiExporter::openStream(), WikiExporter::outputLogStream(), WikiExporter::outputPageStream(), LCStoreCDB::set(), and LCStoreCDB::startWrite().

Typedefs

Functions

Variables

Typedef Documentation

◆ $result

◆ $status

◆ myext.tests

Function Documentation

◆ addExtraTypes()

◆ array() [1/2]

◆ array() [2/2]

◆ follows()

◆ groups()

◆ if()

◆ ldapLogin()

◆ options()

◆ own()

◆ query()

◆ system()

◆ values()

◆ wfMessage()

Variable Documentation

◆ $abortMsg

◆ $article

◆ $attribs

◆ $auto

◆ $changesList

◆ $code

◆ $colours

◆ $context

◆ $customAttribs

◆ $differenceEngine

◆ $e

◆ $editor

◆ $engine

◆ $extTypes

◆ $flags

◆ $handler

◆ $handlerParams

◆ $html

◆ $image

◆ $ldapServer

◆ $link

◆ $linkRenderer

◆ $linksUpdate

◆ $localize

◆ $mimeMagic

◆ $name

◆ $namespaces

◆ $newminor

◆ $newtalks

◆ $oldminor

◆ $options

◆ $out

◆ $output

◆ $parser

◆ $pre

◆ $query

◆ $refreshCache

◆ $req

◆ $request

◆ $requests

◆ $res

◆ $resourceLoader

◆ $ResourceLoader

◆ $response

◆ $ret

◆ $retval

◆ $rev

◆ $revert

◆ $rollback

◆ $rowAugmentors

◆ $rows

◆ $section

◆ $services

◆ $skin

◆ $special

◆ $suppressed

◆ $tabindex

◆ $tables