3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
66 # code to actually show the article goes here
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle($article) {
78 if (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('ArticleShowComplete', array(&$article));
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle($article) {
100 function reverseForExport($article) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once('extensions/ReverseTitle.php');
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array($object, 'someMethod');
147 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148 $wgHooks['EventName'][] = array($object); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction($param1, $param2)
157 someFunction($someData, $param1, $param2)
160 $object->onEventName($param1, $param2)
162 $object->someMethod($param1, $param2)
163 # object with method and data
164 $object->someMethod($someData, $param1, $param2)
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193 function ldapLogin($username, $password) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoAccount': Return false to cancel automated local account creation, where normally authentication against an external auth plugin would be creating a local account.
238 $user: the User object about to be created (read-only, incomplete)
239 &$abortMsg: out parameter: name of error message to be displayed to user
241 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
245 'AbortDiffCache': Can be used to cancel the caching of a diff
246 &$diffEngine: DifferenceEngine object
248 'AbortLogin': Return false to cancel account login.
249 $user: the User object being authenticated against
250 $password: the password being submitted, not yet checked for validity
251 &$retval: a LoginForm class constant to return from authenticateUserData();
252 default is LoginForm::ABORTED. Note that the client may be using
253 a machine API rather than the HTML user interface.
254 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
256 'AbortMove': allows to abort moving an article (title)
259 $user: user who is doing the move
261 $reason: the reason for the move (added in 1.13)
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: name of error message to display on abort
267 'ActionBeforeFormDisplay': before executing the HTMLForm object
268 $name: name of the action
269 &$form: HTMLForm object
270 $article: Article object
272 'ActionModifyFormFields': before creating an HTMLForm object for a page action;
273 allows to change the fields on the form that will be generated
274 $name: name of the action
275 &$fields: HTMLForm descriptor array
276 $article: Article object
278 'AddNewAccount': after a user account is created
279 $user: the User object that was created. (Parameter added in 1.7)
280 $byEmail: true when account was created "by email" (added in 1.12)
282 'AfterImportPage': When a page import is completed
283 $title: Title under which the revisions were imported
284 $origTitle: Title provided by the XML file
285 $revCount: Number of revisions in the XML file
286 $sRevCount: Number of sucessfully imported revisions
287 $pageInfo: associative array of page information
289 'AjaxAddScript': Called in output page just before the initialisation
290 of the javascript ajax engine. The hook is only called when ajax
291 is enabled ( $wgUseAjax = true; ).
293 'AlternateEdit': before checking if an user can edit a page and
294 before showing the edit form ( EditPage::edit() ). This is triggered
296 $EditPage: the EditPage object
298 'AlternateUserMailer': Called before mail is sent so that mail could
299 be logged (or something else) instead of using PEAR or PHP's mail().
300 Return false to skip the regular method of sending mail. Return a
301 string to return a php-mail-error message containing the error.
302 Returning true will continue with sending email in the regular way.
303 $headers: Associative array of headers for the email
304 $to: MailAddress object or array
306 $subject: Subject of the email
307 $body: Body of the message
309 'APIAfterExecute': after calling the execute() method of an API module.
310 Use this to extend core API modules.
311 &$module: Module object
313 'APIEditBeforeSave': before saving a page with api.php?action=edit,
314 after processing request parameters. Return false to let the request
315 fail, returning an error message or an <edit result="Failure"> tag
316 if $resultArr was filled.
317 $EditPage : the EditPage object
318 $text : the new text of the article (has yet to be saved)
319 &$resultArr : data in this array will be added to the API result
321 'APIGetAllowedParams': use this hook to modify a module's parameters.
322 &$module: Module object
323 &$params: Array of parameters
325 'APIGetParamDescription': use this hook to modify a module's parameter
327 &$module: Module object
328 &$desc: Array of parameter descriptions
330 'APIQueryAfterExecute': after calling the execute() method of an
331 action=query submodule. Use this to extend core API modules.
332 &$module: Module object
334 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
335 method of an action=query submodule. Use this to extend core API modules.
336 &$module: Module object
337 &$resultPageSet: ApiPageSet object
339 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
340 Every token has an action, which will be used in the intoken parameter
341 and in the output (actiontoken="..."), and a callback function which
342 should return the token, or false if the user isn't allowed to obtain
343 it. The prototype of the callback function is func($pageid, $title)
344 where $pageid is the page ID of the page the token is requested for
345 and $title is the associated Title object. In the hook, just add
346 your callback to the $tokenFunctions array and return true (returning
347 false makes no sense)
348 $tokenFunctions: array(action => callback)
350 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
351 Every token has an action, which will be used in the rvtoken parameter
352 and in the output (actiontoken="..."), and a callback function which
353 should return the token, or false if the user isn't allowed to obtain
354 it. The prototype of the callback function is func($pageid, $title, $rev)
355 where $pageid is the page ID of the page associated to the revision the
356 token is requested for, $title the associated Title object and $rev the
357 associated Revision object. In the hook, just add your callback to the
358 $tokenFunctions array and return true (returning false makes no sense)
359 $tokenFunctions: array(action => callback)
361 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
363 Every token has an action, which will be used in the rctoken parameter
364 and in the output (actiontoken="..."), and a callback function which
365 should return the token, or false if the user isn't allowed to obtain
366 it. The prototype of the callback function is func($pageid, $title, $rc)
367 where $pageid is the page ID of the page associated to the revision the
368 token is requested for, $title the associated Title object and $rc the
369 associated RecentChange object. In the hook, just add your callback to the
370 $tokenFunctions array and return true (returning false makes no sense)
371 $tokenFunctions: array(action => callback)
373 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
374 the sites general information.
375 $module: the current ApiQuerySiteInfo module
376 &$results: array of results, add things here
378 'APIQueryUsersTokens': use this hook to add custom token to list=users.
379 Every token has an action, which will be used in the ustoken parameter
380 and in the output (actiontoken="..."), and a callback function which
381 should return the token, or false if the user isn't allowed to obtain
382 it. The prototype of the callback function is func($user) where $user
383 is the User object. In the hook, just add your callback to the
384 $tokenFunctions array and return true (returning false makes no sense)
385 $tokenFunctions: array(action => callback)
387 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
388 Each service should have its own entry in the $apis array and have a
389 unique name, passed as key for the array that represents the service data.
390 In this data array, the key-value-pair identified by the apiLink key is
392 &$apis: array of services
394 'ArticleAfterFetchContent': after fetching content of an article from
396 $article: the article (object) being loaded from the database
397 $content: the content (string) of the article
399 'ArticleConfirmDelete': before writing the confirmation form for article
401 $article: the article (object) being deleted
402 $output: the OutputPage object ($wgOut)
403 &$reason: the reason (string) the article is being deleted
405 'ArticleContentOnDiff': before showing the article content below a diff.
406 Use this to change the content in this area or how it is loaded.
407 $diffEngine: the DifferenceEngine
408 $output: the OutputPage object ($wgOut)
410 'ArticleDelete': before an article is deleted
411 $article: the WikiPage (object) being deleted
412 $user: the user (object) deleting the article
413 $reason: the reason (string) the article is being deleted
414 $error: if the deletion was prohibited, the (raw HTML) error message to display
417 'ArticleDeleteComplete': after an article is deleted
418 $article: the WikiPage that was deleted
419 $user: the user that deleted the article
420 $reason: the reason the article was deleted
421 $id: id of the article that was deleted
423 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
425 $article: WikiPage (object) of the user talk page
427 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
428 article has been changed
429 $article: the WikiPage (object)
430 $editInfo: data holder that includes the parser output ($editInfo->output) for
431 that page after the change
432 $changed: bool for if the page was changed
434 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
435 recentchanges table, return false to not delete old entries
436 $article: WikiPage (object) being modified
438 'ArticleFromTitle': when creating an article object from a title object using
439 Wiki::articleFromTitle()
440 $title: title (object) used to create the article object
441 $article: article (object) that will be returned
443 'ArticleInsertComplete': After a new article is created
444 $article: WikiPage created
445 $user: User creating the article
447 $summary: Edit summary/comment
448 $isMinor: Whether or not the edit was marked as minor
449 $isWatch: (No longer used)
450 $section: (No longer used)
451 $flags: Flags passed to Article::doEdit()
452 $revision: New Revision of the article
454 'ArticleMergeComplete': after merging to article using Special:Mergehistory
455 $targetTitle: target title (object)
456 $destTitle: destination title (object)
458 'ArticlePageDataAfter': after loading data of an article from the database
459 $article: WikiPage (object) whose data were loaded
460 $row: row (object) returned from the database server
462 'ArticlePageDataBefore': before loading data of an article from the database
463 $article: WikiPage (object) that data will be loaded
464 $fields: fileds (array) to load from the database
466 'ArticlePrepareTextForEdit': called when preparing text to be saved
467 $article: the WikiPage being saved
468 $popts: parser options to be used for pre-save transformation
470 'ArticleProtect': before an article is protected
471 $article: the WikiPage being protected
472 $user: the user doing the protection
473 $protect: boolean whether this is a protect or an unprotect
474 $reason: Reason for protect
475 $moveonly: boolean whether this is for move only or not
477 'ArticleProtectComplete': after an article is protected
478 $article: the WikiPage that was protected
479 $user: the user who did the protection
480 $protect: boolean whether it was a protect or an unprotect
481 $reason: Reason for protect
482 $moveonly: boolean whether it was for move only or not
484 'ArticlePurge': before executing "&action=purge"
485 $article: WikiPage (object) to purge
487 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
488 revision of an article
489 &$title: title object of the article
491 'ArticleRevisionUndeleted': after an article revision is restored
492 $title: the article title
493 $revision: the revision
494 $oldPageID: the page ID of the revision when archived (may be null)
496 'ArticleRollbackComplete': after an article rollback is completed
497 $article: the WikiPage that was edited
498 $user: the user who did the rollback
499 $revision: the revision the page was reverted back to
500 $current: the reverted revision
502 'ArticleSave': before an article is saved
503 $article: the WikiPage (object) being saved
504 $user: the user (object) saving the article
505 $text: the new article text
506 $summary: the article summary (comment)
511 'ArticleSaveComplete': After an article has been updated
512 $article: WikiPage modified
513 $user: User performing the modification
515 $summary: Edit summary/comment
516 $isMinor: Whether or not the edit was marked as minor
517 $isWatch: (No longer used)
518 $section: (No longer used)
519 $flags: Flags passed to Article::doEdit()
520 $revision: New Revision of the article
521 $baseRevId: the rev ID (or false) this edit was based on
523 'ArticleUndelete': When one or more revisions of an article are restored
524 $title: Title corresponding to the article restored
525 $create: Whether or not the restoration caused the page to be created
526 (i.e. it didn't exist before)
527 $comment: The comment associated with the undeletion.
529 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
530 before the user is redirected back to the page
531 &$article: the article
532 &$sectionanchor: The section anchor link (e.g. "#overview" )
533 &$extraq: Extra query parameters which can be added via hooked functions
535 'ArticleViewFooter': After showing the footer section of an ordinary page view
536 $article: Article object
538 'ArticleViewHeader': Before the parser cache is about to be tried for article
540 &$article: the article
541 &$pcache: whether to try the parser cache or not
542 &$outputDone: whether the output for this page finished or not
544 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
546 $article: target article (object)
548 'AuthPluginAutoCreate': Called when creating a local account for an user logged
549 in from an external authentication method
550 $user: User object created locally
552 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
553 Gives a chance for an extension to set it programattically to a variable class.
554 &$auth: the $wgAuth object, probably a stub
556 'AutopromoteCondition': check autopromote condition for user.
557 $type: condition type
560 $result: result of checking autopromote condition
562 'BadImage': When checking against the bad image list
563 $name: Image name being checked
564 &$bad: Whether or not the image is "bad"
566 Change $bad and return false to override. If an image is "bad", it is not
567 rendered inline in wiki pages or galleries in category pages.
569 'BeforeInitialize': before anything is initialized in performRequestForTitle()
570 &$title: Title being used for request
571 &$article: The associated Article object
572 &$output: OutputPage object
574 $request: WebRequest object
575 $mediaWiki: Mediawiki object
577 'BeforePageDisplay': Prior to outputting a page
578 &$out: OutputPage object
581 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
582 $parser: Parser object
584 &$time: the image timestamp (use '0' to force a broken thumbnail)
585 &$sha1: image base 36 sha1 (used to specify the file, $nt will be ignored if this is set)
586 &$descQuery: query string to add to thumbnail URL
588 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
589 $parser: Parser object
590 $title: title of the template
591 &$skip: skip this template and link it?
592 &$id: the id of the revision being parsed
594 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
595 &$parser: Parser object
596 &$ig: ImageGallery object
598 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
599 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
600 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
602 'BitmapHandlerTransform': before a file is transformed, gives extension the
603 possibility to transform it themselves
604 $handler: BitmapHandler
606 &$scalerParams: Array with scaler parameters
607 &$mto: null, set to a MediaTransformOutput
609 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
610 $block: Block object (which is set to be autoblocking)
611 &$blockIds: Array of block IDs of the autoblock
613 'BlockIp': before an IP address or user is blocked
614 $block: the Block object about to be saved
615 $user: the user _doing_ the block (not the one being blocked)
617 'BlockIpComplete': after an IP address or user is blocked
618 $block: the Block object that was saved
619 $user: the user who did the block (not the one being blocked)
621 'BookInformation': Before information output on Special:Booksources
622 $isbn: ISBN to show information for
623 $output: OutputPage object in use
625 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
626 &$namespaces: Array of namespace numbers with corresponding canonical names
628 'CategoryPageView': before viewing a categorypage in CategoryPage::view
629 $catpage: CategoryPage instance
631 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
632 &$changesList: ChangesList instance.
633 &$articlelink: HTML of link to article (already filled-in).
634 &$s: HTML of row that is being constructed.
635 &$rc: RecentChange instance.
636 $unpatrolled: Whether or not we are showing unpatrolled changes.
637 $watched: Whether or not the change is watched by the user.
639 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
640 $collationName: Name of the collation in question
641 &$collationObject: Null. Replace with a subclass of the Collation class that implements
642 the collation given in $collationName.
644 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
645 $user: user (object) whose email is being confirmed
647 'ContribsPager::getQueryInfo': Before the contributions query is about to run
648 &$pager: Pager object for contributions
649 &queryInfo: The query for the contribs Pager
651 'ContributionsLineEnding': Called before a contributions HTML line is finished
652 $page: SpecialPage object for contributions
654 $row: the DB row for this line
656 'ContributionsToolLinks': Change tool links above Special:Contributions
658 $title: User page title
659 &$tools: Array of tool links
661 'CustomEditor': When invoking the page editor
662 $article: Article being edited
663 $user: User performing the edit
665 Return true to allow the normal editor to be used, or false
666 if implementing a custom editor, e.g. for a special namespace,
669 'DatabaseOraclePostInit': Called after initialising an Oracle database
670 &$db: the DatabaseOracle object
672 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
673 $text: plaintext string to be output
674 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
676 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
677 $title: the diff page title (nullable)
678 &$oldId: the actual old Id to use in the diff
679 &$newId: the actual new Id to use in the diff (0 means current)
680 $old: the ?old= param value from the url
681 $new: the ?new= param value from the url
683 'DiffViewHeader': called before diff display
684 $diff: DifferenceEngine object that's calling
685 $oldRev: Revision object of the "old" revision (may be null/invalid)
686 $newRev: Revision object of the "new" revision
688 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
690 $article: article (object) being viewed
691 $oldid: oldid (int) being viewed
693 'DoEditSectionLink': Override the HTML generated for section edit links
694 $skin: Skin object rendering the UI
695 $title: Title object for the title being linked to (may not be the same as
696 $wgTitle, if the section is included from a template)
697 $section: The designation of the section being pointed to, to be included in
698 the link, like "§ion=$section"
699 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
700 By default, this is wrapped in the 'editsectionhint' message.
701 &$result: The HTML to return, prefilled with the default plus whatever other
702 changes earlier hooks have made
703 $lang: The language code to use for the link in the wfMsg* functions
705 'EditFilter': Perform checks on an edit
706 $editor: Edit form (see includes/EditPage.php)
707 $text: Contents of the edit box
708 $section: Section being edited
709 &$error: Error message to return
710 $summary: Edit summary for page
712 'EditFilterMerged': Post-section-merge edit filter
713 $editor: EditPage instance (object)
714 $text: content of the edit box
715 &$error: error message to return
716 $summary: Edit summary for page
718 'EditFormPreloadText': Allows population of the edit form when creating
720 &$text: Text to preload with
721 &$title: Title object representing the page being created
723 'EditFormInitialText': Allows modifying the edit form when editing existing
725 $editPage: EditPage object
727 'EditPage::attemptSave': called before an article is
728 saved, that is before Article::doEdit() is called
729 $editpage_Obj: the current EditPage object
731 'EditPage::importFormData': allow extensions to read additional data
733 $editpage: EditPage instance
735 return value is ignored (should always return true)
737 'EditPage::showEditForm:fields': allows injection of form field into edit form
738 &$editor: the EditPage instance for reference
739 &$out: an OutputPage instance to write to
740 return value is ignored (should always return true)
742 'EditPage::showEditForm:initial': before showing the edit form
743 $editor: EditPage instance (object)
745 Return false to halt editing; you'll need to handle error messages, etc.
746 yourself. Alternatively, modifying $error and returning true will cause the
747 contents of $error to be echoed at the top of the edit form as wikitext.
748 Return true without altering $error to allow the edit to proceed.
750 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
751 when there's an edit conflict. Return false to halt normal diff output; in
752 this case you're responsible for computing and outputting the entire "conflict"
753 part, i.e., the "difference between revisions" and "your text" headers and
755 &$editor: EditPage instance
756 &$out: OutputPage instance
758 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
759 textarea in the edit form
760 &$editpage: The current EditPage object
761 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
762 &$tabindex: HTML tabindex of the last edit check/button
764 'EditPageBeforeEditChecks': allows modifying the edit checks below the
765 textarea in the edit form
766 &$editpage: The current EditPage object
767 &$checks: Array of edit checks like "watch this page"/"minor edit"
768 &$tabindex: HTML tabindex of the last edit check/button
770 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
771 textarea in the edit form
772 &$toolbar: The toolbar HTMl
774 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
775 $title: title of page being edited
776 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
778 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
780 $editPage: EditPage object
781 &$newtext: wikitext that will be used as "your version"
783 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
784 $editPage: EditPage object
785 &$toparse: wikitext that will be parsed
787 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
788 &$editpage: The current EditPage object
789 &$res: the HTML of the error text
791 'EditPageTosSummary': Give a chance for site and per-namespace customizations
792 of terms of service summary link that might exist separately from the copyright
794 $title: title of page being edited
795 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
797 'EditSectionLink': Do not use, use DoEditSectionLink instead.
798 $skin: Skin rendering the UI
799 $title: Title being linked to
800 $section: Section to link to
802 &$result: Result (alter this to override the generated links)
803 $lang: The language code to use for the link in the wfMsg* functions
805 'EmailConfirmed': When checking that the user's email address is "confirmed"
806 $user: User being checked
807 $confirmed: Whether or not the email address is confirmed
808 This runs before the other checks, such as anonymity and the real check; return
809 true to allow those checks to occur, and false if checking is done.
811 'EmailUser': before sending email from one user to another
812 $to: address of receiving user
813 $from: address of sending user
814 $subject: subject of the mail
815 $text: text of the mail
817 'EmailUserCC': before sending the copy of the email to the author
818 $to: address of receiving user
819 $from: address of sending user
820 $subject: subject of the mail
821 $text: text of the mail
823 'EmailUserComplete': after sending email from one user to another
824 $to: address of receiving user
825 $from: address of sending user
826 $subject: subject of the mail
827 $text: text of the mail
829 'EmailUserForm': after building the email user form object
830 $form: HTMLForm object
832 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
833 $user: The user who is trying to email another user.
834 $editToken: The user's edit token.
835 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
837 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
838 &$extTypes: associative array of extensions types
840 'FetchChangesList': When fetching the ChangesList derivative for
842 $user: User the list is being fetched for
843 &$skin: Skin object to be used with the list
844 &$list: List object (defaults to NULL, change it to an object
845 instance and return false override the list derivative used)
847 'FileDeleteComplete': When a file is deleted
848 $file: reference to the deleted file
849 $oldimage: in case of the deletion of an old image, the name of the old file
850 $article: in case all revisions of the file are deleted a reference to the
851 article associated with the file.
852 $user: user who performed the deletion
855 'FileUpload': When a file upload occurs
856 $file : Image object representing the file that was uploaded
857 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
858 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
860 'FileUndeleteComplete': When a file is undeleted
861 $title: title object to the file
862 $fileVersions: array of undeleted versions. Empty if all versions were restored
863 $user: user who performed the undeletion
866 'GetAutoPromoteGroups': When determining which autopromote groups a user
867 is entitled to be in.
868 &$user: user to promote.
869 &$promote: groups that will be added.
871 'GetBlockedStatus': after loading blocking status of an user from the database
872 $user: user (object) being checked
874 'GetCacheVaryCookies': get cookies that should vary cache options
875 $out: OutputPage object
876 &$cookies: array of cookies name, add a value to it if you want to add a cookie
877 that have to vary cache options
879 'GetDefaultSortkey': Override the default sortkey for a page.
880 $title: Title object that we need to get a sortkey for
881 &$sortkey: Sortkey to use.
883 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
884 $title: Title object of page
885 $url: string value as output (out parameter, can modify)
886 $query: query options passed to Title::getFullURL()
888 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
889 $title: Title object of page
890 $url: string value as output (out parameter, can modify)
891 $query: query options passed to Title::getInternalURL()
893 'GetIP': modify the ip of the current user (called only once)
894 &$ip: string holding the ip as determined so far
896 'GetLinkColours': modify the CSS class of an array of page links
897 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
899 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
901 'GetLocalURL': modify local URLs as output into page links
902 $title: Title object of page
903 $url: string value as output (out parameter, can modify)
904 $query: query options passed to Title::getLocalURL()
906 'GetMetadataVersion': modify the image metadata version currently in use. This is
907 used when requesting image metadata from a ForiegnApiRepo. Media handlers
908 that need to have versioned metadata should add an element to the end of
909 the version array of the form 'handler_name=version'. Most media handlers
910 won't need to do this unless they broke backwards compatibility with a
911 previous version of the media handler metadata output.
912 &$version: Array of version strings
914 'GetPreferences': modify user preferences
915 $user: User whose preferences are being modified.
916 &$preferences: Preferences description array, to be fed to an HTMLForm object
918 'getUserPermissionsErrors': Add a permissions error when permissions errors are
919 checked for. Use instead of userCan for most cases. Return false if the
920 user can't do it, and populate $result with the reason in the form of
921 array( messagename, param1, param2, ... ). For consistency, error messages
922 should be plain text with no special coloring, bolding, etc. to show that
923 they're errors; presenting them properly to the user as errors is done by
925 $title: Title object being checked against
926 $user : Current user object
927 $action: Action being checked
928 $result: User permissions error to add. If none, return true.
930 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
931 if expensive checks are enabled.
933 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
934 image insertion. You can skip the default logic entirely by returning
935 false, or just modify a few things using call-by-reference.
937 &$title: Title object of the image
938 &$file: File object, or false if it doesn't exist
939 &$frameParams: Various parameters with special meanings; see documentation in
940 includes/Linker.php for Linker::makeImageLink2
941 &$handlerParams: Various parameters with special meanings; see documentation in
942 includes/Linker.php for Linker::makeImageLink2
943 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
944 &$res: Final HTML output, used if you return false
947 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
948 the image on an image page
949 $imagePage: ImagePage object ($this)
952 'ImagePageAfterImageLinks': called after the image links section on an image
954 $imagePage: ImagePage object ($this)
955 &$html: HTML for the hook to add
957 'ImagePageFileHistoryLine': called when a file history line is contructed
959 $line: the HTML of the history line
960 $css: the line CSS class
962 'ImagePageFindFile': called when fetching the file associated with an image page
963 $page: ImagePage object
965 &$displayFile: displayed File object
967 'ImagePageShowTOC': called when the file toc on an image page is generated
968 $page: ImagePage object
969 &$toc: Array of <li> strings
971 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
973 &$title: the Title object of the file as it would appear for the upload page
974 &$path: the original file and path name when img_auth was invoked by the the web
976 &$name: the name only component of the file
977 &$result: The location to pass back results of the hook routine (only used if
979 $result[0]=The index of the header message
980 $result[1]=The index of the body text message
981 $result[2 through n]=Parameters passed to body text message. Please note the
982 header message cannot receive/use parameters.
984 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
985 $reader: XMLReader object
986 $logInfo: Array of information
987 Return false to stop further processing of the tag
989 'ImportHandlePageXMLTag': When parsing a XML tag in a page
990 $reader: XMLReader object
991 $pageInfo: Array of information
992 Return false to stop further processing of the tag
994 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
995 $reader: XMLReader object
996 $revInfo: Array of information
997 Return false to stop further processing of the tag
999 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
1000 $reader: XMLReader object
1001 Return false to stop further processing of the tag
1003 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
1004 $reader: XMLReader object
1005 $revisionInfo: Array of information
1006 Return false to stop further processing of the tag
1008 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
1009 $title: Title object ($wgTitle)
1010 $request: WebRequest
1011 $ignoreRedirect: boolean to skip redirect check
1012 $target: Title/string of redirect target
1013 $article: Article object
1015 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1016 Return true without providing an interwiki to continue interwiki search.
1017 $prefix: interwiki prefix we are looking for.
1018 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1019 iw_trans and optionally iw_api and iw_wikiid.
1021 'InternalParseBeforeLinks': during Parser's internalParse method before links
1022 but after noinclude/includeonly/onlyinclude and other processing.
1023 &$parser: Parser object
1024 &$text: string containing partially parsed text
1025 &$stripState: Parser's internal StripState object
1027 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1028 $user: user (object) whose email is being invalidated
1030 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1031 $article: article (object) being checked
1033 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1035 $result: Change this value to override the result of wfIsTrustedProxy()
1037 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1038 tance to return false if the domain name doesn't match your organization
1039 $addr: The e-mail address entered by the user
1040 &$result: Set this and return false to override the internal checks
1042 'isValidPassword': Override the result of User::isValidPassword()
1043 $password: The password entered by the user
1044 &$result: Set this and return false to override the internal checks
1045 $user: User the password is being validated for
1047 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1048 $wgExtensionMessagesFiles instead.
1049 Use this to define synonyms of magic words depending of the language
1050 $magicExtensions: associative array of magic words synonyms
1051 $lang: laguage code (string)
1053 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1054 listed in $wgExtensionMessagesFiles instead.
1055 Use to define aliases of special pages names depending of the language
1056 $specialPageAliases: associative array of magic words synonyms
1057 $lang: laguage code (string)
1059 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1060 &$names: array of language code => language name
1061 $code language of the preferred translations
1063 'LinkBegin': Used when generating internal and interwiki links in
1064 Linker::link(), before processing starts. Return false to skip default proces-
1065 sing and return $ret. See documentation for Linker::link() for details on the
1066 expected meanings of parameters.
1067 $skin: the Skin object
1068 $target: the Title that the link is pointing to
1069 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1071 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1072 tive array form, with keys and values unescaped. Should be merged with de-
1073 fault values, with a value of false meaning to suppress the attribute.
1074 &$query: the query string to add to the generated URL (the bit after the "?"),
1075 in associative array form, with keys and values unescaped.
1076 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1077 &$ret: the value to return if your hook returns false.
1079 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1080 just before the function returns a value. If you return true, an <a> element
1081 with HTML attributes $attribs and contents $html will be returned. If you re-
1082 turn false, $ret will be returned.
1083 $skin: the Skin object
1084 $target: the Title object that the link is pointing to
1085 $options: the options. Will always include either 'known' or 'broken', and may
1086 include 'noclasses'.
1087 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1088 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1090 &$ret: the value to return if your hook returns false.
1092 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1094 &$url: the image url
1095 &$alt: the image's alt text
1096 &$img: the new image HTML (if returning false)
1098 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1101 &$text: the link text
1102 &$link: the new link HTML (if returning false)
1103 &$attribs: the attributes to be applied.
1104 $linkType: The external link type
1106 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1108 &$linksUpdate: the LinksUpdate object
1110 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1112 &$linksUpdate: the LinksUpdate object
1114 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1115 &$linksUpdate: the LinksUpdate object
1117 'ListDefinedTags': When trying to find all defined tags.
1118 &$tags: The list of tags.
1120 'LoadExtensionSchemaUpdates': called during database installation and updates
1121 &updater: A DatabaseUpdater subclass
1123 'LocalFile::getHistory': called before file history query performed
1126 $fields: select fields
1128 $opts: query options
1129 $join_conds: JOIN conditions
1131 'LocalisationCacheRecache': Called when loading the localisation data into cache
1132 $cache: The LocalisationCache object
1133 $code: language code
1134 &$alldata: The localisation data from core and extensions
1136 'LoginAuthenticateAudit': a login attempt for a valid user account either
1137 succeeded or failed. No return data is accepted; this hook is for auditing only.
1138 $user: the User object being authenticated against
1139 $password: the password being submitted and found wanting
1140 $retval: a LoginForm class constant with authenticateUserData() return
1141 value (SUCCESS, WRONG_PASS, etc)
1143 'LogLine': Processes a single log entry on Special:Log
1144 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1145 logging.log_type database field.
1146 $log_action: string for the type of log action (e.g. 'delete', 'block',
1147 'create2'). Corresponds to logging.log_action database field.
1148 $title: Title object that corresponds to logging.log_namespace and
1149 logging.log_title database fields.
1150 $paramArray: Array of parameters that corresponds to logging.log_params field.
1151 Note that only $paramArray[0] appears to contain anything.
1152 &$comment: string that corresponds to logging.log_comment database field, and
1153 which is displayed in the UI.
1154 &$revert: string that is displayed in the UI, similar to $comment.
1155 $time: timestamp of the log entry (added in 1.12)
1157 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1158 $refreshLinks: RefreshLinks object
1160 'MagicWordMagicWords': When defining new magic word.
1161 DEPRECATED: use $magicWords in a file listed in
1162 $wgExtensionMessagesFiles instead.
1163 $magicWords: array of strings
1165 'MagicWordwgVariableIDs': When definig new magic words IDs.
1166 $variableIDs: array of strings
1168 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1169 is executed. Ideally, this hook should only be used to add variables that
1170 depend on the current page/request; static configuration should be added
1171 through ResourceLoaderGetConfigVars instead.
1172 &$vars: variable (or multiple variables) to be added into the output
1173 of Skin::makeVariablesScript
1175 'MarkPatrolled': before an edit is marked patrolled
1176 $rcid: ID of the revision to be marked patrolled
1177 $user: the user (object) marking the revision as patrolled
1178 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1179 needs to be a sysop in order to mark an edit patrolled
1181 'MarkPatrolledComplete': after an edit is marked patrolled
1182 $rcid: ID of the revision marked as patrolled
1183 $user: user (object) who marked the edit patrolled
1184 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1185 must be a sysop to patrol the edit
1187 'MediaWikiPerformAction': Override MediaWiki::performAction().
1188 Use this to do something completely different, after the basic
1189 globals have been set up, but before ordinary actions take place.
1191 $article: $wgArticle
1194 $request: $wgRequest
1195 $mediaWiki: The $mediawiki object
1197 'MessagesPreLoad': When loading a message from the database
1198 $title: title of the message (string)
1199 $message: value (string), change it to the message you want to define
1201 'MessageCacheReplace': When a message page is changed.
1202 Useful for updating caches.
1203 $title: name of the page changed.
1204 $text: new contents of the page.
1206 'ModifyExportQuery': Modify the query used by the exporter.
1207 $db: The database object to be queried.
1208 &$tables: Tables in the query.
1209 &$conds: Conditions in the query.
1210 &$opts: Options for the query.
1211 &$join_conds: Join conditions for the query.
1213 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1214 been rendered (useful for adding more)
1215 Note: this is only run for the Monobook skin. This hook is deprecated and
1216 may be removed in the future. To add items to the toolbox you should use
1217 the SkinTemplateToolboxEnd hook instead, which works for all
1218 "SkinTemplate"-type skins.
1219 $tools: array of tools
1221 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1222 and returning it for the skin to output. You can add items to the toolbox while
1223 still letting the skin make final decisions on skin-specific markup conventions
1225 &$sk: The BaseTemplate base skin template
1226 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1227 BaseTemplate::makeListItem for details on the format of individual
1228 items inside of this array
1230 'NewRevisionFromEditComplete': called when a revision was inserted
1232 $article: the WikiPage edited
1233 $rev: the new revision
1234 $baseID: the revision ID this was based off, if any
1235 $user: the editing user
1237 'NormalizeMessageKey': Called before the software gets the text of a message
1238 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1240 &$key: the message being looked up. Change this to something else to change
1241 what message gets displayed (string)
1242 &$useDB: whether or not to look up the message in the database (bool)
1243 &$langCode: the language code to get the message for (string) - or -
1244 whether to use the content language (true) or site language (false) (bool)
1245 &$transform: whether or not to expand variables and templates
1246 in the message (bool)
1248 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1249 &$changeslist: The OldChangesList instance.
1250 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1251 &$rc: The RecentChange object.
1253 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1254 Hooks can alter or append to the array of URLs for search & suggestion formats.
1255 &$urls: array of associative arrays with Url element attributes
1257 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1258 users and/or IP addresses too
1259 $otherBlockLink: An array with links to other block logs
1260 $ip: The requested IP address or username
1262 'OutputPageBeforeHTML': a page has been processed by the parser and
1263 the resulting HTML is about to be displayed.
1264 $parserOutput: the parserOutput (object) that corresponds to the page
1265 $text: the text that will be displayed, in HTML (string)
1267 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1268 tag to allow for extensions to add attributes to the body of the page they might
1269 need. Or to allow building extensions to add body classes that aren't of high
1270 enough demand to be included in core.
1271 $out: The OutputPage which called the hook, can be used to get the real title
1272 $sk: The Skin that called OutputPage::headElement
1273 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1275 'OutputPageCheckLastModified': when checking if the page has been modified
1276 since the last visit
1277 &$modifiedTimes: array of timestamps.
1278 The following keys are set: page, user, epoch
1280 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1281 $out: OutputPage instance (object)
1282 $parserOutput: parserOutput instance being added in $out
1284 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1285 categories. Implementations should return false if they generate the category
1286 links, so the default link generation is skipped.
1287 $out: OutputPage instance (object)
1288 $categories: associative array, keys are category names, values are category
1289 types ("normal" or "hidden")
1290 $links: array, intended to hold the result. Must be an associative array with
1291 category types as keys and arrays of HTML links as values.
1293 'PageHistoryBeforeList': When a history page list is about to be constructed.
1294 $article: the article that the history is loading for
1296 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1297 $row: the revision row for this line
1298 $s: the string representing this parsed line
1299 $classes: array containing the <li> element classes
1301 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1304 $queryInfo: the query parameters
1306 'PageRenderingHash': alter the parser cache option hash key
1307 A parser extension which depends on user options should install
1308 this hook and append its values to the key.
1309 $hash: reference to a hash key string which can be modified
1311 'ParserAfterStrip': Same as ParserBeforeStrip
1313 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1314 $parser: Parser object being used
1315 $text: text that'll be returned
1317 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1318 $parser: Parser object
1319 $text: text to parse
1320 $stripState: StripState instance being used
1322 'ParserBeforeStrip': Called at start of parsing time
1323 (no more strip, deprecated ?)
1324 $parser: parser object
1325 $text: text being parsed
1326 $stripState: stripState used (object)
1328 'ParserBeforeTidy': called before tidy and custom tags replacements
1329 $parser: Parser object being used
1332 'ParserClearState': called at the end of Parser::clearState()
1333 $parser: Parser object being cleared
1335 'ParserFirstCallInit': called when the parser initialises for the first time
1336 &$parser: Parser object being cleared
1338 'ParserGetVariableValueSwitch': called when the parser need the value of a
1340 $parser: Parser object
1341 $varCache: array to store the value in case of multiples calls of the
1343 $index: index (string) of the magic
1344 $ret: value of the magic word (the hook should set it)
1345 $frame: PPFrame object to use for expanding any template variables
1347 'ParserGetVariableValueTs': use this to change the value of the time for the
1348 {{LOCAL...}} magic word
1349 $parser: Parser object
1350 $time: actual time (timestamp)
1352 'ParserGetVariableValueVarCache': use this to change the value of the
1353 variable cache or return false to not use it
1354 $parser: Parser object
1355 $varCache: varaiable cache (array)
1357 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1358 include comments about size of the text parsed
1359 $parser: Parser object
1360 $limitReport: text that will be included (without comment tags)
1362 'ParserMakeImageParams': Called before the parser make an image link, use this
1363 to modify the parameters of the image.
1364 $title: title object representing the file
1365 $file: file object that will be used to create the image
1366 &$params: 2-D array of parameters
1368 'ParserSectionCreate': Called each time the parser creates a document section
1369 from wikitext. Use this to apply per-section modifications to HTML (like
1370 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1371 can begin in one section and end in another. Make sure your code can handle
1372 that case gracefully. See the EditSectionClearerLink extension for an
1374 $parser: the calling Parser instance
1375 $section: the section number, zero-based, but section 0 is usually empty
1376 &$sectionContent: ref to the content of the section. modify this.
1377 $showEditLinks: boolean describing whether this section has an edit link
1379 'ParserTestParser': called when creating a new instance of Parser in
1380 maintenance/parserTests.inc
1381 $parser: Parser object created
1383 'ParserTestTables': alter the list of tables to duplicate when parser tests
1384 are run. Use when page save hooks require the presence of custom tables
1385 to ensure that tests continue to run properly.
1386 &$tables: array of table names
1388 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1389 my talk page, my contributions" etc).
1391 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1392 &$title: Title object representing the current page
1394 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1395 &$user : User performing the action
1396 $action : Action being performed
1397 &$result : Whether or not the action should be prevented
1398 Change $result and return false to give a definitive answer, otherwise
1399 the built-in rate limiting checks are used, if enabled.
1401 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1402 AJAX search suggestions. Put results into &$results outparam and return false.
1403 $ns : array of int namespace keys to search in
1404 $search : search term (not guaranteed to be conveniently normalized)
1405 $limit : maximum number of results to return
1406 &$results : out param: array of page names (strings)
1408 'PrefsEmailAudit': called when user changes his email address
1409 $user: User (object) changing his email address
1410 $oldaddr: old email address (string)
1411 $newaddr: new email address (string)
1413 'PrefsPasswordAudit': called when user changes his password
1414 $user: User (object) changing his passoword
1415 $newPass: new password
1416 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1418 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1419 $article: the title being (un)protected
1420 $output: a string of the form HTML so far
1422 'ProtectionForm::save': called when a protection form is submitted
1423 $article: the title being (un)protected
1424 $errorMsg: an html message string of an error
1426 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1427 $article: the page the form is shown for
1428 $out: OutputPage object
1430 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1431 loader request or generating HTML output.
1432 &$resourceLoader: ResourceLoader object
1434 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1435 to add modules to the startup module. This hook should be used sparingly since any module added here
1436 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1439 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1440 &$obj: RawPage object
1441 &$text: The text that's going to be the output
1443 'RecentChange_save': called at the end of RecentChange::save()
1444 $recentChange: RecentChange object
1446 'ResourceLoaderGetConfigVars': called at the end of
1447 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1448 configuration variables to JavaScript. Things that depend on the current
1449 page/request state must be added through MakeGlobalVariablesScript instead.
1450 &$vars: array( variable name => value )
1452 'RevisionInsertComplete': called after a revision is inserted into the DB
1453 &$revision: the Revision
1454 $data: the data stored in old_text. The meaning depends on $flags: if external
1455 is set, it's the URL of the revision text in external storage; otherwise,
1456 it's the revision text itself. In either case, if gzip is set, the revision
1458 $flags: a comma-delimited list of strings representing the options used. May
1459 include: utf8 (this will always be set for new revisions); gzip; external.
1461 'SearchUpdate': Prior to search update completion
1463 $namespace : Page namespace
1465 $text : Current text being indexed
1467 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1468 $allSearchTerms : Array of the search terms in all content languages
1469 &$titleResult : Outparam; the value to return. A Title object or null.
1471 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1472 $term : Search term string
1473 &$title : Outparam; set to $title object and return false for a match
1475 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1476 $term : Search term string
1477 &$title : Current Title object that is being returned (null if none found).
1479 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1480 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1481 in the $searchEngine->namespaces array.
1482 $query : Original query.
1483 &$parsed : Resultant query with the prefixes stripped.
1485 'SearchableNamespaces': An option to modify which namespaces are searchable.
1486 &$arr : Array of namespaces ($nsId => $name) which will be used.
1488 'SetupAfterCache': Called in Setup.php, after cache objects are set
1490 'ShowMissingArticle': Called when generating the output for a non-existent page
1491 $article: The article object corresponding to the page
1493 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1494 $text: Text being shown
1495 $title: Title of the custom script/stylesheet page
1496 $output: Current OutputPage object
1498 'ShowSearchHitTitle': Customise display of search hit title/link.
1499 &$title: Title to link to
1500 &$text: Text to use for the link
1501 $result: The search result
1502 $terms: The search terms entered
1503 $page: The SpecialSearch object.
1505 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1506 &$siteNotice: HTML returned as the sitenotice
1508 Return true to allow the normal method of notice selection/rendering to work,
1509 or change the value of $siteNotice and return false to alter it.
1511 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1512 &$siteNotice: HTML sitenotice
1514 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1516 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1518 &$text: bottomScripts Text
1519 Append to $text to add additional text/scripts after the stock bottom scripts.
1521 'SkinAfterContent': Allows extensions to add text after the page content and
1523 &$data: (string) Text to be printed out directly (without parsing)
1525 This hook should work in all skins. Just set the &$data variable to the text
1526 you're going to add.
1528 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1530 &$bar: Sidebar contents
1531 Modify $bar to add or modify sidebar portlets.
1533 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1534 $title: displayed page title
1535 $type: 'normal' or 'history' for old/diff views
1536 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1537 &$link: overridable HTML link to be passed into the message as $1
1538 &$forContent: overridable flag if copyright footer is shown in content language.
1541 &$text: additional 'powered by' icons in HTML.
1542 Note: Modern skin does not use the MediaWiki icon but plain text instead
1545 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1546 &$subpages: Subpage links HTML
1548 $out: OutputPage object
1549 If false is returned $subpages will be used instead of the HTML
1550 subPageSubtitle() generates.
1551 If true is returned, $subpages will be ignored and the rest of
1552 subPageSubtitle() will run.
1554 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1555 "permanent link" tab
1556 $sktemplate: SkinTemplate object
1557 $nav_urls: array of tabs
1559 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1560 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1561 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1562 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1563 &$sktemplate: SkinTemplate object
1564 &$links: Structured navigation links
1565 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1567 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1569 &$sktemplate: SkinTemplate object
1570 &$tpl: Template engine object
1572 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1573 $sktemplate: SkinTemplate object
1574 $res: set to true to prevent active tabs
1576 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1577 You can either create your own array, or alter the parameters for
1579 &$sktemplate: The SkinTemplate instance.
1580 $title: Title instance for the page.
1581 $message: Visible label of tab.
1582 $selected: Whether this is a selected tab.
1583 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1584 &$classes: Array of CSS classes to apply.
1585 &$query: Query string to add to link.
1587 &$result: Complete assoc. array if you want to return true.
1589 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1590 been rendered (useful for adding more)
1591 $sk: The QuickTemplate based skin template running the hook.
1593 'SoftwareInfo': Called by Special:Version for returning information about
1595 $software: The array of software in format 'name' => 'version'.
1596 See SpecialVersion::softwareInformation()
1598 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1599 $id: User identifier
1601 'SpecialListusersDefaultQuery': called right before the end of
1602 UsersPager::getDefaultQuery()
1603 $pager: The UsersPager instance
1604 $query: The query array to be returned
1606 'SpecialListusersFormatRow': called right before the end of
1607 UsersPager::formatRow()
1608 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1609 $row: Database row object
1611 'SpecialListusersHeader': called before closing the <fieldset> in
1612 UsersPager::getPageHeader()
1613 $pager: The UsersPager instance
1614 $out: The header HTML
1616 'SpecialListusersHeaderForm': called before adding the submit button in
1617 UsersPager::getPageHeader()
1618 $pager: The UsersPager instance
1619 $out: The header HTML
1621 'SpecialListusersQueryInfo': called right before the end of
1622 UsersPager::getQueryInfo()
1623 $pager: The UsersPager instance
1624 $query: The query array to be returned
1626 'SpecialMovepageAfterMove': called after moving a page
1627 $movePage: MovePageForm object
1628 $oldTitle: old title (object)
1629 $newTitle: new title (object)
1631 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1632 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1633 $opts: FormOptions object containing special page options
1634 &$conds: array of WHERE conditionals for query
1635 &tables: array of tables to be queried
1636 &$fields: array of columns to select
1637 &$join_conds: join conditions for the tables
1639 'SpecialNewPagesFilters': called after building form options at NewPages
1640 $special: the special page object
1641 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1642 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1644 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1645 hook to remove a core special page
1646 $list: list (array) of core special pages
1648 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1649 $users: array of User objects
1650 $data: array of data submitted by the user
1651 &$error: string, error code (message name) used to describe to error (out paramater).
1652 The hook needs to return false when setting this, otherwise it will have no effect.
1654 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1655 use this to change some selection criteria or substitute a different title
1656 &$randstr: The random number from wfRandom()
1657 &$isRedir: Boolean, whether to select a redirect or non-redirect
1658 &$namespaces: An array of namespace indexes to get the title from
1659 &$extra: An array of extra SQL statements
1660 &$title: If the hook returns false, a Title object to use instead of the
1661 result from the normal query
1663 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1664 $special: the special page object
1665 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1666 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1668 'SpecialRecentChangesPanel': called when building form options in
1669 SpecialRecentChanges
1670 &$extraOpts: array of added items, to which can be added
1671 $opts: FormOptions for this request
1673 'SpecialRecentChangesQuery': called when building sql query for
1674 SpecialRecentChanges and SpecialRecentChangesLinked
1675 &$conds: array of WHERE conditionals for query
1676 &$tables: array of tables to be queried
1677 &$join_conds: join conditions for the tables
1678 $opts: FormOptions for this request
1679 &$query_options: array of options for the database request
1680 &$select: Array of columns to select
1682 'SpecialSearchGo': called when user clicked the "Go"
1683 &$title: title object generated from the text entered by the user
1684 &$term: the search term entered by the user
1686 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1687 target doesn't exist
1688 &$title: title object generated from the text entered by the user
1690 'SpecialSearchProfiles': allows modification of search profiles
1691 &$profiles: profiles, which can be modified.
1693 'SpecialSearchProfileForm': allows modification of search profile forms
1694 $search: special page object
1695 &$form: String: form html
1696 $profile: String: current search profile
1697 $term: String: search term
1698 $opts: Array: key => value of hidden options for inclusion in custom forms
1700 'SpecialSearchSetupEngine': allows passing custom data to search engine
1701 $search: special page object
1702 $profile: String: current search profile
1703 $engine: the search engine
1705 'SpecialSearchResults': called before search result display when there
1707 $term: string of search term
1708 &$titleMatches: empty or SearchResultSet object
1709 &$textMatches: empty or SearchResultSet object
1711 'SpecialSearchNoResults': called before search result display when there are
1713 $term: string of search term
1715 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1716 &$extraStats: Array to save the new stats
1717 ( $extraStats['<name of statistic>'] => <value>; )
1719 'SpecialUploadComplete': Called after successfully uploading a file from
1721 $form: The SpecialUpload object
1723 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1724 use this to change the tables headers
1725 $extTypes: associative array of extensions types
1727 'SpecialWatchlistFilters': called after building form options at Watchlist
1728 $special: the special page object
1729 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1730 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1732 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1733 &$conds: array of WHERE conditionals for query
1734 &$tables: array of tables to be queried
1735 &$join_conds: join conditions for the tables
1736 &$fields: array of query fields
1738 'TitleArrayFromResult': called when creating an TitleArray object from a
1740 &$titleArray: set this to an object to override the default object returned
1741 $res: database result used to create the object
1743 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1744 that can be applied.
1745 $title: The title in question.
1746 &$types: The types of protection available.
1748 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
1749 $title: Title object that is being checked
1750 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page. Hooks may change this value to override the return value of Title::isCssOrJsPage()
1752 'TitleMoveComplete': after moving an article (title)
1755 $user: user who did the move
1756 $pageid: database ID of the page that's been moved
1757 $redirid: database ID of the created redirect
1759 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
1760 PageArchive object has been created but before any further processing is done.
1761 &$archive: PageArchive object
1762 $title: Title object of the page that we're viewing
1764 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
1765 PageArchive object has been created but before any further processing is done.
1766 &$archive: PageArchive object
1767 $title: Title object of the page that we're viewing
1769 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
1770 the site is not in read-only mode, that the Title object is not null and after
1771 a PageArchive object has been constructed but before performing any further
1773 &$archive: PageArchive object
1774 $title: Title object of the page that we're about to undelete
1776 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1777 $title: title object related to the revision
1778 $rev: revision (object) that will be viewed
1780 'UnknownAction': An unknown "action" has occured (useful for defining
1782 $action: action name
1783 $article: article "acted on"
1785 'UnitTestsList': Called when building a list of files with PHPUnit tests
1786 &$files: list of files
1788 'UnwatchArticle': before a watch is removed from an article
1789 $user: user watching
1790 $article: article object to be removed
1792 'UnwatchArticle': after a watch is removed from an article
1793 $user: user that was watching
1794 $article: article object removed
1796 'UnwatchArticleComplete': after a watch is removed from an article
1797 $user: user that watched
1798 $article: article object that was watched
1800 'UploadForm:initial': before the upload form is generated
1801 $form: UploadForm object
1802 You might set the member-variables $uploadFormTextTop and
1803 $uploadFormTextAfterSummary to inject text (HTML) either before
1804 or after the editform.
1806 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1807 $form: UploadForm object
1808 Lets you poke at member variables like $mUploadDescription before the
1810 Do not use this hook to break upload processing. This will return the user to
1811 a blank form with no error message; use UploadVerification and
1812 UploadVerifyFile instead
1814 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1815 $type: (string) the requested upload type
1816 &$className: the class name of the Upload instance to be created
1818 'UploadComplete': when Upload completes an upload
1819 &$upload: an UploadBase child instance
1821 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1823 $descriptor: (array) the HTMLForm descriptor
1825 'UploadFormSourceDescriptors': after the standard source inputs have been
1826 added to the descriptor
1827 $descriptor: (array) the HTMLForm descriptor
1829 'UploadVerification': additional chances to reject an uploaded file. Consider
1830 using UploadVerifyFile instead.
1831 string $saveName: destination file name
1832 string $tempName: filesystem path to the temporary file for checks
1833 string &$error: output: message key for message to show if upload canceled
1834 by returning false. May also be an array, where the first element
1835 is the message key and the remaining elements are used as parameters to
1838 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1839 in most cases over UploadVerification.
1840 object $upload: an instance of UploadBase, with all info about the upload
1841 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1842 will typically only apply for specific mime types.
1843 object &$error: output: true if the file is valid. Otherwise, an indexed array
1844 representing the problem with the file, where the first element
1845 is the message key and the remaining elements are used as parameters to
1848 'UploadComplete': Upon completion of a file upload
1849 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1850 $uploadBase->getLocalFile().
1852 'User::mailPasswordInternal': before creation and mailing of a user's new
1854 $user: the user who sent the message out
1855 $ip: IP of the user who sent the message out
1856 $u: the account whose new password will be set
1858 'UserAddGroup': called when adding a group; return false to override
1859 stock group addition.
1860 $user: the user object that is to have a group added
1861 &$group: the group to add, can be modified
1863 'UserArrayFromResult': called when creating an UserArray object from a
1865 &$userArray: set this to an object to override the default object returned
1866 $res: database result used to create the object
1868 'userCan': To interrupt/advise the "user can do X to Y article" check.
1869 If you want to display an error message, try getUserPermissionsErrors.
1870 $title: Title object being checked against
1871 $user : Current user object
1872 $action: Action being checked
1873 $result: Pointer to result returned if hook returns false. If null is returned,
1874 userCan checks are continued by internal code.
1876 'UserCanSendEmail': To override User::canSendEmail() permission check
1877 $user: User (object) whose permission is being checked
1878 &$canSend: bool set on input, can override on output
1880 'UserClearNewTalkNotification': called when clearing the
1881 "You have new messages!" message, return false to not delete it
1882 $user: User (object) that'll clear the message
1884 'UserComparePasswords': called when checking passwords, return false to
1885 override the default password checks
1886 &$hash: String of the password hash (from the database)
1887 &$password: String of the plaintext password the user entered
1888 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1890 &$result: If the hook returns false, this Boolean value will be checked to
1891 determine if the password was valid
1893 'UserCreateForm': change to manipulate the login form
1894 $template: SimpleTemplate instance for the form
1896 'UserCryptPassword': called when hashing a password, return false to implement
1897 your own hashing method
1898 &$password: String of the plaintext password to encrypt
1899 &$salt: String of the password salt or Boolean false if no salt is provided
1900 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1902 &$hash: If the hook returns false, this String will be used as the hash
1904 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1905 $user: User to get groups for
1906 &$groups: Current effective groups
1908 'UserGetAllRights': after calculating a list of all available rights
1909 &$rights: Array of rights, which may be added to.
1911 'UserGetEmail': called when getting an user email address
1913 &$email: email, change this to override local email
1915 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1916 email authentification
1918 &$timestamp: timestamp, change this to override local email authentification
1921 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1922 &$groups: List of implicit (automatically-assigned) groups
1924 'UserGetLanguageObject': Called when getting user's interface language object
1926 &$code: Langauge code that will be used to create the object
1928 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1929 &$reservedUsernames: $wgReservedUsernames
1931 'UserGetRights': Called in User::getRights()
1932 $user: User to get rights for
1933 &$rights: Current rights
1935 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1937 $user: User in question
1938 $title: Title of the page in question
1939 &$blocked: Out-param, whether or not the user is blocked from that page.
1940 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1941 own user talk pages.
1943 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1945 $ip: User's IP address
1946 &$blocked: Whether the user is blocked, to be modified by the hook
1948 'UserLoadAfterLoadFromSession': called to authenticate users on
1949 external/environmental means; occurs after session is loaded
1950 $user: user object being loaded
1952 'UserLoadDefaults': called when loading a default user
1956 'UserLoadFromDatabase': called when loading a user from the database
1958 &$s: database query object
1960 'UserLoadFromSession': called to authenticate users on external/environmental
1961 means; occurs before session is loaded
1962 $user: user object being loaded
1963 &$result: set this to a boolean value to abort the normal authentification
1966 'UserLoadOptions': when user options/preferences are being loaded from
1969 &$options: Options, can be modified.
1971 'UserLoginComplete': after a user has logged in
1972 $user: the user object that was created on login
1973 $inject_html: Any HTML to inject after the "logged in" message.
1975 'UserLoginForm': change to manipulate the login form
1976 $template: SimpleTemplate instance for the form
1978 'UserLogout': before a user logs out
1979 $user: the user object that is about to be logged out
1981 'UserLogoutComplete': after a user has logged out
1982 $user: the user object _after_ logout (won't have name, ID, etc.)
1983 $inject_html: Any HTML to inject after the "logged out" message.
1984 $oldName: name of the user before logout (string)
1986 'UserRemoveGroup': called when removing a group; return false to override
1987 stock group removal.
1988 $user: the user object that is to have a group removed
1989 &$group: the group to be removed, can be modified
1991 'UserRights': After a user's group memberships are changed
1992 $user : User object that was changed
1993 $add : Array of strings corresponding to groups added
1994 $remove: Array of strings corresponding to groups removed
1996 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1998 $user: user retrieving new talks messages
1999 $talks: array of new talks page(s)
2001 'UserSaveSettings': called when saving user settings
2004 'UserSaveOptions': Called just before saving user preferences/options.
2006 &$options: Options, modifiable
2008 'UserSetCookies': called when setting user cookies
2010 &$session: session array, will be added to $_SESSION
2011 &$cookies: cookies array mapping cookie name to its value
2013 'UserSetEmail': called when changing user email address
2015 &$email: new email, change this to override new email address
2017 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2018 of email authentification
2020 &$timestamp: new timestamp, change this to override local email
2021 authentification timestamp
2023 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2024 used to alter the SQL query which gets the list of wanted pages
2025 &$wantedPages: WantedPagesPage object
2026 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2028 'WatchArticle': before a watch is added to an article
2029 $user: user that will watch
2030 $article: article object to be watched
2032 'WatchArticleComplete': after a watch is added to an article
2033 $user: user that watched
2034 $article: article object watched
2036 'WatchlistEditorBuildRemoveLine': when building remove lines in
2037 Special:Watchlist/edit
2038 &$tools: array of extra links
2039 $title: Title object
2040 $redirect: whether the page is a redirect
2043 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2045 One, and only one hook should set this, and return false.
2046 &$tables: Database tables to use in the SELECT query
2047 &$opts: Options to use for the query
2048 &$join: Join conditions
2050 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2051 query pages to be updated with maintenance/updateSpecialPages.php
2052 $query: $wgQueryPages itself
2054 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2055 metadata to be added.
2056 $obj: The XmlDumpWriter object.
2057 &$out: The output string.
2058 $row: The database row for the page.
2059 $title: The title of the page.
2061 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2063 $obj: The XmlDumpWriter object.
2064 &$out: The text being output.
2065 $row: The database row for the revision.
2066 $text: The revision text.
2068 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2069 additional tags to extract.
2070 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2072 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2073 used to post-process the results.
2074 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2075 metadata tags returned (each tag is either a value, or an array of values).
2077 More hooks might be available but undocumented, you can execute
2078 ./maintenance/findhooks.php to find hidden one.