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.
203 A calling function or method uses the wfRunHooks() function to run the hooks
204 related to a particular event, like so:
210 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
211 # protect the article
212 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
217 wfRunHooks() returns true if the calling function should continue processing
218 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
219 error occurred, or one of the hooks handled the action already). Checking the
220 return value matters more for "before" hooks than for "complete" hooks.
222 Note that hook parameters are passed in an array; this is a necessary
223 inconvenience to make it possible to pass reference values (that can be changed)
224 into the hook code. Also note that earlier versions of wfRunHooks took a
225 variable number of arguments; the array() calling protocol came about after
228 ==Events and parameters==
230 This is a list of known events and parameters; please add to it if you're going
231 to add events to the MediaWiki code.
233 'AbortAutoblock': Return false to cancel an autoblock.
234 $autoblockip: The IP going to be autoblocked.
235 $block: The block from which the autoblock is coming.
237 'AbortLogin': Return false to cancel account login.
238 $user: the User object being authenticated against
239 $password: the password being submitted, not yet checked for validity
240 &$retval: a LoginForm class constant to return from authenticateUserData();
241 default is LoginForm::ABORTED. Note that the client may be using
242 a machine API rather than the HTML user interface.
244 'AbortMove': allows to abort moving an article (title)
247 $user: user who is doing the move
249 $reason: the reason for the move (added in 1.13)
251 'AbortNewAccount': Return false to cancel account creation.
252 $user: the User object about to be created (read-only, incomplete)
253 $message: out parameter: error message to display on abort
255 'AddNewAccount': after a user account is created
256 $user: the User object that was created. (Parameter added in 1.7)
257 $byEmail: true when account was created "by email" (added in 1.12)
259 'AjaxAddScript': Called in output page just before the initialisation
260 of the javascript ajax engine. The hook is only called when ajax
261 is enabled ( $wgUseAjax = true; ).
263 'AlternateEdit': before checking if an user can edit a page and
264 before showing the edit form ( EditPage::edit() ). This is triggered
266 $EditPage : the EditPage object
268 'APIEditBeforeSave': before saving a page with api.php?action=edit,
269 after processing request parameters. Return false to let the request
270 fail, returning an error message or an <edit result="Failure"> tag
271 if $resultArr was filled.
272 $EditPage : the EditPage object
273 $text : the new text of the article (has yet to be saved)
274 $resultArr : data in this array will be added to the API result
276 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
277 Every token has an action, which will be used in the intoken parameter
278 and in the output (actiontoken="..."), and a callback function which
279 should return the token, or false if the user isn't allowed to obtain
280 it. The prototype of the callback function is func($pageid, $title)
281 where $pageid is the page ID of the page the token is requested for
282 and $title is the associated Title object. In the hook, just add
283 your callback to the $tokenFunctions array and return true (returning
284 false makes no sense)
285 $tokenFunctions: array(action => callback)
287 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
288 Every token has an action, which will be used in the rvtoken parameter
289 and in the output (actiontoken="..."), and a callback function which
290 should return the token, or false if the user isn't allowed to obtain
291 it. The prototype of the callback function is func($pageid, $title, $rev)
292 where $pageid is the page ID of the page associated to the revision the
293 token is requested for, $title the associated Title object and $rev the
294 associated Revision object. In the hook, just add your callback to the
295 $tokenFunctions array and return true (returning false makes no sense)
296 $tokenFunctions: array(action => callback)
298 'APIQueryRecentChangesTokens': use this hook to add custom tokens to list=recentchanges.
299 Every token has an action, which will be used in the rctoken parameter
300 and in the output (actiontoken="..."), and a callback function which
301 should return the token, or false if the user isn't allowed to obtain
302 it. The prototype of the callback function is func($pageid, $title, $rc)
303 where $pageid is the page ID of the page associated to the revision the
304 token is requested for, $title the associated Title object and $rc the
305 associated RecentChange object. In the hook, just add your callback to the
306 $tokenFunctions array and return true (returning false makes no sense)
307 $tokenFunctions: array(action => callback)
309 'ArticleAfterFetchContent': after fetching content of an article from the database
310 $article: the article (object) being loaded from the database
311 $content: the content (string) of the article
313 'ArticleDelete': before an article is deleted
314 $article: the article (object) being deleted
315 $user: the user (object) deleting the article
316 $reason: the reason (string) the article is being deleted
317 $error: if the deletion was prohibited, the (raw HTML) error message to display
320 'ArticleDeleteComplete': after an article is deleted
321 $article: the article that was deleted
322 $user: the user that deleted the article
323 $reason: the reason the article was deleted
324 $id: id of the article that was deleted
326 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
327 $article: article (object) of the user talk page
329 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
330 $article: article (object) being modified
332 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
333 $title: title (object) used to create the article object
334 $article: article (object) that will be returned
336 'ArticleInsertComplete': After a new article is created
337 $article: Article created
338 $user: User creating the article
340 $summary: Edit summary/comment
341 $isMinor: Whether or not the edit was marked as minor
342 $isWatch: (No longer used)
343 $section: (No longer used)
344 $flags: Flags passed to Article::doEdit()
345 $revision: New Revision of the article
347 'ArticleMergeComplete': after merging to article using Special:Mergehistory
348 $targetTitle: target title (object)
349 $destTitle: destination title (object)
351 'ArticlePageDataAfter': after loading data of an article from the database
352 $article: article (object) whose data were loaded
353 $row: row (object) returned from the database server
355 'ArticlePageDataBefore': before loading data of an article from the database
356 $article: article (object) that data will be loaded
357 $fields: fileds (array) to load from the database
359 'ArticleProtect': before an article is protected
360 $article: the article being protected
361 $user: the user doing the protection
362 $protect: boolean whether this is a protect or an unprotect
363 $reason: Reason for protect
364 $moveonly: boolean whether this is for move only or not
366 'ArticleProtectComplete': after an article is protected
367 $article: the article that was protected
368 $user: the user who did the protection
369 $protect: boolean whether it was a protect or an unprotect
370 $reason: Reason for protect
371 $moveonly: boolean whether it was for move only or not
373 'ArticlePurge': before executing "&action=purge"
374 $article: article (object) to purge
376 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
377 revision of an article
378 &$title: title object of the article
380 'ArticleRevisionUndeleted': after an article revision is restored
381 $title: the article title
382 $revision: the revision
383 $oldPageID: the page ID of the revision when archived (may be null)
385 'ArticleRollbackComplete': after an article rollback is completed
386 $article: the article that was edited
387 $user: the user who did the rollback
388 $revision: the revision the page was reverted back to
390 'ArticleSave': before an article is saved
391 $article: the article (object) being saved
392 $user: the user (object) saving the article
393 $text: the new article text
394 $summary: the article summary (comment)
399 'ArticleSaveComplete': After an article has been updated
400 $article: Article modified
401 $user: User performing the modification
403 $summary: Edit summary/comment
404 $isMinor: Whether or not the edit was marked as minor
405 $isWatch: (No longer used)
406 $section: (No longer used)
407 $flags: Flags passed to Article::doEdit()
408 $revision: New Revision of the article
410 'ArticleUndelete': When one or more revisions of an article are restored
411 $title: Title corresponding to the article restored
412 $create: Whether or not the restoration caused the page to be created
413 (i.e. it didn't exist before)
415 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
416 &$article: the article
417 &$sectionanchor: The section anchor link (e.g. "#overview" )
418 &$extraq: Extra query parameters which can be added via hooked functions
420 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
421 &$article: the article
422 &$pcache: whether to try the parser cache or not
423 &$outputDone: whether the output for this page finished or not
425 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
426 $article: target article (object)
428 'AuthPluginAutoCreate': Called when creating a local account for an user logged
429 in from an external authentication method
430 $user: User object created locally
432 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
433 Gives a chance for an extension to set it programattically to a variable class.
434 &$auth: the $wgAuth object, probably a stub
436 'AutopromoteCondition': check autopromote condition for user.
437 $type: condition type
440 $result: result of checking autopromote condition
442 'BadImage': When checking against the bad image list
443 $name: Image name being checked
444 &$bad: Whether or not the image is "bad"
446 Change $bad and return false to override. If an image is "bad", it is not
447 rendered inline in wiki pages or galleries in category pages.
449 'BeforeGalleryFindFile': before an image is fetched for a gallery
450 &$gallery,: the gallery object
451 &$nt: the image title
452 &$time: image timestamp
454 'BeforePageDisplay': Prior to outputting a page
455 &$out: OutputPage object
458 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
459 &$parser: Parser object
460 &$title: title of the template
461 &$skip: skip this template and link it?
462 &$id: the id of the revision being parsed
464 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
465 &$parser: Parser object
466 &$nt: the image title
467 &$skip: skip this image and link it?
468 &$time: the image timestamp
470 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
471 &$parser: Parser object
472 &$ig: ImageGallery object
474 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
475 $nondefaults: Assoc array with the following keys:
476 days, hideOwn, hideBots, hideMinor, namespace
478 &$hookSql: a string which will be inserted without sanitation into the SQL query
479 used to get the watchlist, at the end of the WHERE part.
481 'BlockIp': before an IP address or user is blocked
482 $block: the Block object about to be saved
483 $user: the user _doing_ the block (not the one being blocked)
485 'BlockIpComplete': after an IP address or user is blocked
486 $block: the Block object that was saved
487 $user: the user who did the block (not the one being blocked)
489 'BookInformation': Before information output on Special:Booksources
490 $isbn: ISBN to show information for
491 $output: OutputPage object in use
493 'CategoryPageView': before viewing a categorypage in CategoryPage::view
494 $catpage: CategoryPage instance
496 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
497 &$this: ChangesList instance.
498 &$articlelink: HTML of link to article (already filled-in).
499 &$s: HTML of row that is being constructed.
500 &$rc: RecentChange instance.
501 $unpatrolled: Whether or not we are showing unpatrolled changes.
502 $watched: Whether or not the change is watched by the user.
504 'ContribsPager::getQueryInfo': Before the contributions query is about to run
505 &$pager: Pager object for contributions
506 &queryInfo: The query for the contribs Pager
508 'ContributionsLineEnding': Called before a contributions HTML line is finished
509 $page: SpecialPage object for contributions
511 $row: the DB row for this line
513 'ContributionsToolLinks': Change tool links above Special:Contributions
515 $title: User page title
516 &$tools: Array of tool links
518 'CustomEditor': When invoking the page editor
519 $article: Article being edited
520 $user: User performing the edit
522 Return true to allow the normal editor to be used, or false
523 if implementing a custom editor, e.g. for a special namespace,
526 'DiffViewHeader': called before diff display
527 $diff: DifferenceEngine object that's calling
528 $oldRev: Revision object of the "old" revision (may be null/invalid)
529 $newRev: Revision object of the "new" revision
531 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
532 $article: article (object) being viewed
533 $oldid: oldid (int) being viewed
535 'DoEditSectionLink': Override the HTML generated for section edit links
536 $skin: Skin object rendering the UI
537 $title: Title object for the title being linked to (may not be the same as
538 $wgTitle, if the section is included from a template)
539 $section: The designation of the section being pointed to, to be included in
540 the link, like "§ion=$section"
541 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
542 By default, this is wrapped in the 'editsectionhint' message.
543 $result: The HTML to return, prefilled with the default plus whatever other
544 changes earlier hooks have made
546 'EditFilter': Perform checks on an edit
547 $editor: Edit form (see includes/EditPage.php)
548 $text: Contents of the edit box
549 $section: Section being edited
550 &$error: Error message to return
551 $summary: Edit summary for page
553 'EditFilterMerged': Post-section-merge edit filter
554 $editor: EditPage instance (object)
555 $text: content of the edit box
556 $error: error message to return
557 $summary: Edit summary for page
559 'EditFormPreloadText': Allows population of the edit form when creating new pages
560 &$text: Text to preload with
561 &$title: Title object representing the page being created
563 'EditPage::attemptSave': called before an article is
564 saved, that is before insertNewArticle() is called
565 &$editpage_Obj: the current EditPage object
567 'EditPage::showEditForm:fields': allows injection of form field into edit form
568 &$editor: the EditPage instance for reference
569 &$out: an OutputPage instance to write to
570 return value is ignored (should always return true)
572 'EditPage::showEditForm:initial': before showing the edit form
573 $editor: EditPage instance (object)
575 Return false to halt editing; you'll need to handle error messages, etc. yourself.
576 Alternatively, modifying $error and returning true will cause the contents of $error
577 to be echoed at the top of the edit form as wikitext. Return true without altering
578 $error to allow the edit to proceed.
580 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
581 when there's an edit conflict. Return false to halt normal diff output; in
582 this case you're responsible for computing and outputting the entire "conflict"
583 part, i.e., the "difference between revisions" and "your text" headers and
585 &$editor: EditPage instance
586 &$out: OutputPage instance
588 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
589 &$editpage: The current EditPage object
590 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
592 'EditSectionLink': Do not use, use DoEditSectionLink instead.
593 $skin: Skin rendering the UI
594 $title: Title being linked to
595 $section: Section to link to
597 $result: Result (alter this to override the generated links)
599 'EmailConfirmed': When checking that the user's email address is "confirmed"
600 $user: User being checked
601 $confirmed: Whether or not the email address is confirmed
602 This runs before the other checks, such as anonymity and the real check; return
603 true to allow those checks to occur, and false if checking is done.
605 'EmailUser': before sending email from one user to another
606 $to: address of receiving user
607 $from: address of sending user
608 $subject: subject of the mail
609 $text: text of the mail
611 'EmailUserComplete': after sending email from one user to another
612 $to: address of receiving user
613 $from: address of sending user
614 $subject: subject of the mail
615 $text: text of the mail
617 'FetchChangesList': When fetching the ChangesList derivative for a particular user
618 &$user: User the list is being fetched for
619 &$skin: Skin object to be used with the list
620 &$list: List object (defaults to NULL, change it to an object instance and return
621 false override the list derivative used)
623 'FileDeleteComplete': When a file is deleted
624 $file: reference to the deleted file
625 $oldimage: in case of the deletion of an old image, the name of the old file
626 $article: in case all revisions of the file are deleted a reference to the article
627 associated with the file.
628 $user: user who performed the deletion
631 'FileUpload': When a file upload occurs
632 $file : Image object representing the file that was uploaded
634 'FileUndeleteComplete': When a file is undeleted
635 $title: title object to the file
636 $fileVersions: array of undeleted versions. Empty if all versions were restored
637 $user: user who performed the undeletion
640 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
641 &$user: user to promote.
642 &$promote: groups that will be added.
644 'GetBlockedStatus': after loading blocking status of an user from the database
645 $user: user (object) being checked
647 'GetCacheVaryCookies': get cookies that should vary cache options
648 $out: OutputPage object
649 &$cookies: array of cookies name, add a value to it if you want to add a cookie
650 that have to vary cache options
652 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
653 $title: Title object of page
654 $url: string value as output (out parameter, can modify)
655 $query: query options passed to Title::getFullURL()
657 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
658 $title: Title object of page
659 $url: string value as output (out parameter, can modify)
660 $query: query options passed to Title::getInternalURL()
662 'GetLinkColours': modify the CSS class of an array of page links
663 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
664 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
666 'GetLocalURL': modify local URLs as output into page links
667 $title: Title object of page
668 $url: string value as output (out parameter, can modify)
669 $query: query options passed to Title::getLocalURL()
671 'getUserPermissionsErrors': Add a permissions error when permissions errors are
672 checked for. Use instead of userCan for most cases. Return false if the
673 user can't do it, and populate $result with the reason in the form of
674 array( messagename, param1, param2, ... ). For consistency, error messages
675 should be plain text with no special coloring, bolding, etc. to show that
676 they're errors; presenting them properly to the user as errors is done by
678 $title: Title object being checked against
679 $user : Current user object
680 $action: Action being checked
681 $result: User permissions error to add. If none, return true.
683 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
684 if expensive checks are enabled.
686 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted into the job queue.
687 $title: Title object, pages linked to this title are purged.
689 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
690 image insertion. You can skip the default logic entirely by returning
691 false, or just modify a few things using call-by-reference.
693 &$title: Title object of the image
694 &$file: File object, or false if it doesn't exist
695 &$frameParams: Various parameters with special meanings; see documentation in
696 includes/Linker.php for Linker::makeImageLink2
697 &$handlerParams: Various parameters with special meanings; see documentation in
698 includes/Linker.php for Linker::makeImageLink2
699 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
700 &$res: Final HTML output, used if you return false
703 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
704 the image on an image page
705 $imagePage: ImagePage object ($this)
708 'ImagePageFileHistoryLine': called when a file history line is contructed
710 $line: the HTML of the history line
711 $css: the line CSS class
713 'ImagePageFindFile': called when fetching the file associated with an image page
714 $page: ImagePage object
716 &$displayFile: displayed File object
718 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
719 $title: Title object ($wgTitle)
721 $ignoreRedirect: boolean to skip redirect check
722 $target: Title/string of redirect target
724 'InitPreferencesForm': called at the end of PreferencesForm's constructor
725 $form: the PreferencesForm
726 $request: the web request to initialized from
728 'InternalParseBeforeLinks': during Parser's internalParse method before links but
729 after noinclude/includeonly/onlyinclude and other processing.
730 &$this: Parser object
731 &$text: string containing partially parsed text
732 &$this->mStripState: Parser's internal StripState object
734 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
735 $article: article (object) being checked
737 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
739 $result: Change this value to override the result of wfIsTrustedProxy()
741 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
742 tance to return false if the domain name doesn't match your organization
743 $addr: The e-mail address entered by the user
744 &$result: Set this and return false to override the internal checks
746 'isValidPassword': Override the result of User::isValidPassword()
747 $password: The password entered by the user
748 &$result: Set this and return false to override the internal checks
749 $user: User the password is being validated for
751 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
752 $magicExtensions: associative array of magic words synonyms
753 $lang: laguage code (string)
755 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
756 $specialPageAliases: associative array of magic words synonyms
757 $lang: laguage code (string)
759 'LinkBegin': Used when generating internal and interwiki links in
760 Linker::link(), before processing starts. Return false to skip default proces-
761 sing and return $ret. See documentation for Linker::link() for details on the
762 expected meanings of parameters.
763 $skin: the Skin object
764 $target: the Title that the link is pointing to
765 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
767 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
768 tive array form, with keys and values unescaped. Should be merged with de-
769 fault values, with a value of false meaning to suppress the attribute.
770 &$query: the query string to add to the generated URL (the bit after the "?"),
771 in associative array form, with keys and values unescaped.
772 &$options: the options. Can include 'known', 'broken', 'noclasses'.
773 &$ret: the value to return if your hook returns false.
775 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
776 just before the function returns a value. If you return true, an <a> element
777 with HTML attributes $attribs and contents $text will be returned. If you re-
778 turn false, $ret will be returned.
779 $skin: the Skin object
780 $target: the Title object that the link is pointing to
781 $options: the options. Will always include either 'known' or 'broken', and may
783 &$text: the final (raw HTML) contents of the <a> tag, after processing.
784 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
786 &$ret: the value to return if your hook returns false.
788 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just before the return
790 &$alt: the image's alt text
791 &$img: the new image HTML (if returning false)
793 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
795 &$text: the link text
796 &$link: the new link HTML (if returning false)
798 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
799 &$linksUpdate: the LinkUpdate object
801 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
802 &$linksUpdate: the LinkUpdate object
804 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
805 &$linksUpdate: the LinkUpdate object
807 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
809 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
811 'LocalFile::getHistory': called before file history query performed
814 $fields: select fields
817 $join_conds: JOIN conditions
819 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
820 No return data is accepted; this hook is for auditing only.
821 $user: the User object being authenticated against
822 $password: the password being submitted and found wanting
823 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
825 'LogLine': Processes a single log entry on Special:Log
826 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
828 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
829 to logging.log_action database field.
830 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
831 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
832 appears to contain anything.
833 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
834 &$revert: string that is displayed in the UI, similar to $comment.
835 $time: timestamp of the log entry (added in 1.12)
837 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
838 &$type: array of strings
840 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
841 &$typeText: array of strings
843 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
844 &$headerText: array of strings
846 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
847 &$actionText: array of strings
849 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
850 $magicWords: array of strings
852 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
853 $variableIDs: array of strings
855 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript is executed
856 &$vars: variable (or multiple variables) to be added into the output
857 of Skin::makeVariablesScript
859 'MarkPatrolled': before an edit is marked patrolled
860 $rcid: ID of the revision to be marked patrolled
861 $user: the user (object) marking the revision as patrolled
862 $wcOnlySysopsCanPatrol: config setting indicating whether the user
863 needs to be a sysop in order to mark an edit patrolled
865 'MarkPatrolledComplete': after an edit is marked patrolled
866 $rcid: ID of the revision marked as patrolled
867 $user: user (object) who marked the edit patrolled
868 $wcOnlySysopsCanPatrol: config setting indicating whether the user
869 must be a sysop to patrol the edit
871 'MathAfterTexvc': after texvc is executed when rendering mathematics
872 $mathRenderer: instance of MathRenderer
873 $errmsg: error message, in HTML (string). Nonempty indicates failure
874 of rendering the formula
876 'MediaWikiPerformAction': Override MediaWiki::performAction().
877 Use this to do something completely different, after the basic
878 globals have been set up, but before ordinary actions take place.
884 $this: The $mediawiki object
886 'MessagesPreLoad': When loading a message from the database
887 $title: title of the message (string)
888 $message: value (string), change it to the message you want to define
890 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
891 Note: this is only run for the Monobook skin. To add items to the toolbox
892 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
894 $tools: array of tools
896 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
897 $article: the article edited
898 $rev: the new revision
899 $baseID: the revision ID this was based off, if any
901 'NormalizeMessageKey': Called before the software gets the text of a message
902 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets displayed
903 &$key: the message being looked up. Change this to something else to change what message gets displayed (string)
904 &$useDB: whether or not to look up the message in the database (bool)
905 &$langCode: the language code to get the message for (string) - or -
906 whether to use the content language (true) or site language (false) (bool)
907 &$transform: whether or not to expand variables and templates in the message (bool)
909 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
910 &$changeslist: The OldChangesList instance.
911 &$s: HTML of the form "<li>...</li>" containing one RC entry.
912 &$rc: The RecentChange object.
914 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
915 Hooks can alter or append to the array of URLs for search & suggestion formats.
916 &$urls: array of associative arrays with Url element attributes
918 'OutputPageBeforeHTML': a page has been processed by the parser and
919 the resulting HTML is about to be displayed.
920 $parserOutput: the parserOutput (object) that corresponds to the page
921 $text: the text that will be displayed, in HTML (string)
923 'OutputPageCheckLastModified': when checking if the page has been modified since the last visit
924 &$modifiedTimes: array of timestamps, the following keys are set: page, user, epoch
926 'OutputPageParserOutput': after adding a parserOutput to $wgOut
927 $out: OutputPage instance (object)
928 $parserOutput: parserOutput instance being added in $out
930 'OutputPageMakeCategoryLinks': links are about to be generated for the page's categories.
931 Implementations should return false if they generate the category links, so the default link generation is skipped.
932 $out: OutputPage instance (object)
933 $categories: associative array, keys are category names, values are category types ("normal" or "hidden")
934 $links: array, intended to hold the result. Must be an associative array with category types as keys and arrays of HTML links as values.
936 'PageHistoryBeforeList': When a history page list is about to be constructed.
937 $article: the article that the history is loading for
939 'PageHistoryLineEnding' : right before the end <li> is added to a history line
940 $row: the revision row for this line
941 $s: the string representing this parsed line
943 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed
945 $queryInfo: the query parameters
947 'PageRenderingHash': alter the parser cache option hash key
948 A parser extension which depends on user options should install
949 this hook and append its values to the key.
950 $hash: reference to a hash key string which can be modified
952 'ParserAfterStrip': Same as ParserBeforeStrip
954 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
955 $parser: Parser object being used
956 $text: text that'll be returned
958 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
959 $parser: Parser object
961 $stripState: StripState instance being used
963 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
964 $parser: parser object
965 $text: text being parsed
966 $stripState: stripState used (object)
968 'ParserBeforeTidy': called before tidy and custom tags replacements
969 $parser: Parser object being used
972 'ParserClearState': called at the end of Parser::clearState()
973 $parser: Parser object being cleared
975 'ParserFirstCallInit': called when the parser initialises for the first time
976 &$parser: Parser object being cleared
978 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
979 $parser: Parser object
980 $varCache: array to store the value in case of multiples calls of the same magic word
981 $index: index (string) of the magic
982 $ret: value of the magic word (the hook should set it)
984 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
985 $parser: Parser object
986 $time: actual time (timestamp)
988 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
989 $parser: Parser object
990 $varCache: varaiable cache (array)
992 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
993 $parser: Parser object
994 $limitReport: text that will be included (without comment tags)
996 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
997 $title: title object representing the file
998 $file: file object that will be used to create the image
999 &$params: 2-D array of parameters
1001 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
1002 $parser: Parser object created
1004 'ParserTestTables': alter the list of tables to duplicate when parser tests
1005 are run. Use when page save hooks require the presence of custom tables
1006 to ensure that tests continue to run properly.
1007 &$tables: array of table names
1009 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1010 my talk page, my contributions" etc).
1012 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1013 &$title: Title object representing the current page
1015 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1016 &$user : User performing the action
1017 $action : Action being performed
1018 &$result : Whether or not the action should be prevented
1019 Change $result and return false to give a definitive answer, otherwise
1020 the built-in rate limiting checks are used, if enabled.
1022 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
1023 $form : PreferencesForm object
1024 &$html : HTML to append to
1026 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1027 AJAX search suggestions. Put results into &$results outparam and return false.
1028 $ns : array of int namespace keys to search in
1029 $search : search term (not guaranteed to be conveniently normalized)
1030 $limit : maximum number of results to return
1031 &$results : out param: array of page names (strings)
1033 'PrefsEmailAudit': called when user changes his email address
1034 $user: User (object) changing his email address
1035 $oldaddr: old email address (string)
1036 $newaddr: new email address (string)
1038 'PrefsPasswordAudit': called when user changes his password
1039 $user: User (object) changing his passoword
1040 $newPass: new password
1041 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1043 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1044 &$obj: RawPage object
1045 &$text: The text that's going to be the output
1047 'RecentChange_save': called at the end of RecenChange::save()
1048 $recentChange: RecentChange object
1050 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
1051 $form: the PreferencesForm
1052 $out: output page to render to, probably $wgOut
1054 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
1055 $form: the PreferencesForm
1056 $user: the User object to load preferences from
1058 'RevisionInsertComplete': called after a revision is inserted into the DB
1059 &$revision: the Revision
1060 $data: the data stored in old_text. The meaning depends on $flags: if external
1061 is set, it's the URL of the revision text in external storage; otherwise,
1062 it's the revision text itself. In either case, if gzip is set, the revision
1064 $flags: a comma-delimited list of strings representing the options used. May
1065 include: utf8 (this will always be set for new revisions); gzip; external.
1067 'SavePreferences': called at the end of PreferencesForm::savePreferences;
1068 returning false prevents the preferences from being saved.
1069 $form: the PreferencesForm
1070 $user: the User object to save preferences to
1071 $message: change this to set an error message (ignored if the hook does not return false)
1072 $old: old preferences of the user
1074 'SearchUpdate': Prior to search update completion
1076 $namespace : Page namespace
1078 $text : Current text being indexed
1080 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1081 $term : Search term string
1082 &$title : Outparam; set to $title object and return false for a match
1084 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1085 $text: Text being shown
1086 $title: Title of the custom script/stylesheet page
1087 $output: Current OutputPage object
1089 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1090 &$siteNotice: HTML returned as the sitenotice
1091 Return true to allow the normal method of notice selection/rendering to work,
1092 or change the value of $siteNotice and return false to alter it.
1094 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1095 &$siteNotice: HTML sitenotice
1096 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1098 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1100 &$text: bottomScripts Text
1101 Append to $text to add additional text/scripts after the stock bottom scripts.
1103 'SkinAfterContent': Allows extensions to add text after the page content and
1105 &$data: (string) Text to be printed out directly (without parsing)
1106 This hook should work in all skins. Just set the &$data variable to the text
1107 you're going to add.
1109 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1111 &$bar: Sidebar contents
1112 Modify $bar to add or modify sidebar portlets.
1114 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1116 &$subpages: Subpage links HTML
1117 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
1118 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
1120 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
1121 $sktemplate: SkinTemplate object
1122 $content_actions: array of tabs
1124 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
1125 $sktemplate: SkinTemplate object
1126 $nav_urls: array of tabs
1128 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1129 &$content_actions: Content actions
1130 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1133 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
1134 &$sktemplate: SkinTemplate object
1135 &$tpl: Template engine object
1137 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1138 $sktemplate: SkinTemplate object
1139 $res: set to true to prevent active tabs
1141 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1144 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1145 You can either create your own array, or alter the parameters for the normal one.
1146 &$this: The SkinTemplate instance.
1147 $title: Title instance for the page.
1148 $message: Visible label of tab.
1149 $selected: Whether this is a selected tab.
1150 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1151 &$classes: Array of CSS classes to apply.
1152 &$query: Query string to add to link.
1154 &$result: Complete assoc. array if you want to return true.
1156 'SkinTemplateTabs': called when finished to build the actions tabs
1157 $sktemplate: SkinTemplate object
1158 $content_actions: array of tabs
1160 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1161 $tools: array of tools
1163 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1164 $id: User identifier
1166 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1167 $pager: The UsersPager instance
1168 $query: The query array to be returned
1170 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1171 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1172 $row: Database row object
1174 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1175 $pager: The UsersPager instance
1176 $out: The header HTML
1178 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1179 $pager: The UsersPager instance
1180 $out: The header HTML
1182 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1183 $pager: The UsersPager instance
1184 $query: The query array to be returned
1186 'SpecialMovepageAfterMove': called after moving a page
1187 $movePage: MovePageForm object
1188 $oldTitle: old title (object)
1189 $newTitle: new title (object)
1191 'SpecialPageExecuteAfterPage': called after executing a special page
1192 Warning: Not all the special pages call this hook
1193 $specialPage: SpecialPage object
1194 $par: paramter passed to the special page (string)
1195 $funct: function called to execute the special page
1197 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1198 Warning: Not all the special pages call this hook
1199 $specialPage: SpecialPage object
1200 $par: paramter passed to the special page (string)
1201 $funct: function called to execute the special page
1203 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1204 Warning: Not all the special pages call this hook
1205 $specialPage: SpecialPage object
1206 $par: paramter passed to the special page (string)
1207 $funct: function called to execute the special page
1209 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1210 $list: list (array) of core special pages
1212 'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges
1213 &$extraOpts: array of added items, to which can be added
1214 $opts: FormOptions for this request
1216 'SpecialRecentChangesQuery': called when building sql query for SpecialRecentChanges
1217 &$conds: array of where conditionals for query
1218 &$tables: array of tables to be queried
1219 &$join_conds: join conditions for the tables
1220 $opts: FormOptions for this request
1221 &$fields: select fields
1223 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1224 $title: title object generated from the text entred by the user
1226 'SpecialSearchResults': called before search result display when there are matches
1227 $term: string of search term
1228 &$titleMatches: empty or SearchResultSet object
1229 &$textMatches: empty or SearchResultSet object
1231 'SpecialSearchNoResults': called before search result display when there are no matches
1232 $term: string of search term
1234 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1235 $extTypes: associative array of extensions types
1237 'TitleArrayFromResult': called when creating an TitleArray object from a database result
1238 &$titleArray: set this to an object to override the default object returned
1239 $res: database result used to create the object
1241 'TitleMoveComplete': after moving an article (title)
1244 $user: user who did the move
1245 $pageid: database ID of the page that's been moved
1246 $redirid: database ID of the created redirect
1248 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1249 $title: title object related to the revision
1250 $rev: revision (object) that will be viewed
1252 'UnknownAction': An unknown "action" has occured (useful for defining
1254 $action: action name
1255 $article: article "acted on"
1257 'UnwatchArticle': before a watch is removed from an article
1258 $user: user watching
1259 $article: article object to be removed
1261 'UnwatchArticle': after a watch is removed from an article
1262 $user: user that was watching
1263 $article: article object removed
1265 'UnwatchArticleComplete': after a watch is removed from an article
1266 $user: user that watched
1267 $article: article object that was watched
1269 'UploadForm:initial': before the upload form is generated
1270 $form: UploadForm object
1271 You might set the member-variables $uploadFormTextTop and
1272 $uploadFormTextAfterSummary to inject text (HTML) either before
1273 or after the editform.
1275 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1276 $form: UploadForm object
1277 Lets you poke at member variables like $mUploadDescription before the
1280 'UploadVerification': additional chances to reject an uploaded file
1281 string $saveName: destination file name
1282 string $tempName: filesystem path to the temporary file for checks
1283 string &$error: output: HTML error to show if upload canceled by returning false
1285 'UploadComplete': Upon completion of a file upload
1286 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1288 'User::mailPasswordInternal': before creation and mailing of a user's new temporary password
1289 $user: the user who sent the message out
1290 $ip: IP of the user who sent the message out
1291 $u: the account whose new password will be set
1293 'UserArrayFromResult': called when creating an UserArray object from a database result
1294 &$userArray: set this to an object to override the default object returned
1295 $res: database result used to create the object
1297 'userCan': To interrupt/advise the "user can do X to Y article" check.
1298 If you want to display an error message, try getUserPermissionsErrors.
1299 $title: Title object being checked against
1300 $user : Current user object
1301 $action: Action being checked
1302 $result: Pointer to result returned if hook returns false. If null is returned,
1303 userCan checks are continued by internal code.
1305 'UserCanSendEmail': To override User::canSendEmail() permission check
1306 $user: User (object) whose permission is being checked
1307 &$canSend: bool set on input, can override on output
1310 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1311 $user: User (object) that'll clear the message
1313 'UserCreateForm': change to manipulate the login form
1314 $template: SimpleTemplate instance for the form
1316 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1317 $user: User to get groups for
1318 &$groups: Current effective groups
1320 'UserGetAllRights': after calculating a list of all available rights
1321 &$rights: Array of rights, which may be added to.
1323 'UserGetEmail': called when getting an user email address
1325 &$email: email, change this to override local email
1327 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1329 &$timestamp: timestamp, change this to override local email authentification timestamp
1331 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1332 &$groups: List of implicit (automatically-assigned) groups
1334 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1335 *&$reservedUsernames: $wgReservedUsernames
1337 'UserGetRights': Called in User::getRights()
1338 $user: User to get rights for
1339 &$rights: Current rights
1341 'UserLoadDefaults': called when loading a default user
1345 'UserLoadFromSession': called to authenticate users on external/environmental means
1346 $user: user object being loaded
1347 &$result: set this to a boolean value to abort the normal authentification process
1349 'UserLoginComplete': after a user has logged in
1350 $user: the user object that was created on login
1351 $inject_html: Any HTML to inject after the "logged in" message.
1353 'UserLoginForm': change to manipulate the login form
1354 $template: SimpleTemplate instance for the form
1356 'UserLogout': before a user logs out
1357 $user: the user object that is about to be logged out
1359 'UserLogoutComplete': after a user has logged out
1360 $user: the user object _after_ logout (won't have name, ID, etc.)
1361 $inject_html: Any HTML to inject after the "logged out" message.
1362 $oldName: name of the user before logout (string)
1364 'UserRights': After a user's group memberships are changed
1365 $user : User object that was changed
1366 $add : Array of strings corresponding to groups added
1367 $remove: Array of strings corresponding to groups removed
1369 'UserrightsChangeableGroups': allows modification of the groups a user may add or remove via Special:UserRights
1370 $userrights : UserrightsPage object
1371 $user : User object of the current user
1372 $addergroups : Array of groups that the user is in
1373 &$groups : Array of groups that can be added or removed. In format of
1375 'add' => array( addablegroups ),
1376 'remove' => array( removablegroups ),
1377 'add-self' => array( addablegroups to self ),
1378 'remove-self' => array( removable groups from self )
1381 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1382 $user: user retrieving new talks messages
1383 $talks: array of new talks page(s)
1385 'UserSaveSettings': called when saving user settings
1388 'UserSetCookies': called when setting user cookies
1390 &$session: session array, will be added to $_SESSION
1391 &$cookies: cookies array mapping cookie name to its value
1393 'UserSetEmail': called when changing user email address
1395 &$email: new email, change this to override new email address
1397 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1399 &$timestamp: new timestamp, change this to override local email authentification timestamp
1401 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1402 $toggles: array of toggles to add
1404 'WatchArticle': before a watch is added to an article
1405 $user: user that will watch
1406 $article: article object to be watched
1408 'WatchArticleComplete': after a watch is added to an article
1409 $user: user that watched
1410 $article: article object watched
1412 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1413 $query: $wgQueryPages itself
1415 More hooks might be available but undocumented, you can execute
1416 ./maintenance/findhooks.php to find hidden one.