Typedefs
using	$status

using	name

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

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

the value of this variable comes from LanguageConverter indexed by page_id indexed by prefixed DB keys on which the links will be shown 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[messagename, param1, param2,...] or a MessageSpecifier	instance (you might want to use ApiMessage to provide machine-readable details for the API). For consistency

function	ldapLogin ( $username, $password)

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function 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 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 use $formDescriptor instead 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 (which can be changed) by the hook callback.

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 use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with	wfMessage () -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<div ...>$1</div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services

Variables
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

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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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

the value of this variable comes from LanguageConverter 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 local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify as strings Extensions should add to this list prev or next refreshes the diff cache allow viewing deleted revs &	$differenceEngine

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

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords	$extraData

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

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 use $formDescriptor instead &	$formDescriptor

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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 e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response 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

the value of this variable comes from LanguageConverter indexed by page_id indexed by prefixed DB keys on which the links will be shown 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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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 e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place	$output

see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false	$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 local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify	$query

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify 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

&	$ResourceLoader

this hook is for auditing only	$response

namespace being checked &	$result

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

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

returning false will NOT prevent logging a wrapping ErrorException 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 e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response 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

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 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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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

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 local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify as strings Extensions should add to this list prev or next refreshes the diff cache	$unhide

return true to allow those checks to and false if checking is done &	$user

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

static configuration should be added through ResourceLoaderGetConfigVars instead &	$vars

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

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

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

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

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

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In	addition

An extension or a local	admin

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 local administrators to define code that will be run at certain points in the mainline and to modify the data run by that mainline code Hooks can keep mainline code and make it easier to write extensions Hooks are a principled alternative to local patches for two options in MediaWiki One reverses the order of a title before displaying the	article

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password	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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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

returning false will NOT prevent logging a wrapping ErrorException	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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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

the value of this variable comes from LanguageConverter indexed by page_id indexed by prefixed DB keys on which the links will be shown 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[messagename, param1, param2,...] or a MessageSpecifier 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

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 initially an empty< div id="toolbar"></div > Hook subscribers can return false to have no toolbar HTML be loaded 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 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 local administrators to define code that will be run at certain points in the mainline	code

the value of this variable comes from LanguageConverter indexed by page_id indexed by prefixed DB keys on which the links will be shown 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[messagename, param1, param2,...] or a MessageSpecifier error messages should be plain text with no special	coloring

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

namespace addition is	conditional

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

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

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function 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 initially an empty< div id="toolbar"></div > Hook subscribers can return false to have no toolbar HTML be loaded	EditPageCopyrightWarning

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 initially an empty< div id="toolbar"></div > Hook subscribers can return false to have no toolbar HTML be loaded 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 initially an empty< div id="toolbar"></div > Hook subscribers can return false to have no toolbar HTML be loaded 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

the value of this variable comes from LanguageConverter indexed by page_id indexed by prefixed DB keys on which the links will be shown 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[messagename, param1, param2,...] or a MessageSpecifier error messages should be plain text with no special etc to show that they re	errors

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function 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

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function 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

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function 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

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

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

this hook is for auditing only 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 local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options	GetCanonicalURL

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify as strings Extensions should add to this list	GetDefaultSortkey

the value of this variable comes from LanguageConverter	GetLinkColours

the value of this variable comes from LanguageConverter indexed by page_id indexed by prefixed DB keys on which the links will be shown	GetLocalURL

the value of this variable comes from LanguageConverter indexed by page_id indexed by prefixed DB keys on which the links will be shown 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

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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 e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response 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

null for the local wiki Added	in

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might	include

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 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 use $formDescriptor instead 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

returning false will NOT prevent logging a wrapping ErrorException create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment or false if none Defaults to false if not set multiOccurrence Can this option be passed multiple times Defaults to false if not set	MaintenanceRefreshLinksInit

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

hooks txt This document describes how event hooks work in	MediaWiki

static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response	MediaWikiPerformAction

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 use $formDescriptor instead 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

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

either a unescaped string or a HtmlArmor	object

return true to allow those checks to	occur

When an event	occurs

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function 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

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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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 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

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	remoteExtPath

static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place	replace

returning false will NOT prevent logging a wrapping ErrorException create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment or false if none Defaults to false if not set multiOccurrence Can this option be passed multiple times Defaults to false if not set 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

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

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

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

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 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 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 e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response 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

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of	weird

An extension	writer

Typedef Documentation

◆ $status

using $status

Definition at line 1032 of file hooks.txt.

◆ name

to move a page</td >< td > &*You are moving the page across *A non empty talk page already exists under the new name

Definition at line 1850 of file hooks.txt.

Function Documentation

◆ addExtraTypes()

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

◆ follows()

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

Definition at line 34 of file hooks.txt.

◆ groups()

this hook is for auditing only 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 ActiveUsersPager::__construct(), Wikimedia\Rdbms\ConnectionManager::__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.

◆ instance()

the value of this variable comes from LanguageConverter indexed by page_id indexed by prefixed DB keys on which the links will be shown 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[messagename, param1, param2,...] or a MessageSpecifier instance ( you might want to use ApiMessage to provide machine-readable details for the API )

◆ ldapLogin()

function ldapLogin	(		$username,
			$password )

Definition at line 192 of file hooks.txt.

◆ options()

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function 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(), ResourceLoaderClientHtml::__construct(), MediaWiki\Revision\RenderedRevision::__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(), MediaWiki\Storage\DerivedPageDataUpdater::doParserCacheUpdate(), MediaWiki\Storage\DerivedPageDataUpdater::doSecondaryDataUpdates(), MediaWiki\Storage\DerivedPageDataUpdater::doUpdates(), SpecialBlockList::execute(), FormOptions::fetchValuesFromRequest(), FormOptions::getAllValues(), SpecialBlockList::getBlockListPager(), ResourceLoaderClientHtml::getBodyHtml(), FormOptions::getChangedValues(), ResourceLoaderClientHtml::getHeadHtml(), XmlSelect::getHTML(), ParserOptions::getOption(), MediaWiki\Revision\RenderedRevision::getSlotParserOutput(), FormOptions::getUnconsumedValues(), FormOptions::getValue(), ParserOptions::initialiseFromUser(), MediaWiki\Storage\DerivedPageDataUpdater::isChange(), MediaWiki\Storage\DerivedPageDataUpdater::isCreation(), ParserOptions::isSafeToCache(), ParserOptions::matches(), BatchRowIterator::next(), FormOptions::offsetExists(), ParserOptions::optionsHash(), MediaWiki\Storage\DerivedPageDataUpdater::prepareContent(), MediaWiki\Storage\DerivedPageDataUpdater::prepareUpdate(), CompareParsers::processRevision(), MediaWiki\Sparql\SparqlClient::query(), FormOptions::reset(), ApiQueryBase::resetQueryParams(), ApiQueryBase::select(), MediaWiki\Sparql\SparqlClient::setClientOptions(), ParserOptions::setOption(), ParserOptions::setOptionLegacy(), MediaWiki\Revision\RenderedRevision::setRevisionInternal(), ExtraParserTest::setUp(), FormOptions::setValue(), HTMLAutoCompleteSelectFieldTest::testGetAttributes(), ExtraParserTest::testGetPreloadText(), ExtraParserTest::testParse(), ExtraParserTest::testParseLinkParameter(), ExtraParserTest::testPreprocess(), ExtraParserTest::testPreSaveTransform(), XmlSelectTest::testSetDefaultAfterAddingOptions(), ExtraParserTest::testTrackingCategory(), ExtraParserTest::testTrackingCategorySpecial(), FormOptions::validateBounds(), FormOptions::validateName(), UserOptionsMaintenance::warn(), and MediaWiki\Logger\Monolog\KafkaHandler::warning().

◆ own()

this hook is for auditing only 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 use $formDescriptor instead 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 ( which 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 use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage ( ) -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<div ...>$1</div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services

Variable Documentation

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

Definition at line 1555 of file hooks.txt.

◆ $attribs

either a unescaped string or a HtmlArmor object & $attribs

Definition at line 2012 of file hooks.txt.

Referenced by PPNode_Hash_Tree::__toString(), OutputPage::addElement(), HTMLForm::addHiddenField(), MediaWiki\Linker\LinkRenderer::buildAElement(), ProtectionForm::buildForm(), Xml::buildTable(), Xml::buildTableRow(), MediaWiki\EditPage\TextboxBuilder::buildTextboxAttribs(), Xml::check(), Html::check(), Xml::checkLabel(), UploadBase::checkSvgScriptCallback(), EditPage::displayPreviewArea(), WebInstaller::docLink(), Skin::doEditSectionLink(), Html::dropDefaults(), Html::element(), Xml::element(), Xml::elementClean(), XmlTypeCheck::elementClose(), XmlTypeCheck::elementOpen(), WebInstallerOptions::execute(), Xml::expandAttributes(), Html::expandAttributes(), Xml::fieldset(), CategoryViewer::formatList(), HTMLMultiSelectField::formatOptions(), HTMLRadioField::formatOptions(), SpecialUndelete::formatRevisionRow(), SpecialNewpages::formatRow(), ContribsPager::formatRow(), DeletedContribsPager::formatRow(), HTMLForm::formatSection(), HTMLAutoCompleteSelectField::getAttributes(), HTMLComboboxField::getAttributes(), HTMLForm::getButtons(), OOUIHTMLForm::getButtons(), VFormHTMLForm::getButtons(), MonoBookTemplate::getCactions(), DatabaseInstaller::getCheckBox(), MediaTransformOutput::getDescLinkAttribs(), MediaWiki\EditPage\TextConflictHelper::getEditConflictMainTextBox(), Parser::getExternalLinkAttribs(), HTMLForm::getFormAttributes(), VFormHTMLForm::getFormAttributes(), ResourceLoaderModule::getHeaders(), HTMLForm::getHiddenFields(), CategoryViewer::getHTML(), ChangeTagsLogItem::getHTML(), ChangeTagsRevisionItem::getHTML(), RevDelRevisionItem::getHTML(), HTMLFancyCaptchaField::getInputHTML(), HTMLReCaptchaField::getInputHTML(), HTMLCheckMatrix::getInputHTML(), HTMLSizeFilterField::getInputHTML(), HTMLTextAreaField::getInputHTML(), HTMLTextField::getInputHTML(), Licenses::getInputHTML(), HTMLFormFieldCloner::getInputHTMLForKey(), HTMLCheckMatrix::getInputOOUI(), HTMLComboboxField::getInputOOUI(), HTMLSelectField::getInputOOUI(), HTMLTextAreaField::getInputOOUI(), HTMLTextField::getInputOOUI(), HTMLFormFieldCloner::getInputOOUIForKey(), UploadSourceField::getLabelHtml(), TablePager::getLimitSelect(), IRCColourfulRCFeedFormatter::getLine(), EnhancedChangesList::getLineData(), HTMLMultiSelectField::getOneCheckbox(), HTMLCheckMatrix::getOneCheckboxHTML(), DatabaseInstaller::getPasswordBox(), EditPage::getPreviewText(), LogFormatter::getRestrictedElement(), DatabaseInstaller::getTextBox(), HTMLTextField::getType(), UserrightsPage::groupCheckboxes(), Html::hidden(), HistoryPager::historyLine(), Html::htmlHeader(), Poem::indentVerse(), Html::inlineStyle(), Xml::input(), Html::input(), Xml::inputLabel(), Xml::inputLabelSep(), Xml::label(), Html::label(), LogEventsList::logLine(), MediaWiki\Linker\LinkRenderer::makeBrokenLink(), TestRecentChangesHelper::makeCategorizationRecentChange(), TestRecentChangesHelper::makeDeletedEditRecentChange(), TestRecentChangesHelper::makeEditRecentChange(), DummyLinker::makeExternalLink(), Linker::makeExternalLink(), DummyLinker::makeHeadline(), TestRecentChangesHelper::makeLogRecentChange(), Linker::makeMediaLinkFile(), TestRecentChangesHelper::makeNewBotEditRecentChange(), MediaWiki\Linker\LinkRenderer::makePreloadedLink(), TestRecentChangesHelper::makeRecentChange(), SpecialInterwiki::makeTable(), MediaWiki\Linker\LinkRenderer::mergeAttribs(), MediaWiki\EditPage\TextboxBuilder::mergeClassesIntoAttributes(), SpecialRecentChanges::namespaceFilterForm(), Html::openElement(), Xml::openElement(), Xml::option(), SpecialRecentChanges::optionsPanel(), Licenses::outputOption(), Xml::password(), CoreTagHooks::pre(), LinkerTest::provideLinkBeginHook(), LinkerTest::provideLinkEndHook(), Html::radio(), Xml::radio(), Xml::radioLabel(), Html::rawElement(), EnhancedChangesList::recentChangesBlockLine(), OldChangesList::recentChangesLine(), ImageMap::render(), Poem::renderPoem(), LinkHolderArray::replaceInternal(), RecentChange::setAttribs(), ImageGalleryBase::setAttributes(), MediaWiki\EditPage\TextConflictHelper::showEditFormTextAfterFooters(), SpecialImport::showForm(), SpecialWatchlist::showHideCheck(), McrUndoAction::showPreview(), EditPage::showTextbox(), EditPage::showTextbox1(), Xml::span(), TextPassDumper::startElement(), LogFormatter::styleRestricedElement(), Xml::submitButton(), Xml::tags(), MediaWiki\Tests\EditPage\TextboxBuilderTest::testBuildTextboxAttribs(), HtmlTest::testDropDefaults(), SideBarTest::testRespectExternallinktarget(), SideBarTest::testRespectWgnofollowlinks(), SideBarTest::testTestAttributesAssertionHelper(), Xml::textarea(), Html::textarea(), MultimediaViewerHooks::thumbnailBeforeProduceHTML(), ThumbnailImage::toHtml(), TraditionalImageGallery::toHTML(), Linker::tooltipAndAccesskeyAttribs(), Linker::userToolLinks(), Sanitizer::validateAttributes(), Sanitizer::validateTagAttributes(), and Xml::wrapClass().

◆ $auto

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

Referenced by PatrolLog::buildParams(), RecentChange::doMarkPatrolled(), Linker::formatAutocomments(), DeleteAutoPatrolLogs::getRowsOld(), 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 1513 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 e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response 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

Definition at line 856 of file hooks.txt.

◆ $colours

the value of this variable comes from LanguageConverter indexed by page_id& $colours

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

◆ $customAttribs

null means default & $customAttribs

Definition at line 1993 of file hooks.txt.

Referenced by EditPage::buildTextboxAttribs(), MediaWiki\EditPage\TextboxBuilder::buildTextboxAttribs(), MediaWiki\EditPage\TextConflictHelper::getEditConflictMainTextBox(), DummyLinker::link(), Linker::link(), DummyLinker::linkKnown(), Linker::linkKnown(), EditPage::showTextbox(), and EditPage::showTextbox1().

◆ $differenceEngine

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

Definition at line 1630 of file hooks.txt.

Referenced by ContentHandler::createDifferenceEngine(), ContentHandler::getSlotDiffRenderer(), DifferenceEngineSlotDiffRendererTest::testAddModules(), DifferenceEngineTest::testGenerateContentDiffBody(), DifferenceEngineTest::testGenerateTextDiffBody(), DifferenceEngineSlotDiffRendererTest::testGetDiff(), DifferenceEngineTest::testGetDiffBody(), DifferenceEngineSlotDiffRendererTest::testGetExtraCacheKeys(), DifferenceEngineTest::testSetContent(), and DifferenceEngineTest::testSetRevisions().

◆ $e

returning false will NOT prevent logging $e

Definition at line 2175 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 1404 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 2913 of file hooks.txt.

Referenced by ContentHandler::addSearchField(), ApiQueryRevisionsBase::extractDeprecatedContent(), ContentHandler::getDataForSearchIndex(), TextContentHandler::getDataForSearchIndex(), WikitextContentHandler::getDataForSearchIndex(), DifferenceEngine::getDebugString(), DifferenceEngine::getDiffBodyCacheKeyParams(), ContentHandler::getFieldsForSearchIndex(), FileContentHandler::getFieldsForSearchIndex(), TextContentHandler::getFieldsForSearchIndex(), WikitextContentHandler::getFieldsForSearchIndex(), DummySearchIndexFieldDefinition::getMapping(), ContentHandler::getSlotDiffRendererInternal(), PageArchive::listPagesBySearch(), MediaWiki\Extensions\ParserFunctions\Hooks::onScribuntoExternalLibraries(), ApiOpenSearchTest::replaceSearchEngine(), TitleBlacklistHooks::scribuntoExternalLibraries(), ContentHandlerTest::testDataIndexFields(), SearchEngineTest::testFiltersMissing(), ApiOpenSearchTest::testGetAllowedParams(), and SearchEngineTest::testSearchIndexFields().

◆ $extraData

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of<username><more info> e g for bot passwords $extraData

Definition at line 785 of file hooks.txt.

Referenced by BotPassword::loginHook().

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

◆ $formDescriptor

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 use $formDescriptor instead& $formDescriptor

Definition at line 2148 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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler

Definition at line 891 of file hooks.txt.

◆ $handlerParams

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

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

◆ $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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check $image

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

Referenced by LinksUpdate::__construct(), ImageGalleryBase::add(), OutputPage::addHelpLink(), OutputPage::addReturnTo(), Skin::addToSidebarPlain(), OutputPageTest::assertFeedLinks(), RCCacheEntryFactoryTest::assertQueryLink(), SkinTemplate::buildContentNavigationUrls(), OutputPage::buildCssLinksArray(), ProtectionForm::buildForm(), SpecialEditWatchlist::buildRemoveLine(), Article::confirmDelete(), DifferenceEngine::deletedIdMarker(), SpecialReplaceText::doSpecialReplaceText(), MovePageForm::doSubmit(), SpecialRenameuser::execute(), SpecialApiHelp::execute(), DumpLinks::execute(), VectorTemplate::execute(), SpecialNewpages::filterLinks(), StubUserLang::findVariantLink(), IuConverter::findVariantLink(), KkConverter::findVariantLink(), KuConverter::findVariantLink(), ShiConverter::findVariantLink(), SrConverter::findVariantLink(), Language::findVariantLink(), LanguageConverter::findVariantLink(), ApiParse::formatCategoryLinks(), DateFormatter::formatDate(), ApiParse::formatLangLinks(), AncientPagesPage::formatResult(), MostcategoriesPage::formatResult(), MostinterwikisPage::formatResult(), MostlinkedPage::formatResult(), DeletedContribsPager::formatRevisionRow(), CategoryPager::formatRow(), ContribsPager::formatRow(), SpecialProtectedtitles::formatRow(), ImageListPager::formatValue(), CategoryViewer::generateLink(), MediaWiki\Widget\Search\FullSearchResultWidget::generateMainLinkHtml(), Block::getBlockErrorParams(), Skin::getCategoryLinks(), CreditsAction::getContributors(), Skin::getCopyright(), SpecialUndelete::getFileComment(), SpecialUndelete::getFileLink(), SpecialUndelete::getFileUser(), BaseTemplate::getFooterLinks(), ResourceLoaderModule::getHeaders(), OutputPage::getHeadLinksArray(), ApiHelp::getHelpInternal(), EnhancedChangesList::getLineData(), RevDelArchivedFileItem::getLink(), RevDelFileItem::getLink(), RenameuserLogFormatter::getMessageParameters(), TagLogFormatter::getMessageParameters(), ApiParamInfo::getModuleInfo(), SpecialUndelete::getPageLink(), WebInstaller::getPageListItem(), TablePager::getStartBody(), RevDelFileItem::getUserTools(), HistoryPager::historyLine(), ImagePage::imageDupes(), ImagePage::imageLinks(), ImageGalleryBase::insert(), SpecialWhatLinksHere::listItem(), Linker::makeCommentLink(), Linker::makeExternalLink(), Linker::makeHeadline(), DummyLinker::makeHeadline(), Parser::makeKnownLinkHolder(), BaseTemplate::makeListItem(), LogFormatter::makePageLink(), WebInstallerOptions::makeScreenshotsLink(), ChangesList::maybeWatchedLink(), RenameuserLogFormatter::myPageLink(), ImportStreamSource::newFromInterwiki(), ComposerPackageModifier::newMediaWikiLink(), SpecialPage::numLink(), Language::numLink(), ImagePage::openShowImage(), SpecialRecentChanges::optionsPanel(), SpecialSpecialpages::outputPageList(), LanguageConverter::parseCachedTable(), SkinTemplate::prepareQuickTemplate(), SpecialBlock::preText(), OutputPageTest::provideGetCategories(), ImageMap::render(), MediaWiki\Widget\Search\FullSearchResultWidget::render(), MediaWiki\Widget\Search\InterwikiSearchResultWidget::render(), MediaWiki\Widget\Search\SimpleSearchResultWidget::render(), Parser::renderImageGallery(), LinkHolderArray::replaceInternal(), Parser::replaceInternalLinks2(), LinkHolderArray::replaceInterwiki(), ChangesList::revDateLink(), Linker::revDeleteLink(), DifferenceEngine::revisionDeleteLink(), Linker::revUserLink(), Linker::revUserTools(), ComposerPackageModifier::setLinkAsProvides(), Article::showDeletedRevisionHeader(), DifferenceEngine::showDiffPage(), FileDeleteForm::showForm(), SpecialRevisionDelete::showForm(), SpecialWhatLinksHere::showIndirectLinks(), SpecialAutoblockList::showList(), SpecialBlockList::showList(), Article::showPatrolFooter(), SpecialPrefixindex::showPrefixChunk(), SpecialUndelete::showRevision(), MovePageForm::showSubpagesList(), SpecialUpload::showViewDeletedLinks(), OutputPage::styleLink(), Skin::subPageSubtitle(), ApiMain::substituteResultWithError(), OutputPageTest::testAddLink(), MediaWiki\Auth\AuthManagerTest::testAuthentication(), LinkRendererTest::testMergeAttribs(), BlockListPagerTest::testPreprocessResults(), TraditionalImageGallery::toHTML(), SpecialUndelete::undelete(), and CreditsAction::userLink().

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

Referenced by UploadForm::__construct(), OutputPage::addCategoryLinks(), OutputPage::addReturnTo(), OutputPage::buildBacklinkSubtitle(), ProtectionForm::buildForm(), MediaWiki\Special\SpecialPageFactory::capturePath(), SpecialPageFactory::capturePath(), MediaWiki\Linker\LinkRendererFactory::createForUser(), MediaWiki\Linker\LinkRendererFactory::createFromLegacyOptions(), LinkHolderArray::doVariants(), MediaWiki\Special\SpecialPageFactory::executePath(), SpecialPageFactory::executePath(), DeletedContribsPager::formatRevisionRow(), ContribsPager::formatRow(), AllMessagesTablePager::formatValue(), ImageListPager::formatValue(), BlockListPager::formatValue(), CategoryViewer::generateLink(), InfoAction::getContributors(), Preferences::getDefaultPreferencesFactory(), HistoryAction::getDescription(), RevisionItem::getDiffLink(), MWGrants::getGrantsLink(), SpecialPage::getLinkRenderer(), RevisionItem::getRevisionLink(), LogPage::getTitleLink(), HistoryPager::lastLink(), Linker::link(), ReplaceTextUtils::link(), InfoAction::pageInfo(), CategoryViewer::pagingLinks(), MarkpatrolledAction::preText(), LinkHolderArray::replaceInternal(), LinkHolderArray::replaceInterwiki(), ImportReporter::reportPage(), MediaWiki\Widget\Search\DidYouMeanWidget::rewrittenHtml(), SpecialPage::setLinkRenderer(), FileDeleteForm::showForm(), OutputPage::showPermissionsErrorPage(), SpecialSearch::showResults(), LinkRendererFactoryTest::testCreateForUser(), LinkRendererFactoryTest::testCreateFromLegacyOptions(), LinkRendererTest::testGetLinkClasses(), LinkRendererTest::testMakeBrokenLink(), LinkRendererTest::testMakeKnownLink(), LinkRendererTest::testMakeLink(), and LinkRendererTest::testMergeAttribs().

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

Referenced by LinksUpdate::__construct(), LinksUpdate::doUpdate(), MediaWiki\Storage\DerivedPageDataUpdater::getSecondaryDataUpdates(), 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 2626 of file hooks.txt.

◆ $mimeMagic

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response 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 2311 of file hooks.txt.

Referenced by File::checkExtensionCompatibility().

◆ $name

this hook is for auditing only 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 262 of file hooks.txt.

Referenced by MediaWiki\Auth\CreatedAccountAuthenticationRequest::__construct(), ResourceLoaderImage::__construct(), SpecialPage::__construct(), HTMLSelectLanguageField::__construct(), PoolCounterWorkViaCallback::__construct(), ApiContinuationManager::__construct(), MemcLockManager::__construct(), Wikimedia\Rdbms\Database::__construct(), FileOp::__construct(), __get(), __set(), ForeignTitle::__toString(), TitleValue::__toString(), Linker::accesskey(), MediaWiki\Storage\NameTableStore::acquireId(), MagicWordArray::add(), FormOptions::add(), MediaWiki\Config\ConfigRepository::add(), MigrateActors::addActorsForRows(), TestFileReader::addArticle(), ApiContinuationManager::addContinueParam(), ApiContinuationManager::addGeneratorContinueParam(), ApiContinuationManager::addGeneratorNonContinueParam(), OutputPage::addHeadItem(), HTMLForm::addHiddenField(), HTMLForm::addHiddenFields(), ParserOutput::addImage(), MediaHandler::addMeta(), ApiModuleManager::addModule(), Maintenance::addOption(), ApiQueryBase::addOption(), TestFileReader::addRequirement(), ContentHandler::addSearchField(), Wikimedia\Services\ServiceContainer::addServiceManipulator(), ApiQuerySiteinfo::appendInstalledLibraries(), ApiQuerySiteinfo::appendSkins(), ApiQuerySiteinfo::appendSubscribedHooks(), ExternalUserNames::applyPrefix(), Xml::attrib(), SearchEngine::augmentSearchResults(), Benchmarker::bench(), Parser::braceSubstitution(), MediaWiki\EditPage\TextboxBuilder::buildTextboxAttribs(), CentralIdLookup::centralIdFromName(), CheckStorage::check(), NamespaceDupes::checkAll(), FindOrphanedFiles::checkFiles(), PreprocessDump::checkOptions(), Maintenance::checkRequiredExtensions(), CleanupUsersWithNoId::cleanup(), FileBackendGroup::config(), LockManagerGroup::config(), FormOptions::consumeValue(), FormOptions::consumeValues(), Parser::createAssocArgs(), HTMLFormFieldCloner::createFieldsForKey(), User::createNew(), Wikimedia\Services\ServiceContainer::createService(), Sanitizer::decodeEntity(), Wikimedia\Services\ServiceContainer::defineService(), Wikimedia\Services\ServiceContainer::disableService(), GenderCache::doQuery(), XmlTypeCheck::elementOpen(), ApiBase::encodeParamName(), DeprecatedInterfaceFinder::enterNode(), Installer::envCheckCache(), ApiQueryReferences::execute(), ApiQueryUserContribs::execute(), LocalFileDeleteBatch::execute(), GetConfiguration::execute(), GenerateNormalizerDataAr::execute(), PHPUnitMaintClass::execute(), ParserTestRunner::executeSetupSnippets(), XmlTypeCheck::expandNS(), QuickTemplate::extend(), Parser::extensionSubstitution(), ExtensionProcessor::extractCredits(), ExtensionProcessor::extractHooks(), ExtensionProcessor::extractInfo(), ExtensionProcessor::extractMessagesDirs(), InputBox::extractOptions(), BatchRowIterator::extractPrimaryKeys(), ExtensionProcessor::extractResourceLoaderModules(), FormOptions::fetchValuesFromRequest(), Wikimedia\Rdbms\Database::fieldNameWithAlias(), CleanupImages::filePath(), ExecutableFinder::findExecutable(), ApiAuthManagerHelper::formatFields(), ApiParse::formatLimitReportData(), ApiRsd::formatRsdApiList(), MediaWiki\Config\ConfigRepository::get(), EtcdConfig::get(), HashConfig::get(), FileBackendGroup::get(), LockManagerGroup::get(), QuickTemplate::get(), MediaWiki\Special\SpecialPageFactory::getAliasList(), FormOptions::getAllValues(), RecentChange::getAttribute(), ExtensionRegistry::getAttribute(), XmlSelect::getAttribute(), XmlTypeCheck::getAttributesArray(), MagicWordArray::getBaseRegex(), MessageBlobStore::getBlobs(), JobQueueGroup::getCachedConfigVar(), MWNamespace::getCanonicalIndex(), User::getCanonicalName(), LinksUpdate::getCategoryInsertions(), FormOptions::getChangedValues(), EditPage::getCheckboxesWidget(), SiteConfiguration::getConfig(), FauxRequest::getCookie(), FauxResponse::getCookie(), FauxResponse::getCookieData(), MultiHttpClient::getCurlHandle(), ResourceLoaderClientHtml::getData(), MediaWiki\Config\ConfigRepository::getDescriptionOf(), Language::getDurationIntervals(), Timing::getEntryByName(), MediaWikiPHPUnitTestListener::getErrorName(), AvroValidator::getErrors(), FormatMetadata::getExtendedMetadataFromFile(), MediaWiki\Storage\NameTableStore::getFieldsToStore(), MediaWiki\Logger\MonologSpi::getFormatter(), ApiPageSet::getGenerators(), JobQueueRedis::getGlobalKey(), WebRequest::getGPCVal(), MediaWiki\Logger\MonologSpi::getHandler(), Hooks::getHandlers(), MagicWordArray::getHash(), WebRequest::getHeader(), ApiHelp::getHelpInternal(), Linker::getImageLinkMTOParams(), Parser::getImageParams(), XhprofData::getInclusiveMetrics(), Wikimedia\Rdbms\Database::getLBInfo(), ContentHandler::getLocalizedName(), WikiEditorHooks::getMagicWords(), ParserFuzzTest::getMemoryBreakdown(), ResourceLoader::getModule(), ApiParamInfo::getModuleInfo(), FileRepo::getName(), PPNode_Hash_Tree::getName(), PPNode_Hash_Attr::getName(), ResourceLoaderImage::getName(), WebRequestUpload::getName(), ApiQuery::getNamedDB(), FileRepo::getNameFromTitle(), ApiModuleManager::getNames(), Language::getNamespaceAliases(), MediaWikiTitleCodec::getNamespaceName(), ApiModuleManager::getNamesWithClasses(), HTMLFormField::getNearestFieldByName(), CategoryTree::getOption(), CategoryTreePage::getOption(), ParserOptions::getOption(), Maintenance::getOption(), MediaWiki\Preferences\DefaultPreferencesFactory::getOptionFromUser(), User::getOptionKinds(), RecentChange::getParam(), FileOp::getParam(), ParserTestRunner::getParserTestFiles(), TimelessTemplate::getPortlet(), MonoBookTemplate::getPortlet(), MediaWiki\Logger\MonologSpi::getProcessor(), OutputPage::getProperty(), ParserOutput::getProperty(), MediaWiki\Session\SessionManager::getProvider(), MediaWiki\Session\ImmutableSessionProviderWithCookieTest::getProvider(), MediaWiki\Session\BotPasswordSessionProviderTest::getProvider(), WebRequest::getRawVal(), MediaWiki\Special\SpecialPageFactory::getRegularPages(), MediaWiki\Special\SpecialPageFactory::getRestrictedPages(), OutputPage::getRlClient(), OracleInstaller::getSchemaVars(), Wikimedia\Rdbms\LoadBalancer::getServerName(), Wikimedia\Services\ServiceContainer::getService(), WebInstaller::getSession(), ApiAuthManagerHelper::getStandardParams(), ResourceLoaderImageTest::getTestImage(), MediaWikiPHPUnitTestListener::getTestName(), ForeignAPIRepo::getThumbUrlFromCache(), ApiTokens::getTokenTypes(), FormOptions::getUnconsumedValues(), ApiMain::getUpload(), MediaWiki\Special\SpecialPageFactory::getUsablePages(), ApiMain::getVal(), MediaWiki\Config\ConfigRepository::getValueOf(), WebRequest::getValues(), Installer::getVar(), Language::getVariantname(), FileRepo::getVirtualUrl(), SiteConfiguration::getWikiParams(), GlobalVarConfig::getWithPrefix(), ConvertExtensionToRegistration::handleCredits(), ConvertExtensionToRegistration::handleResourceModules(), GlobalVarConfig::hasWithPrefix(), User::idFromName(), Wikimedia\Services\ServiceContainer::importWiring(), WebRequest::initHeaders(), UploadBase::initializePathInfo(), Xml::input(), Html::input(), LinksUpdate::invalidateProperties(), ResourceLoader::isFileModule(), LogPager::limitPerformer(), HTMLForm::loadData(), User::loadDefaults(), User::loadFromCache(), MediaWiki\Preferences\DefaultPreferencesFactory::loadPreferenceValues(), BotPassword::login(), ApiMain::logRequest(), Skin::makeInternalOrExternalUrl(), ResourceLoaderClientHtml::makeLoad(), ResourceLoader::makeModuleResponse(), FiltersTest::makeMultiUsernameFilter(), Title::makeName(), ResourceLoader::makeVersionQuery(), ApiFormatXml::mangleName(), MagicWordArray::matchAndRemove(), ParserOptions::matches(), MediaWiki\Auth\AuthenticationRequest::mergeFieldInfo(), MediaWikiTestCase::mergeMwGlobalArrayValue(), FileRepo::nameForThumb(), User::newFromName(), Sanitizer::normalizeEntity(), MediaWiki\Storage\NameTableStore::normalizeName(), FormOptions::offsetUnset(), SpecialChangeCredentials::onAuthChangeFormFields(), CoreParserFunctions::pagesincategory(), Wikimedia\Services\ServiceContainer::peekService(), Installer::performInstallation(), MediaWiki\Tests\Storage\NameTableStoreTest::populateTable(), Title::prefix(), ResourceLoader::preloadModuleInfo(), ApiQueryBlocks::prepareUsername(), Preprocessor_Hash::preprocessToObj(), MediaWiki\Preferences\DefaultPreferencesFactory::profilePreferences(), PasswordPolicyStructureTest::provideChecks(), MediaWikiServicesTest::provideGetService(), MediaWikiServicesTest::provideGetters(), ActorMigrationTest::provideGetWhere(), MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::providerNormalizeUsername(), SpecialPageFatalTest::provideSpecialPages(), MediaWiki\Tests\Storage\NameTableStoreTest::provideTestGetAndAcquireIdNameNormalization(), TestFileReader::read(), ZipDirectoryReader::readCentralDirectory(), Wikimedia\Rdbms\TransactionProfiler::recordQueryCompletion(), Wikimedia\Services\ServiceContainer::redefineService(), Hooks::register(), SkinFactory::register(), ResourceLoader::register(), LockManagerGroup::register(), FileBackendGroup::register(), BackupDumper::registerFilter(), BackupDumper::registerOutput(), HTMLFormFieldCloner::rekeyValuesArray(), Wikimedia\Rdbms\DatabasePostgres::remappedTableName(), VectorTemplate::renderPortal(), Maintenance::requireExtension(), FormOptions::reset(), MediaWiki\Special\SpecialPageFactory::resolveAlias(), ResourceLoader::respond(), ApiQueryAllLinks::run(), ConfigFactory::salvage(), CategoryFinder::scanNextLayer(), SearchEngineConfig::searchableNamespaces(), Wikimedia\Rdbms\DatabasePostgres::selectSQLText(), ApiMain::sendCacheHeaders(), HashConfig::set(), QuickTemplate::set(), XmlSelect::setAttribute(), ExtensionRegistry::setAttributeForTest(), SearchResultSet::setAugmentedData(), ApiResult::setContentField(), FauxResponse::setCookie(), WebResponse::setCookie(), FauxRequest::setCookies(), MediaWiki::setDBProfilingAgent(), MWHttpRequest::setHeader(), FauxRequest::setHeaders(), OutputPage::setHTMLTitle(), MediaWikiTestCase::setIniSetting(), Wikimedia\Rdbms\Database::setLBInfo(), ParserOutput::setLimitReportData(), HTMLForm::setName(), ParserOptions::setOption(), OutputPage::setProperty(), ParserOutput::setProperty(), QuickTemplate::setRef(), GuzzleHttpRequestTester::setRespHeaders(), CurlHttpRequestTester::setRespHeaders(), PhpHttpRequestTester::setRespHeaders(), MediaWikiTestCase::setService(), WebInstaller::setSession(), HTMLForm::setSubmitName(), HTMLForm::setSubmitTooltip(), Wikimedia\Rdbms\Database::setTransactionListener(), Wikimedia\Rdbms\LoadBalancer::setTransactionListener(), JobQueueTest::setUp(), FormOptions::setValue(), ApiResult::setValue(), Installer::setVar(), WebInstaller::setVarsFromRequest(), Wikimedia\Rdbms\LBFactory::setWaitForReplicationListener(), SpecialWatchlist::showHideCheck(), UserOptionsMaintenance::showUsageStats(), PPNode_DOM::splitArg(), UploadBase::splitXmlNamespace(), TextPassDumper::startElement(), ExtensionProcessor::storeToArray(), WebInstallerName::submit(), MediaWiki\Session\CookieSessionProvider::suggestLoginUsername(), Wikimedia\Rdbms\Database::tableName(), Wikimedia\Rdbms\DatabaseSqlite::tableName(), Wikimedia\Rdbms\Database::tableNames(), CoreParserFunctions::tagObj(), TextContentHandlerTest::testFieldsForIndex(), ApiQuerySiteinfoTest::testInstalledLibraries(), ApiQuerySiteinfoTest::testLanguages(), ApiMoveTest::testMoveSubpages(), SearchEngineTest::testSearchIndexFields(), UploadTestHandler::testTitleValidation(), Html::textarea(), Wikimedia\Rdbms\TransactionProfiler::transactionWritingIn(), Wikimedia\Rdbms\TransactionProfiler::transactionWritingOut(), ApiResult::unsetValue(), RecentChangesUpdateJob::updateActiveUsers(), SectionProfiler::updateEntry(), UpdateExtensionJsonSchema::updateTo2(), XmlTypeCheck::validate(), FormOptions::validateBounds(), CliInstaller::validateExtensions(), ApiBase::validateUser(), wfArrayPlus2d(), wfIsBadImage(), and wfStripIllegalFilenameChars().

◆ $namespaces

namespace and then decline to actually register it& $namespaces

Definition at line 926 of file hooks.txt.

Referenced by ApiQuerySiteinfo::appendNamespaceAliases(), ChangesListSpecialPage::buildQuery(), CategoryTree::decodeNamespaces(), PrefixSearch::defaultSearchBackend(), FixDefaultJsonContentPages::doDBUpdates(), ReplaceTextSearch::doSearchQuery(), SpecialAllPages::execute(), SpecialPrefixindex::execute(), CategoryTreePage::executeInputForm(), MediaWikiTestCase::getDefaultWikitextNS(), ApiHelp::getHelpInternal(), ReplaceTextSearch::getMatchingTitles(), BlockLogFormatter::getMessageParameters(), SpecialSearch::getNamespaces(), Languages::getProblematicProjectTalks(), InputBox::getSearchForm(), PrefixSearch::handleResultFromHook(), Title::inNamespaces(), HTMLNamespacesMultiselectField::loadDataFromRequest(), SearchEngine::namespacesAsText(), SearchEngineConfig::namespacesAsText(), SpecialReplaceText::namespaceTables(), ShortPagesPage::reallyDoQuery(), CategoryTree::renderChildren(), SearchExactMatchRescorer::rescore(), ApiQueryDuplicateFiles::run(), ApiQueryAllDeletedRevisions::run(), PrefixSearch::search(), PrefixSearch::searchBackend(), PrefixSearchTest::searchProvision(), SearchEnginePrefixTest::searchProvision(), PrefixSearch::searchWithVariants(), SearchEngine::setNamespaces(), Language::setNamespaces(), BackupReader::setNsfilter(), AutoloadGenerator::setPsr4Namespaces(), SpecialAllPages::showChunk(), SpecialReplaceText::showForm(), SpecialPrefixindex::showPrefixChunk(), SearchEngineTest::testCompletionSearchMustRespectCapitalLinkOverrides(), SearchEngineTest::testParseNamespacePrefix(), PrefixSearchTest::testSearch(), PrefixSearchTest::testSearchWithOffset(), ImportTest::testSiteInfoContainsNamespaces(), PrefixSearch::titleSearch(), HTMLNamespacesMultiselectField::validate(), and PrefixSearch::validateNamespaces().

◆ $newminor

also included in $newHeader if any $newminor

Definition at line 1270 of file hooks.txt.

Referenced by DifferenceEngine::showDiffPage().

◆ $newtalks

the value of this variable comes from LanguageConverter indexed by page_id indexed by prefixed DB keys on which the links will be shown can modify can modify can modify this should be populated with an alert message to that effect $newtalks

Definition at line 1717 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 1287 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 1999 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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out

Definition at line 854 of file hooks.txt.

◆ $output

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output

static

Definition at line 2264 of file hooks.txt.

◆ $parser

function wfGetCustomMagicWordValue $parser

Initial value:

{

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

$parser

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

Definition hooks.txt:1834

Definition at line 1804 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 1582 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 1614 of file hooks.txt.

◆ $refreshCache

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

Definition at line 1628 of file hooks.txt.

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

◆ $req

this hook is for auditing only $req

Definition at line 956 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 2820 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 768 of file hooks.txt.

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

◆ $res

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

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

◆ $ResourceLoader

& $ResourceLoader

Definition at line 2864 of file hooks.txt.

◆ $response

this hook is for auditing only $response

Definition at line 778 of file hooks.txt.

Referenced by _recaptcha_http_post(), MWHttpRequestTestCase::assertResponseFieldValue(), ApiMain::checkMaxLag(), Block::clearCookie(), EtcdConfigTest::createEtcdResponse(), ApiFormatBaseTest::encodeData(), LoginSignupSpecialPage::execute(), SpecialChangeCredentials::execute(), SpecialLinkAccounts::execute(), SpecialUnlinkAccounts::execute(), GuzzleHttpRequest::execute(), RunJobs::execute(), SpecialPageExecutor::executeSpecialPage(), EtcdConfig::fetchAllFromEtcd(), EtcdConfig::fetchAllFromEtcdServer(), ApiLogin::getAuthenticationResponseLogData(), ReCaptcha::getCaptchaParamsFromRequest(), ReCaptchaNoCaptcha::getCaptchaParamsFromRequest(), ApiMainTest::getNonInternalApiMain(), ApiMain::handleCORS(), ApiMain::handleException(), ParserEditTests::handleFailure(), AuthManagerSpecialPage::handleFormSubmit(), SpecialChangeCredentials::handleFormSubmit(), SpecialUnlinkAccounts::handleFormSubmit(), BotPassword::loginHook(), RawAction::onView(), OutputPage::output(), ReCaptchaNoCaptcha::passCaptcha(), ReCaptcha::passCaptcha(), MediaWiki\Session\CookieSessionProvider::persistSession(), MediaWiki\Session\ImmutableSessionProviderWithCookie::persistSession(), CaptchaPreAuthenticationProvider::postAuthentication(), MediaWiki\Auth\ThrottlePreAuthenticationProvider::postAuthentication(), recaptcha_check_answer(), ResourceLoader::respond(), WebRequest::response(), JobRunner::run(), MediaWiki\Logger\Monolog\KafkaHandler::send(), OutputPage::sendCacheControl(), ApiMain::sendCacheHeaders(), MediaWiki\Session\CookieSessionProvider::setForceHTTPSCookie(), EditPage::setPostEditCookie(), SpecialUndelete::showFile(), MediaWiki\Auth\AuthManagerTest::testAccountCreation(), MediaWiki\Auth\AuthManagerTest::testAccountLink(), MediaWiki\Auth\AuthManagerTest::testAuthentication(), ApiMainTest::testConditionalRequestHeadersOutput(), ApiFormatBaseTest::testDisable(), SpecialPageDataTest::testExecute(), ApiFormatBaseTest::testFilenameEncoding(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest::testGetAuthenticationRequests(), MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProviderTest::testGetAuthenticationRequests(), MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProviderTest::testGetAuthenticationRequests(), MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProviderTest::testGetAuthenticationRequests(), PageDataRequestHandlerTest::testHandleRequest(), ApiQuerySearchTest::testInterwikiResults(), ResourceLoaderTest::testMakeModuleResponseConcat(), ResourceLoaderTest::testMakeModuleResponseEmpty(), ResourceLoaderTest::testMakeModuleResponseError(), ResourceLoaderTest::testMakeModuleResponseErrorCSS(), ResourceLoaderTest::testMakeModuleResponseExtraHeaders(), ResourceLoaderTest::testMakeModuleResponseExtraHeadersMulti(), ResourceLoaderTest::testMakeModuleResponseStartupError(), MultiHttpClientTest::testMultiHttpClientMultipleFailure(), MultiHttpClientTest::testMultiHttpClientMultipleSuccess(), ApiFormatBaseTest::testNullMimeType(), ApiQueryPrefixSearchTest::testOffsetContinue(), ApiOptionsTest::testOptionManupulation(), MediaWikiTest::testPostSendJobDoesNotSetCookie(), BatchRowUpdateTest::testReaderBasicIterate(), ApiOptionsTest::testReset(), ApiOptionsTest::testResetChangeOption(), ApiOptionsTest::testResetKinds(), ApiQuerySearchTest::testSearchResults(), ResourceLoader::tryRespondFromFileCache(), MediaWiki\Session\CookieSessionProvider::unpersistSession(), MediaWiki\Session\ImmutableSessionProviderWithCookie::unpersistSession(), and wfStreamThumb().

◆ $result

namespace being checked& $result

Definition at line 2341 of file hooks.txt.

Referenced by MemcachedClient::_fgets(), MemcachedClient::_fread(), MemcachedClient::_fwrite(), ChangeTags::activateTagWithChecks(), RedisBagOStuff::add(), MockCompletionSearchEngine::addMockResults(), MockSearchEngine::addMockResults(), ChangeTags::addTagsAccompanyingChangeWithChecks(), ParserEditTests::alternatingAligned(), FileOp::attemptAsync(), Parser::callParserFunction(), RedisBagOStuff::changeTTL(), Autopromote::checkCondition(), SqliteInstaller::checkPrerequisites(), MemcachedPeclBagOStuff::checkResult(), BlockLevelPass::closeParagraph(), AbstractContent::convert(), ChangeTags::createTagWithChecks(), ChangeTags::deactivateTagWithChecks(), RedisBagOStuff::delete(), MediaWiki\Block\BlockRestrictionStore::delete(), RedisBagOStuff::deleteMulti(), SqlBagOStuff::deleteMulti(), ChangeTags::deleteTagWithChecks(), Skin::doEditSectionLink(), MemcachedPeclBagOStuff::doGet(), RedisBagOStuff::doGet(), JobQueueFederated::doGetSiblingQueueSizes(), MediaWiki\Extensions\ParserFunctions\ExprParser::doOperation(), ParserEditTests::dwdiff(), PoolCounterWork::execute(), RecountCategories::execute(), PasswordReset::execute(), ResourceLoaderFileModule::expandPackageFiles(), MediaWiki\Sparql\SparqlClient::extractData(), SearchResultSet::extractResults(), MockSearchResultSet::extractResults(), FileRepo::fileExistsBatch(), ResourceLoader::filter(), LocalRepo::findBySha1(), RepoGroup::findBySha1(), FileRepo::findBySha1s(), LocalRepo::findBySha1s(), RepoGroup::findBySha1s(), FileRepo::findFiles(), TitleTest::flattenErrorsArray(), MediaWiki\Logger\Monolog\AvroFormatter::formatBatch(), ApiParse::formatCategoryLinks(), ApiParse::formatHeadItems(), ApiParse::formatIWLinks(), ApiParse::formatLangLinks(), ApiParse::formatLimitReportData(), ApiParse::formatLinks(), SvgHandler::formatMetadata(), MediaHandler::formatMetadataHelper(), DoubleRedirectsPage::formatResult(), MediaHandlerTest::generateTestFitBoxWidthData(), LinksUpdate::getAddedExternalLinks(), LinksUpdate::getAddedLinks(), UsersPager::getAllGroups(), ApiImport::getAllowedImportSources(), ApiImageRotate::getAllowedParams(), ApiPageSet::getAllowedParams(), ApiPurge::getAllowedParams(), ApiQuery::getAllowedParams(), ApiSetNotificationTimestamp::getAllowedParams(), ApiWatch::getAllowedParams(), ResourceLoaderFileModule::getAllStyleFiles(), ApiQueryInfo::getAllVariants(), ChangesListSpecialPage::getChangeTagList(), ApiUpload::getChunkResult(), AvroValidator::getErrors(), StatusValue::getErrorsByType(), ForeignTitle::getFullText(), PageProps::getGoodIDs(), WikiPage::getHiddenCategories(), TitleBlacklist::getHttp(), ApiPageSet::getInvalidTitlesAndRevisions(), ApiQueryGadgets::getList(), Category::getMembers(), GenerateJqueryMsgData::getMessagesAndTests(), RedisBagOStuff::getMulti(), WANObjectCache::getMulti(), ApiModuleManager::getNames(), ApiModuleManager::getNamesWithClasses(), LanguageCode::getNonstandardLanguageCodeMapping(), BackupReader::getNsIndex(), ProfilerExcimer::getOutput(), RightsLogFormatter::getParametersForApi(), SyntaxHighlightAce::getPygmentsToAceMap(), LinksUpdate::getRemovedLinks(), DnsSrvDiscoverer::getServers(), ApiUpload::getStashResult(), Status::getStatusArray(), SpecialEditTags::getTagSelect(), TextSlotDiffRenderer::getTextDiff(), ApiUpload::getWarningsResult(), User::idFromName(), MediaWiki\Extensions\ParserFunctions\ParserFunctions::ifexprObj(), RedisBagOStuff::incr(), SqlBagOStuff::insertMulti(), MemoizedCallable::invokeArgs(), MWNamespace::isMovable(), Title::isMovable(), MediaWiki\Interwiki\ClassicInterwikiLookup::isValidInterwiki(), User::loadFromSession(), EditPage::mergeChangesIntoContent(), ApiQuerySearchTest::mockResultClosure(), StatusValue::newFatal(), SearchResult::newFromTitle(), StatusValue::newGood(), RestbaseVirtualRESTService::onParsoidRequests(), ParsoidVirtualRESTService::onRequests(), SwiftVirtualRESTService::onRequests(), VirtualRESTService::onRequests(), RestbaseVirtualRESTService::onRequests(), SwiftVirtualRESTService::onResponses(), BlockLevelPass::openList(), InfoAction::pageCounts(), TitleBlacklist::parseBlacklist(), ApiUpload::performUpload(), User::pingLimiter(), ApiPageSet::populateGeneratorData(), SpecialPage::prefixSearchString(), CategoryTreePage::prefixSearchSubpages(), FileDuplicateSearchPage::prefixSearchSubpages(), ContentSecurityPolicy::prepareUrlForCSP(), Argon2PasswordTest::providePasswordTests(), ApiQueryContinueTestBase::query(), AutoloadGenerator::readFile(), AllMessagesTablePager::reallyDoQuery(), SqliteInstaller::realpath(), Cite::recursiveFetchRefsFromDB(), SearchExactMatchRescorer::redirectTargetsToRedirect(), MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::render(), MediaWiki\Widget\Search\SimpleSearchResultSetWidget::render(), Wikimedia\Rdbms\Database::resultObject(), Wikimedia\Rdbms\DatabaseMssql::resultObject(), MediaWiki\Permissions\PermissionManager::resultToError(), Title::resultToError(), MediaWiki\Extensions\ParserFunctions\ParserFunctions::runCount(), MediaWiki\Extensions\ParserFunctions\ParserFunctions::runExplode(), MediaWiki\Tests\Permissions\PermissionManagerTest::runGroupPermissions(), TitlePermissionTest::runGroupPermissions(), MediaWiki\Extensions\ParserFunctions\ParserFunctions::runReplace(), MediaWiki\Extensions\ParserFunctions\ParserFunctions::runSub(), ParserEditTests::runTests(), MediaWiki\Preferences\DefaultPreferencesFactory::saveFormData(), RedisBagOStuff::set(), User::setEmailWithConfirmation(), RedisBagOStuff::setMulti(), HTMLForm::show(), HTMLForm::showAlways(), StoreBatchTest::storeit(), ArrayBackedMemoizedCallable::storeResult(), FileRepo::storeTemp(), SqliteInstaller::submitConnectForm(), SkinTemplate::tabAction(), MediaWiki\Extensions\ParserFunctions\ParserFunctions::timeCommon(), Password::toString(), FileBackendDBRepoWrapper::translateArrayResults(), SimpleCaptcha::triggersCaptcha(), HTMLForm::tryAuthorizedSubmit(), Block::update(), MediaWiki\Block\BlockRestrictionStore::update(), MediaWiki\Block\BlockRestrictionStore::updateByParentBlockId(), WikiPage::updateRevisionOn(), ChangeTags::updateTagsWithChecks(), UploadSourceAdapter::url_stat(), HTMLNamespacesMultiselectField::validate(), HTMLTitlesMultiselectField::validate(), HTMLUsersMultiselectField::validate(), Sanitizer::validateEmail(), ApiTag::validateLogId(), UploadBase::validateName(), UploadBase::verifyUpload(), wfAssembleUrl(), wfClientAcceptsGzip(), wfGenerateThumbnail(), wfUnpack(), and Status::wrap().

◆ $ret

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

Definition at line 2000 of file hooks.txt.

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

◆ $revert

returning false will NOT prevent logging a wrapping ErrorException create2 Corresponds to logging log_action database field and which is displayed in the UI& $revert

Definition at line 2196 of file hooks.txt.

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

◆ $rollback

also included in $newHeader $rollback

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

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

◆ $services

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response 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 2275 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 2007 of file hooks.txt.

Referenced by ApiQuerySiteinfo::appendSkins(), ResourceLoaderOOUIFileModule::extendSkinSpecific(), ResourceLoaderStartUpModule::getConfigSettings(), ResourceLoaderImageModule::getGlobalVariants(), ResourceLoaderImageModule::getImages(), RequestContext::getSkin(), ResourceLoaderContext::getSkin(), ResourceLoaderOOUIImageModule::loadFromDefinition(), SkinFactory::makeSkin(), RequestContext::setSkin(), ApiParseTest::setupSkin(), and WebInstallerOptions::submit().

◆ $suppressed

returning false will NOT prevent logging a wrapping ErrorException $suppressed

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

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

◆ $tables

this hook is for auditing only 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.

Referenced by ChangesListSpecialPage::__construct(), SpecialRecentChanges::__construct(), UploadFromUrlTestSuite::addTables(), SiteStatsInit::articles(), ChangesListSpecialPageTest::buildQuery(), ChangesListSpecialPage::buildQuery(), IndexPager::buildQueryInfo(), RangeChronologicalPager::buildQueryInfo(), ActiveUsersPager::buildQueryInfo(), ReplaceTextSearch::categoryCondition(), Sqlite::checkSqlSyntax(), CompressOld::compressWithConcat(), MediaWikiTestCase::copyTestData(), LocalFileDeleteBatch::doDBInserts(), PopulateLogSearch::doDBUpdates(), ChangesListSpecialPage::doMainQuery(), SpecialRecentChanges::doMainQuery(), SpecialWatchlist::doMainQuery(), SpecialRecentChangesLinked::doMainQuery(), MysqlUpdater::doNamespaceSize(), RevDelArchiveList::doQuery(), UserCache::doQuery(), ReplaceTextSearch::doSearchQuery(), MediaWikiTestCase::dropMockTables(), WikiExporter::dumpPages(), FixDoubleRedirects::execute(), ChangesListSpecialPageTest::fetchUsers(), ChangesListSpecialPage::filterOnUserExperienceLevel(), Title::getCascadeProtectionSources(), WikiPage::getContributors(), LocalFile::getHistory(), ActorMigration::getJoin(), CommentStore::getJoin(), ReplaceTextSearch::getMatchingTitles(), ActiveUsersPager::getQueryInfo(), RandomPage::getQueryInfo(), LogPager::getQueryInfo(), NewFilesPager::getQueryInfo(), NewPagesPager::getQueryInfo(), AncientPagesPage::getQueryInfo(), LonelyPagesPage::getQueryInfo(), ShortPagesPage::getQueryInfo(), ImageListPager::getQueryInfoReal(), ChangesListSpecialPage::getRows(), DatabaseLogEntry::getSelectQueryData(), PopulateContentTables::getTables(), WatchedItemQueryService::getWatchedItemsWithRCInfoQueryTables(), WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo(), ActorMigration::getWhere(), ApiPageSet::initFromRevIDs(), ParserTestRunner::listTables(), MediaWikiTestCase::listTables(), UserDupes::lock(), LocalIdLookup::lookupCentralIds(), LocalIdLookup::lookupUserNames(), ChangeTags::makeTagSummarySubquery(), ChangeTags::modifyDisplayQuery(), ChangesListBooleanFilter::modifyQuery(), ChangesListBooleanFilterGroup::modifyQuery(), ChangesListStringOptionsFilterGroup::modifyQuery(), ChangesListStringOptionsFilterGroupTest::modifyQueryHelper(), SpecialReplaceText::namespaceTables(), InfoAction::pageCounts(), PopulateContentTables::populateTable(), QueryPage::reallyDoQuery(), ShortPagesPage::reallyDoQuery(), IndexPager::reallyDoQuery(), ContribsPager::reallyDoQuery(), ImageListPager::reallyDoQuery(), MediaWikiTestCase::recloneMockTables(), LocalFile::recordUpload2(), SpecialWatchlist::registerFilters(), CategoryTree::renderChildren(), ChangesListSpecialPage::runMainQueryHook(), UserNamePrefixSearch::search(), Wikimedia\Rdbms\DatabaseMssql::selectSQLText(), CategoryChangesAsRdf::setupChangesIterator(), SpecialReplaceText::showForm(), Wikimedia\Rdbms\Database::tableNamesWithAlias(), Wikimedia\Rdbms\Database::tableNamesWithIndexClauseOrJOIN(), ParserTestRunner::teardownDatabase(), WatchedItemQueryServiceUnitTest::testGetWatchedItemsWithRecentChangeInfo_extension(), ChangesListStringOptionsFilterGroupTest::testModifyQuery(), ChangesListStringOptionsFilterGroupTest::testNoOpModifyQuery(), DatabaseTest::testTableNamesWithIndexClauseOrJOIN(), and DatabaseSqliteTest::testUpgrades().

◆ $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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping $template

◆ $term

whereas SearchGetNearMatch runs after $term

Definition at line 2888 of file hooks.txt.

◆ $time

returning false will NOT prevent logging a wrapping ErrorException create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment $time

Definition at line 1802 of file hooks.txt.

Referenced by OldLocalFile::__construct(), Wikimedia\Rdbms\LoadBalancer::approveMasterChanges(), MediaWiki\Shell\Command::buildFinalCommand(), ApiFormatBase::closePrinter(), JobRunner::commitMasterChanges(), DBFileJournal::doGetPositionAtTime(), FileBackendTest::doTestGetFileStat(), PoolWorkArticleView::doWork(), MediaWikiPHPUnitTestListener::endTest(), LoginSignupSpecialPage::execute(), SyncFileBackend::execute(), Parser::fetchFileAndTitle(), FileRepo::findFile(), FileRepo::findFileFromKey(), MediaWiki\Logger\LegacyLogger::formatAsWfDebugLog(), FileDuplicateSearchPage::formatResult(), MIMEsearchPage::formatResult(), SpecialNewpages::formatRow(), NewFilesPager::formatRow(), User::getEditTimestamp(), ProtectionForm::getExpiry(), SpecialUndelete::getFileLink(), Language::getHumanTimestamp(), Wikimedia\Rdbms\DatabaseMysqlBase::getLagFromPtHeartbeat(), WANObjectCache::getMultiCheckKeyTime(), SpecialUndelete::getPageLink(), FileJournal::getPositionAtTime(), TextSlotDiffRenderer::getTextDiff(), SectionProfiler::getTime(), UIDGenerator::getTimestampedID128(), UIDGenerator::getTimestampedID88(), UIDGenerator::intervalsSinceGregorianBinary(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::isTimestampValid(), ApiStashEdit::lastEditTime(), SpecialUndelete::loadRequest(), LogEventsList::logLine(), ApiMain::logRequest(), DummyLinker::makeBrokenImageLinkObj(), Linker::makeBrokenImageLinkObj(), FormatMetadata::makeFormattedData(), Parser::makeImage(), DummyLinker::makeImageLink(), Linker::makeImageLink(), DummyLinker::makeMediaLinkObj(), Linker::makeMediaLinkObj(), DummyLinker::makeThumbLink2(), Linker::makeThumbLink2(), UIDGenerator::millisecondsSinceEpochBinary(), FileRepo::newFile(), ForeignAPIRepo::newFile(), OldLocalFile::newFromTitle(), User::newTouchedTimestamp(), IPTC::parse(), MediaWiki\Preferences\DefaultPreferencesFactory::profilePreferences(), ZipDirectoryReader::readCentralDirectory(), WatchedItemStore::resetNotificationTimestamp(), MapCacheLRU::setMockTime(), BagOStuff::setMockTime(), WANObjectCache::setMockTime(), EmailConfirmation::showRequestForm(), SpecialUndelete::showRevision(), MediaWiki\Session\CookieSessionProviderTest::testCookieData(), LBFactoryTest::testCPPosIndexCookieValues(), ParserOutputTest::testGetCacheTime(), 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(), PrefixingStatsdDataFactoryProxy::timing(), and Language::translateBlockExpiry().

◆ $title

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

Definition at line 949 of file hooks.txt.

◆ $unhide

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

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

Referenced by UploadFromStash::__construct(), ImageListPager::__construct(), SpecialOATHDisable::__construct(), SpecialOATHEnable::__construct(), MediaWiki\Revision\RevisionArchiveRecord::__construct(), MediaWiki\Revision\RevisionStoreRecord::__construct(), UserEditCountUpdate::__construct(), UploadFromChunks::__construct(), ApiTestCase::doApiRequest(), ApiQueryImageInfo::execute(), ApiQueryUserContribs::execute(), DeleteBatch::execute(), DeleteDefaultMessages::execute(), DeleteEqualMessages::execute(), ImportImages::execute(), ImportSiteScripts::execute(), RollbackEdits::execute(), WrapOldPasswords::execute(), MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProviderTest::getBlockedUser(), User::getInstanceForUpdate(), WatchActionTest::getLoggedInIsWatchedUser(), Skin::getRelevantUser(), LinksUpdate::getTriggeringUser(), CategoryMembershipChange::getUser(), RequestContext::getUser(), ResourceLoaderContext::getUser(), BlockTest::getUserForBlocking(), LogEventsList::getUserInputDesc(), ApiBase::getWatchlistUser(), RequestContext::importScopedSession(), ParserOptions::initialiseFromUser(), ReassignEdits::initialiseUser(), CentralIdLookup::localUserFromCentralId(), BotPassword::loginHook(), UserEditCountUpdate::merge(), MovePage::move(), RecentChange::newForCategorization(), User::newFromAnyId(), User::newFromRow(), User::newFromSession(), RecentChange::newLogEntry(), MediaWiki\Revision\RevisionStore::newRevisionFromRow(), User::newSystemUser(), RecentChange::notifyEdit(), RecentChange::notifyNew(), SpecialChangeContentModel::onSubmit(), PostgresInstaller::openConnectionToAnyDB(), ParserTestRunner::perTestSetup(), ApiQueryBlocks::prepareUsername(), MediaWiki\Tests\Revision\RevisionArchiveRecordTest::provideConstructor(), MediaWiki\Tests\Revision\RevisionStoreRecordTest::provideConstructor(), MediaWiki\Tests\Revision\RevisionArchiveRecordTest::provideConstructorFailure(), MediaWiki\Tests\Revision\RevisionStoreRecordTest::provideConstructorFailure(), RevisionDbTestBase::provideInsertOn_exceptionOnIncomplete(), CaptchaPreAuthenticationProviderTest::provideTestForAccountCreation(), Block::setBlocker(), DataUpdate::setCause(), PreferencesFormOOUI::setModifiedUser(), LoginSignupSpecialPage::setSessionUserForCurrentRequest(), LinksUpdate::setTriggeringUser(), Parser::setUser(), RequestContext::setUser(), MediaWiki\Revision\MutableRevisionRecord::setUser(), LogEventsList::showLogExtract(), MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProviderTest::testBasics(), EditPageTest::testCreatePage(), EditPageTest::testCreatePageTrx(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase::testNewNullRevision(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest::testProviderAllowsAuthenticationDataChange(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest::testProviderAllowsAuthenticationDataChange(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest::testProviderChangeAuthenticationData(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest::testProviderChangeAuthenticationData(), MediaWiki\Auth\AuthManagerTest::testSecuritySensitiveOperationStatus(), and EditPageTest::testUpdatePage().

◆ $username

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

Definition at line 782 of file hooks.txt.

◆ $vars

configuration should be added through ResourceLoaderGetConfigVars instead& $vars

static

Definition at line 2226 of file hooks.txt.

◆ $wgCapitalizeTitle

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

Definition at line 56 of file hooks.txt.

◆ $wgHooks

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

Definition at line 108 of file hooks.txt.

Referenced by BenchmarkHooks::execute(), DumpIterator::finalSetup(), Hooks::getHandlers(), SpecialVersion::getWgHooks(), Installer::includeExtensions(), Hooks::isRegistered(), DatabaseUpdater::loadExtensions(), MediaWiki\Extensions\ParserFunctions\ParserFunctions::registerClearHook(), Cite::setHooks(), HooksTest::setUp(), ParserOptions::setupFakeRevision(), HooksTest::testGetHandlers(), ApiQuerySiteinfoTest::testGetHooks(), HooksTest::testNewStyleHookInteraction(), and MediaWiki\Auth\AuthManagerTest::unhook().

◆ $wgNotifyArticle

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

Definition at line 56 of file hooks.txt.

◆ AbortAutoblock

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

Definition at line 238 of file hooks.txt.

◆ add

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

Definition at line 53 of file hooks.txt.

Referenced by LinkBatch::addObj(), PathRouter::addStrict(), BagOStuff::incrWithInit(), BagOStuff::lock(), BagOStuff::mergeViaCas(), FancyCaptcha::pickImageFromList(), and MediaWiki\Config\ConfigRepository::salvage().

◆ addition

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function 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 88 of file hooks.txt.

Referenced by RedisLockManager::getLocksOnServer().

◆ admin

An extension or a local 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 1401 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 local administrators to define code that will be run at certain points in the mainline and to modify the data run by that mainline code Hooks can keep mainline code and make it easier to write extensions Hooks are a principled alternative to local patches for two options in MediaWiki One reverses the order of a title before displaying the article

Definition at line 33 of file hooks.txt.

Referenced by Title::getContentModel(), Title::getLatestRevID(), Title::getLength(), User::getStubThreshold(), Title::isRedirect(), Title::loadRestrictionsFromRows(), ArticleTest::setUp(), ArticleTest::tearDown(), ArticleTest::testGetOrSetOnNewProperty(), ArticleTest::testImplementsGetMagic(), and ArticleTest::testImplementsSetMagic().

◆ 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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place ATTENTION

Definition at line 833 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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password AutopromoteCondition

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

◆ BeforeDisplayNoArticleText

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array BeforeDisplayNoArticleText

Definition at line 826 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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable BeforeInitialize

Definition at line 838 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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable BeforeParserFetchFileAndTitle

Definition at line 858 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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result BitmapHandlerTransform

Definition at line 889 of file hooks.txt.

◆ block

returning false will NOT prevent logging a wrapping ErrorException block

Definition at line 2188 of file hooks.txt.

Referenced by SpecialUnblock::execute(), DiffFormatter::format(), and SpecialUnblock::getFields().

◆ 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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves set to a MediaTransformOutput BlockIp

Definition at line 896 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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves set to a MediaTransformOutput the error message to be returned in an array BlockIpComplete

Definition at line 901 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[messagename, param1, param2,...] or a MessageSpecifier error messages should be plain text with no special bolding

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

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

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

◆ check

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff initially an empty<div id="toolbar"></div> Hook subscribers can return false to have no toolbar HTML be loaded overridable Default is either copyrightwarning or copyrightwarning2 overridable Default is editpage tos summary such as anonymity and the real check

Definition at line 1475 of file hooks.txt.

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

◆ classes

this hook is for auditing only 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 983 of file hooks.txt.

Referenced by AutoloadGenerator::generateJsonAutoload(), AutoloadGenerator::generatePHPAutoload(), ClassCollector::getClasses(), AutoloadGenerator::readFile(), and ClassCollector::tryEndExpect().

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

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

◆ 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[messagename, param1, param2,...] or a MessageSpecifier error messages should be plain text with no special coloring

Definition at line 1749 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(), CheckLanguageCLI::help(), and CheckExtensionsCLI::help().

◆ conditional

namespace addition is conditional

Definition at line 924 of file hooks.txt.

◆ Consider

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

Definition at line 32 of file hooks.txt.

◆ Currently

the other converts the title to all uppercase letters Currently

Definition at line 34 of file hooks.txt.

◆ data

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

Definition at line 18 of file hooks.txt.

◆ deleteAnArticle

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function 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 1272 of file hooks.txt.

Referenced by DiffHistoryBlob::compress(), DiffEngine::diff_range(), 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 188 of file hooks.txt.

◆ e

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

Definition at line 1423 of file hooks.txt.

Referenced by BenchmarkParse::execute(), RedisLockManager::freeLocksOnServer(), RedisLockManager::getLocksOnServer(), MultiHttpClient::getSelectTimeout(), DatabaseOracle::open(), JavaScriptMinifierTest::provideLineBreaker(), PoolCounterRedis::release(), SearchPostgres::searchQuery(), and XmlTypeCheckTest::testRecursiveEntity().

◆ EditPageCopyrightWarning

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 initially an empty<div id="toolbar"></div> Hook subscribers can return false to have no toolbar HTML be loaded EditPageCopyrightWarning

Definition at line 1439 of file hooks.txt.

◆ 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 initially an empty<div id="toolbar"></div> Hook subscribers can return false to have no toolbar HTML be loaded overridable Default is either copyrightwarning or copyrightwarning2 EditPageGetCheckboxesDefinition

Definition at line 1445 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 initially an empty<div id="toolbar"></div> Hook subscribers can return false to have no toolbar HTML be loaded overridable Default is either copyrightwarning or copyrightwarning2 overridable Default is editpage tos summary EmailConfirmed

Definition at line 1474 of file hooks.txt.

◆ error

</code > has conflicting group attribute</span >< br/>< span class="error mw-ext-cite-error" lang="en" dir="ltr"> Cite error

Definition at line 2721 of file hooks.txt.

◆ errors

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

Definition at line 1750 of file hooks.txt.

◆ etc

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function 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

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

Definition at line 13 of file hooks.txt.

◆ exportArticle

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function 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

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

◆ file

to their LocalSettings php file

Definition at line 92 of file hooks.txt.

Referenced by ReleaseNotesTest::assertFileLength(), InvalidateUserSesssions::execute(), CheckLanguageCLI::help(), User::isLocallyBlockedProxy(), DatabaseInstaller::populateInterwikiTable(), DumpBackup::processOptions(), MergeMessageFileList::readFile(), TextSuppressor::suppress(), and CheckStyleSuppressor::suppress().

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

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

◆ format

usually copyright or history_copyright This message must be in HTML format

Definition at line 1645 of file hooks.txt.

Referenced by MediaWiki\Logger\Monolog\AvroFormatter::formatBatch(), SpecialVersion::getCopyrightAndAuthorList(), MWTimestamp::getTimezoneMessage(), Parser::getVariableValue(), MediaWiki\Logger\LegacyLogger::log(), HistoryAction::onView(), and Language::sprintfDate().

◆ functions

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

Definition at line 1589 of file hooks.txt.

◆ GalleryGetModes

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

Definition at line 1591 of file hooks.txt.

◆ Generally

this hook is for auditing only 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 997 of file hooks.txt.

◆ GetCanonicalURL

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

Definition at line 1610 of file hooks.txt.

◆ GetDefaultSortkey

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify as strings Extensions should add to this list GetDefaultSortkey

Definition at line 1619 of file hooks.txt.

◆ GetLinkColours

the value of this variable comes from LanguageConverter GetLinkColours

Definition at line 1678 of file hooks.txt.

◆ GetLocalURL

the value of this variable comes from LanguageConverter indexed by page_id indexed by prefixed DB keys on which the links will be shown GetLocalURL

Definition at line 1684 of file hooks.txt.

◆ GetRelativeTimestamp

the value of this variable comes from LanguageConverter indexed by page_id indexed by prefixed DB keys on which the links will be shown 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 1727 of file hooks.txt.

◆ getUserPermissionsErrorsExpensive

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

Definition at line 1757 of file hooks.txt.

◆ GitViewers

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

Definition at line 1771 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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves set to a MediaTransformOutput the error message to be returned in an array you should do so by altering $wgNamespaceProtection and $wgNamespaceContentModels outside the handler

Definition at line 921 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 127 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 1779 of file hooks.txt.

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

◆ hook

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

Initial value:

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

Definition at line 21 of file hooks.txt.

◆ hooks

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

Definition at line 74 of file hooks.txt.

Referenced by SpecialUpload::processVerificationError().

◆ However

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services However

static

Definition at line 2273 of file hooks.txt.

◆ imagelinks

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

Definition at line 2083 of file hooks.txt.

◆ in

null for the local wiki Added in

Definition at line 1588 of file hooks.txt.

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

◆ include

this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might include

Definition at line 786 of file hooks.txt.

◆ insert

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

Definition at line 2089 of file hooks.txt.

Referenced by Wikimedia\Rdbms\Database::nonNativeInsertSelect(), Wikimedia\Rdbms\Database::replace(), MediaWiki\Block\BlockRestrictionStore::update(), and Wikimedia\Rdbms\Database::upsert().

◆ Instead

this hook is for auditing only 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 983 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 117 of file hooks.txt.

◆ it

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

Definition at line 1759 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 use $formDescriptor instead 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 2163 of file hooks.txt.

Referenced by PoolCounter::__construct(), PoolCounterRedis::__construct(), Message::__construct(), ArchivedFile::__construct(), CleanupInvalidDbKeys::__construct(), ManageForeignResources::__construct(), HTMLReCaptchaField::__construct(), HTMLReCaptchaNoCaptchaField::__construct(), Wikimedia\Rdbms\ChronologyProtector::__construct(), Pingback::__construct(), IndexPager::__construct(), OATHUser::__construct(), Message::__toString(), Pingback::checkIfSent(), JobQueueMemory::doPop(), UpdateLogging::execute(), DeferredUpdates::execute(), Message::fetchMessage(), Message::formatListParam(), CacheHelper::getCachedValue(), CommentStore::getComment(), CommentStore::getCommentLegacy(), PoolCounterRedis::getConnection(), HTMLReCaptchaField::getInputHTML(), HTMLReCaptchaNoCaptchaField::getInputHTML(), CommentStore::getKey(), FixT22757::getRevTextMap(), ImportTest::getSiteInfoXML(), SqlBagOStuff::getTableByKey(), Message::getTitle(), UcdXmlReader::handleChar(), Message::inContentLanguage(), PoolCounterRedis::initAndPopPoolSlotList(), Wikimedia\Rdbms\ChronologyProtector::initPositions(), CommentStore::insert(), CommentStore::insertWithTempTable(), ArchivedFile::load(), ArchivedFile::loadFromRow(), Parser::makeImage(), Pingback::markSent(), BatchRowIterator::next(), SquidPurgeClient::nextRequest(), MagicWordArray::parseMatch(), JavaScriptMinifierTest::provideLineBreaker(), FormatMetadata::resolveMultivalueValue(), BatchRowIterator::rewind(), ApiQueryBacklinks::run(), ApiQueryAllDeletedRevisions::run(), ApiQueryBacklinksprop::run(), ApiQueryDeletedRevisions::run(), Wikimedia\Rdbms\DatabasePostgres::selectSQLText(), HashBagOStuff::set(), MapCacheLRU::set(), OATHUser::setKey(), MapCacheLRU::setMaxSize(), ParserOptions::setupFakeRevision(), Wikimedia\Rdbms\ChronologyProtector::shutdown(), WebInstallerOptions::submit(), Wikimedia\Rdbms\Database::tableNamesWithIndexClauseOrJOIN(), Message::toString(), LocalisationCacheBulkLoad::trimCache(), LocalFile::unprefixRow(), Message::unserialize(), and wfArrayDiff2_cmp().

◆ link

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

◆ Live

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

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

◆ MaintenanceRefreshLinksInit

returning false will NOT prevent logging a wrapping ErrorException create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment or false if none Defaults to false if not set multiOccurrence Can this option be passed multiple times Defaults to false if not set MaintenanceRefreshLinksInit

Definition at line 2218 of file hooks.txt.

◆ ManualLogEntryBeforePublish

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

static

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

◆ MediaWikiPerformAction

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response MediaWikiPerformAction

static

Definition at line 2261 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 use $formDescriptor instead 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

Definition at line 2162 of file hooks.txt.

Referenced by MediaWiki\Auth\AuthManagerTest::provideAccountCreation(), MediaWiki\Auth\AuthManagerTest::provideAccountLink(), MediaWiki\Auth\AuthManagerTest::provideAuthentication(), EditPageTest::provideAutoMerge(), MediaWiki\Auth\AuthManagerTest::testAccountCreation(), MediaWiki\Auth\AuthManagerTest::testAccountLink(), MediaWiki\Auth\AuthManagerTest::testAuthentication(), MediaWiki\Auth\AuthManagerTest::testAutoCreateOnLogin(), MediaWiki\Auth\AuthManagerTest::testContinueAccountCreation(), and MediaWiki\Auth\AuthManagerTest::testContinueAccountLink().

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

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

◆ ModifyExportQuery

for adding new MIME types to the list ModifyExportQuery

Definition at line 2317 of file hooks.txt.

◆ null

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

Definition at line 783 of file hooks.txt.

◆ object

either a unescaped string or a HtmlArmor object

Definition at line 2055 of file hooks.txt.

◆ occur

return true to allow those checks to occur

Definition at line 1476 of file hooks.txt.

Referenced by CleanupInvalidDbKeys::__construct().

◆ occurs

When an event occurs

Definition at line 148 of file hooks.txt.

◆ on

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going on

Definition at line 86 of file hooks.txt.

◆ PageContentSave

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

Definition at line 13 of file hooks.txt.

◆ PageContentSaveComplete

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

Definition at line 14 of file hooks.txt.

◆ pagelinks

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

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

◆ part

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

Definition at line 1423 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 When $user is not it can be in the form of<username><more info> e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been performed

Definition at line 883 of file hooks.txt.

Referenced by UpdateLogging::execute().

◆ plain

either a plain

Definition at line 2054 of file hooks.txt.

Referenced by Skin::addToSidebar(), Parser::braceSubstitution(), SpecialEditTags::buildCheckBoxes(), Block::doAutoblock(), SpecialContributions::execute(), WebInstallerComplete::execute(), WebInstallerExistingWiki::execute(), WebInstallerInstall::execute(), WebInstallerOptions::execute(), WebInstallerRestart::execute(), WebInstallerUpgrade::execute(), WebInstallerWelcome::execute(), ApiAuthManagerHelper::formatFields(), AllMessagesTablePager::formatValue(), User::getBlockedStatus(), WebInstaller::getCheckBox(), SpecialInterwiki::getDescription(), SpecialVersion::getEntryPointInfo(), WebInstaller::getRadioElements(), MssqlInstaller::getSettingsForm(), ReplaceAll::getSummary(), CategoryTree::getTag(), DatabaseInstaller::getWebUserBox(), Block::isWhitelistedFromAutoblocks(), MergeHistory::merge(), MovePage::moveToInternal(), Cite::plainError(), ImagePage::printSharedImageText(), EditPageTest::provideAutoMerge(), WebInstallerUpgrade::showDoneMessage(), WebInstallerExistingWiki::showKeyForm(), SpecialGadgets::showMainForm(), WebInstaller::showMessage(), MessageTest::testExpiryParams(), MessageTest::testRawParams(), MessageTest::testToStringKey(), Cite::warning(), and OutputPage::wrapWikiMsg().

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

◆ processing

either a unescaped string or a HtmlArmor object after processing

Definition at line 2012 of file hooks.txt.

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

◆ RecentChangesLinked

this hook is for auditing only 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 997 of file hooks.txt.

◆ remoteExtPath

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 remoteExtPath

Initial value:

=> 'Example/tests/qunit',
        'script' => [ 'tests/qunit/foo.js' ],
        'dependencies' => [ 'ext.Example.foo' ]
     ]

Definition at line 2860 of file hooks.txt.

◆ replace

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place replace

static

Definition at line 2272 of file hooks.txt.

Referenced by ManageForeignResources::__construct(), ReplaceAll::showFileFormat(), and MessageCache::updateMessageOverride().

◆ request

returning false will NOT prevent logging a wrapping ErrorException create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment or false if none Defaults to false if not set multiOccurrence Can this option be passed multiple times Defaults to false if not set this hook should only be used to add variables that depend on the current page request

Definition at line 2224 of file hooks.txt.

Referenced by Http::get(), and Http::post().

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

Referenced by Wikimedia\Rdbms\Database::cancelAtomic(), Wikimedia\Rdbms\Database::close(), Wikimedia\Rdbms\Database::deadlockLoop(), and Wikimedia\Rdbms\Database::runOnTransactionIdleCallbacks().

◆ rss

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

Definition at line 272 of file hooks.txt.

◆ saved

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

Definition at line 174 of file hooks.txt.

◆ SearchGetNearMatch

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

Definition at line 2891 of file hooks.txt.

◆ SearchGetNearMatchBefore

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

Definition at line 2896 of file hooks.txt.

◆ SearchGetNearMatchComplete

the value to return A Title object or null SearchGetNearMatchComplete

Definition at line 2901 of file hooks.txt.

◆ SearchIndexFields

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

Definition at line 2911 of file hooks.txt.

◆ simple

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

Definition at line 29 of file hooks.txt.

◆ source

null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify as strings Extensions should add to this list prev or next refreshes the diff cache allow viewing deleted revs 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 1640 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 181 of file hooks.txt.

◆ structure

this hook is for auditing only 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 985 of file hooks.txt.

Referenced by RedisLockManager::freeLocksOnServer().

◆ them

this hook is for auditing only 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 999 of file hooks.txt.

Referenced by PoolCounterRedis::initAndPopPoolSlotList().

◆ true

return true

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

Referenced by McrUndoAction::addStatePropagationFields(), McrUndoAction::checkCanExecute(), McrUndoAction::getNewRevision(), McrRestoreAction::initFromParameters(), McrUndoAction::initFromParameters(), and McrUndoAction::onSubmit().

◆ up

configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set up

static

Definition at line 2262 of file hooks.txt.

◆ 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 CheckLanguageCLI::help(), and CheckExtensionsCLI::help().

◆ UserLogin

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

Definition at line 13 of file hooks.txt.

◆ values

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

Definition at line 177 of file hooks.txt.

Referenced by Exif::__construct(), MediaWiki\Widget\CheckMatrixWidget::__construct(), CheckLanguageCLI::help(), CheckExtensionsCLI::help(), MediaWiki\Widget\CheckMatrixWidget::isTagChecked(), and HtmlTest::testExpandAttributesSpaceSeparatedAttributesWithBoolean().

◆ weird

Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of weird

Initial value:

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

Definition at line 84 of file hooks.txt.

◆ writer

An extension writer

Definition at line 51 of file hooks.txt.

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

Typedefs

Functions

Variables

Typedef Documentation

◆ $status

◆ name

Function Documentation

◆ addExtraTypes()

◆ follows()

◆ groups()

◆ if()

◆ instance()

◆ ldapLogin()

◆ options()

◆ own()

◆ query()

◆ system()

◆ values()

◆ wfMessage()

Variable Documentation

◆ $article

◆ $attribs

◆ $auto

◆ $changesList

◆ $code

◆ $colours

◆ $context

◆ $customAttribs

◆ $differenceEngine

◆ $e

◆ $editor

◆ $engine

◆ $extraData

◆ $extTypes

◆ $formDescriptor

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

◆ $result

◆ $ret

◆ $rev

◆ $revert

◆ $rollback

◆ $rowAugmentors

◆ $rows

◆ $section

◆ $services

◆ $skin

◆ $suppressed

◆ $tabindex

◆ $tables

◆ $template

◆ $term

◆ $time