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 'APIGetAllowedParams': use this hook to modify a module's parameters.
277 &$module: Module object
278 &$params: Array of parameters
280 'APIGetParamDescription': use this hook to modify a module's parameter
282 &$module: Module object
283 &$desc: Array of parameter descriptions
285 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
286 Every token has an action, which will be used in the intoken parameter
287 and in the output (actiontoken="..."), and a callback function which
288 should return the token, or false if the user isn't allowed to obtain
289 it. The prototype of the callback function is func($pageid, $title)
290 where $pageid is the page ID of the page the token is requested for
291 and $title is the associated Title object. In the hook, just add
292 your callback to the $tokenFunctions array and return true (returning
293 false makes no sense)
294 $tokenFunctions: array(action => callback)
296 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
297 Every token has an action, which will be used in the rvtoken parameter
298 and in the output (actiontoken="..."), and a callback function which
299 should return the token, or false if the user isn't allowed to obtain
300 it. The prototype of the callback function is func($pageid, $title, $rev)
301 where $pageid is the page ID of the page associated to the revision the
302 token is requested for, $title the associated Title object and $rev the
303 associated Revision object. In the hook, just add your callback to the
304 $tokenFunctions array and return true (returning false makes no sense)
305 $tokenFunctions: array(action => callback)
307 'APIQueryRecentChangesTokens': use this hook to add custom tokens to list=recentchanges.
308 Every token has an action, which will be used in the rctoken parameter
309 and in the output (actiontoken="..."), and a callback function which
310 should return the token, or false if the user isn't allowed to obtain
311 it. The prototype of the callback function is func($pageid, $title, $rc)
312 where $pageid is the page ID of the page associated to the revision the
313 token is requested for, $title the associated Title object and $rc the
314 associated RecentChange object. In the hook, just add your callback to the
315 $tokenFunctions array and return true (returning false makes no sense)
316 $tokenFunctions: array(action => callback)
318 'ArticleAfterFetchContent': after fetching content of an article from the database
319 $article: the article (object) being loaded from the database
320 $content: the content (string) of the article
322 'ArticleDelete': before an article is deleted
323 $article: the article (object) being deleted
324 $user: the user (object) deleting the article
325 $reason: the reason (string) the article is being deleted
326 $error: if the deletion was prohibited, the (raw HTML) error message to display
329 'ArticleDeleteComplete': after an article is deleted
330 $article: the article that was deleted
331 $user: the user that deleted the article
332 $reason: the reason the article was deleted
333 $id: id of the article that was deleted
335 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
336 $article: article (object) of the user talk page
338 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
339 $article: article (object) being modified
341 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
342 $title: title (object) used to create the article object
343 $article: article (object) that will be returned
345 'ArticleInsertComplete': After a new article is created
346 $article: Article created
347 $user: User creating the article
349 $summary: Edit summary/comment
350 $isMinor: Whether or not the edit was marked as minor
351 $isWatch: (No longer used)
352 $section: (No longer used)
353 $flags: Flags passed to Article::doEdit()
354 $revision: New Revision of the article
356 'ArticleMergeComplete': after merging to article using Special:Mergehistory
357 $targetTitle: target title (object)
358 $destTitle: destination title (object)
360 'ArticlePageDataAfter': after loading data of an article from the database
361 $article: article (object) whose data were loaded
362 $row: row (object) returned from the database server
364 'ArticlePageDataBefore': before loading data of an article from the database
365 $article: article (object) that data will be loaded
366 $fields: fileds (array) to load from the database
368 'ArticleProtect': before an article is protected
369 $article: the article being protected
370 $user: the user doing the protection
371 $protect: boolean whether this is a protect or an unprotect
372 $reason: Reason for protect
373 $moveonly: boolean whether this is for move only or not
375 'ArticleProtectComplete': after an article is protected
376 $article: the article that was protected
377 $user: the user who did the protection
378 $protect: boolean whether it was a protect or an unprotect
379 $reason: Reason for protect
380 $moveonly: boolean whether it was for move only or not
382 'ArticlePurge': before executing "&action=purge"
383 $article: article (object) to purge
385 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
386 revision of an article
387 &$title: title object of the article
389 'ArticleRevisionUndeleted': after an article revision is restored
390 $title: the article title
391 $revision: the revision
392 $oldPageID: the page ID of the revision when archived (may be null)
394 'ArticleRollbackComplete': after an article rollback is completed
395 $article: the article that was edited
396 $user: the user who did the rollback
397 $revision: the revision the page was reverted back to
399 'ArticleSave': before an article is saved
400 $article: the article (object) being saved
401 $user: the user (object) saving the article
402 $text: the new article text
403 $summary: the article summary (comment)
408 'ArticleSaveComplete': After an article has been updated
409 $article: Article modified
410 $user: User performing the modification
412 $summary: Edit summary/comment
413 $isMinor: Whether or not the edit was marked as minor
414 $isWatch: (No longer used)
415 $section: (No longer used)
416 $flags: Flags passed to Article::doEdit()
417 $revision: New Revision of the article
419 'ArticleUndelete': When one or more revisions of an article are restored
420 $title: Title corresponding to the article restored
421 $create: Whether or not the restoration caused the page to be created
422 (i.e. it didn't exist before)
424 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
425 &$article: the article
426 &$sectionanchor: The section anchor link (e.g. "#overview" )
427 &$extraq: Extra query parameters which can be added via hooked functions
429 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
430 &$article: the article
431 &$pcache: whether to try the parser cache or not
432 &$outputDone: whether the output for this page finished or not
434 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
435 $article: target article (object)
437 'AuthPluginAutoCreate': Called when creating a local account for an user logged
438 in from an external authentication method
439 $user: User object created locally
441 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
442 Gives a chance for an extension to set it programattically to a variable class.
443 &$auth: the $wgAuth object, probably a stub
445 'AutopromoteCondition': check autopromote condition for user.
446 $type: condition type
449 $result: result of checking autopromote condition
451 'BadImage': When checking against the bad image list
452 $name: Image name being checked
453 &$bad: Whether or not the image is "bad"
455 Change $bad and return false to override. If an image is "bad", it is not
456 rendered inline in wiki pages or galleries in category pages.
458 'BeforeGalleryFindFile': before an image is fetched for a gallery
459 &$gallery,: the gallery object
460 &$nt: the image title
461 &$time: image timestamp
463 'BeforePageDisplay': Prior to outputting a page
464 &$out: OutputPage object
467 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
468 &$parser: Parser object
469 &$title: title of the template
470 &$skip: skip this template and link it?
471 &$id: the id of the revision being parsed
473 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
474 &$parser: Parser object
475 &$nt: the image title
476 &$skip: skip this image and link it?
477 &$time: the image timestamp
479 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
480 &$parser: Parser object
481 &$ig: ImageGallery object
483 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
484 $nondefaults: Assoc array with the following keys:
485 days, hideOwn, hideBots, hideMinor, namespace
487 &$hookSql: a string which will be inserted without sanitation into the SQL query
488 used to get the watchlist, at the end of the WHERE part.
490 'BlockIp': before an IP address or user is blocked
491 $block: the Block object about to be saved
492 $user: the user _doing_ the block (not the one being blocked)
494 'BlockIpComplete': after an IP address or user is blocked
495 $block: the Block object that was saved
496 $user: the user who did the block (not the one being blocked)
498 'BookInformation': Before information output on Special:Booksources
499 $isbn: ISBN to show information for
500 $output: OutputPage object in use
502 'CategoryPageView': before viewing a categorypage in CategoryPage::view
503 $catpage: CategoryPage instance
505 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
506 &$this: ChangesList instance.
507 &$articlelink: HTML of link to article (already filled-in).
508 &$s: HTML of row that is being constructed.
509 &$rc: RecentChange instance.
510 $unpatrolled: Whether or not we are showing unpatrolled changes.
511 $watched: Whether or not the change is watched by the user.
513 'ContribsPager::getQueryInfo': Before the contributions query is about to run
514 &$pager: Pager object for contributions
515 &queryInfo: The query for the contribs Pager
517 'ContributionsLineEnding': Called before a contributions HTML line is finished
518 $page: SpecialPage object for contributions
520 $row: the DB row for this line
522 'ContributionsToolLinks': Change tool links above Special:Contributions
524 $title: User page title
525 &$tools: Array of tool links
527 'CustomEditor': When invoking the page editor
528 $article: Article being edited
529 $user: User performing the edit
531 Return true to allow the normal editor to be used, or false
532 if implementing a custom editor, e.g. for a special namespace,
535 'DiffViewHeader': called before diff display
536 $diff: DifferenceEngine object that's calling
537 $oldRev: Revision object of the "old" revision (may be null/invalid)
538 $newRev: Revision object of the "new" revision
540 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
541 $article: article (object) being viewed
542 $oldid: oldid (int) being viewed
544 'DoEditSectionLink': Override the HTML generated for section edit links
545 $skin: Skin object rendering the UI
546 $title: Title object for the title being linked to (may not be the same as
547 $wgTitle, if the section is included from a template)
548 $section: The designation of the section being pointed to, to be included in
549 the link, like "§ion=$section"
550 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
551 By default, this is wrapped in the 'editsectionhint' message.
552 $result: The HTML to return, prefilled with the default plus whatever other
553 changes earlier hooks have made
555 'EditFilter': Perform checks on an edit
556 $editor: Edit form (see includes/EditPage.php)
557 $text: Contents of the edit box
558 $section: Section being edited
559 &$error: Error message to return
560 $summary: Edit summary for page
562 'EditFilterMerged': Post-section-merge edit filter
563 $editor: EditPage instance (object)
564 $text: content of the edit box
565 $error: error message to return
566 $summary: Edit summary for page
568 'EditFormPreloadText': Allows population of the edit form when creating new pages
569 &$text: Text to preload with
570 &$title: Title object representing the page being created
572 'EditPage::attemptSave': called before an article is
573 saved, that is before insertNewArticle() is called
574 &$editpage_Obj: the current EditPage object
576 'EditPage::showEditForm:fields': allows injection of form field into edit form
577 &$editor: the EditPage instance for reference
578 &$out: an OutputPage instance to write to
579 return value is ignored (should always return true)
581 'EditPage::showEditForm:initial': before showing the edit form
582 $editor: EditPage instance (object)
584 Return false to halt editing; you'll need to handle error messages, etc. yourself.
585 Alternatively, modifying $error and returning true will cause the contents of $error
586 to be echoed at the top of the edit form as wikitext. Return true without altering
587 $error to allow the edit to proceed.
589 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
590 when there's an edit conflict. Return false to halt normal diff output; in
591 this case you're responsible for computing and outputting the entire "conflict"
592 part, i.e., the "difference between revisions" and "your text" headers and
594 &$editor: EditPage instance
595 &$out: OutputPage instance
597 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
598 &$editpage: The current EditPage object
599 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
601 'EditSectionLink': Do not use, use DoEditSectionLink instead.
602 $skin: Skin rendering the UI
603 $title: Title being linked to
604 $section: Section to link to
606 $result: Result (alter this to override the generated links)
608 'EmailConfirmed': When checking that the user's email address is "confirmed"
609 $user: User being checked
610 $confirmed: Whether or not the email address is confirmed
611 This runs before the other checks, such as anonymity and the real check; return
612 true to allow those checks to occur, and false if checking is done.
614 'EmailUser': before sending email from one user to another
615 $to: address of receiving user
616 $from: address of sending user
617 $subject: subject of the mail
618 $text: text of the mail
620 'EmailUserComplete': after sending email from one user to another
621 $to: address of receiving user
622 $from: address of sending user
623 $subject: subject of the mail
624 $text: text of the mail
626 'FetchChangesList': When fetching the ChangesList derivative for a particular user
627 &$user: User the list is being fetched for
628 &$skin: Skin object to be used with the list
629 &$list: List object (defaults to NULL, change it to an object instance and return
630 false override the list derivative used)
632 'FileDeleteComplete': When a file is deleted
633 $file: reference to the deleted file
634 $oldimage: in case of the deletion of an old image, the name of the old file
635 $article: in case all revisions of the file are deleted a reference to the article
636 associated with the file.
637 $user: user who performed the deletion
640 'FileUpload': When a file upload occurs
641 $file : Image object representing the file that was uploaded
643 'FileUndeleteComplete': When a file is undeleted
644 $title: title object to the file
645 $fileVersions: array of undeleted versions. Empty if all versions were restored
646 $user: user who performed the undeletion
649 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
650 &$user: user to promote.
651 &$promote: groups that will be added.
653 'GetBlockedStatus': after loading blocking status of an user from the database
654 $user: user (object) being checked
656 'GetCacheVaryCookies': get cookies that should vary cache options
657 $out: OutputPage object
658 &$cookies: array of cookies name, add a value to it if you want to add a cookie
659 that have to vary cache options
661 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
662 $title: Title object of page
663 $url: string value as output (out parameter, can modify)
664 $query: query options passed to Title::getFullURL()
666 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
667 $title: Title object of page
668 $url: string value as output (out parameter, can modify)
669 $query: query options passed to Title::getInternalURL()
671 'GetLinkColours': modify the CSS class of an array of page links
672 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
673 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
675 'GetLocalURL': modify local URLs as output into page links
676 $title: Title object of page
677 $url: string value as output (out parameter, can modify)
678 $query: query options passed to Title::getLocalURL()
680 'getUserPermissionsErrors': Add a permissions error when permissions errors are
681 checked for. Use instead of userCan for most cases. Return false if the
682 user can't do it, and populate $result with the reason in the form of
683 array( messagename, param1, param2, ... ). For consistency, error messages
684 should be plain text with no special coloring, bolding, etc. to show that
685 they're errors; presenting them properly to the user as errors is done by
687 $title: Title object being checked against
688 $user : Current user object
689 $action: Action being checked
690 $result: User permissions error to add. If none, return true.
692 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
693 if expensive checks are enabled.
695 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted into the job queue.
696 $title: Title object, pages linked to this title are purged.
698 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
699 image insertion. You can skip the default logic entirely by returning
700 false, or just modify a few things using call-by-reference.
702 &$title: Title object of the image
703 &$file: File object, or false if it doesn't exist
704 &$frameParams: Various parameters with special meanings; see documentation in
705 includes/Linker.php for Linker::makeImageLink2
706 &$handlerParams: Various parameters with special meanings; see documentation in
707 includes/Linker.php for Linker::makeImageLink2
708 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
709 &$res: Final HTML output, used if you return false
712 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
713 the image on an image page
714 $imagePage: ImagePage object ($this)
717 'ImagePageFileHistoryLine': called when a file history line is contructed
719 $line: the HTML of the history line
720 $css: the line CSS class
722 'ImagePageFindFile': called when fetching the file associated with an image page
723 $page: ImagePage object
725 &$displayFile: displayed File object
727 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
728 $title: Title object ($wgTitle)
730 $ignoreRedirect: boolean to skip redirect check
731 $target: Title/string of redirect target
733 'InitPreferencesForm': called at the end of PreferencesForm's constructor
734 $form: the PreferencesForm
735 $request: the web request to initialized from
737 'InternalParseBeforeLinks': during Parser's internalParse method before links but
738 after noinclude/includeonly/onlyinclude and other processing.
739 &$this: Parser object
740 &$text: string containing partially parsed text
741 &$this->mStripState: Parser's internal StripState object
743 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
744 $article: article (object) being checked
746 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
748 $result: Change this value to override the result of wfIsTrustedProxy()
750 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
751 tance to return false if the domain name doesn't match your organization
752 $addr: The e-mail address entered by the user
753 &$result: Set this and return false to override the internal checks
755 'isValidPassword': Override the result of User::isValidPassword()
756 $password: The password entered by the user
757 &$result: Set this and return false to override the internal checks
758 $user: User the password is being validated for
760 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
761 $magicExtensions: associative array of magic words synonyms
762 $lang: laguage code (string)
764 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
765 $specialPageAliases: associative array of magic words synonyms
766 $lang: laguage code (string)
768 'LinkBegin': Used when generating internal and interwiki links in
769 Linker::link(), before processing starts. Return false to skip default proces-
770 sing and return $ret. See documentation for Linker::link() for details on the
771 expected meanings of parameters.
772 $skin: the Skin object
773 $target: the Title that the link is pointing to
774 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
776 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
777 tive array form, with keys and values unescaped. Should be merged with de-
778 fault values, with a value of false meaning to suppress the attribute.
779 &$query: the query string to add to the generated URL (the bit after the "?"),
780 in associative array form, with keys and values unescaped.
781 &$options: the options. Can include 'known', 'broken', 'noclasses'.
782 &$ret: the value to return if your hook returns false.
784 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
785 just before the function returns a value. If you return true, an <a> element
786 with HTML attributes $attribs and contents $text will be returned. If you re-
787 turn false, $ret will be returned.
788 $skin: the Skin object
789 $target: the Title object that the link is pointing to
790 $options: the options. Will always include either 'known' or 'broken', and may
792 &$text: the final (raw HTML) contents of the <a> tag, after processing.
793 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
795 &$ret: the value to return if your hook returns false.
797 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just before the return
799 &$alt: the image's alt text
800 &$img: the new image HTML (if returning false)
802 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
804 &$text: the link text
805 &$link: the new link HTML (if returning false)
807 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
808 &$linksUpdate: the LinkUpdate object
810 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
811 &$linksUpdate: the LinkUpdate object
813 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
814 &$linksUpdate: the LinkUpdate object
816 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
818 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
820 'LocalFile::getHistory': called before file history query performed
823 $fields: select fields
826 $join_conds: JOIN conditions
828 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
829 No return data is accepted; this hook is for auditing only.
830 $user: the User object being authenticated against
831 $password: the password being submitted and found wanting
832 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
834 'LogLine': Processes a single log entry on Special:Log
835 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
837 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
838 to logging.log_action database field.
839 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
840 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
841 appears to contain anything.
842 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
843 &$revert: string that is displayed in the UI, similar to $comment.
844 $time: timestamp of the log entry (added in 1.12)
846 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
847 &$type: array of strings
849 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
850 &$typeText: array of strings
852 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
853 &$headerText: array of strings
855 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
856 &$actionText: array of strings
858 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
859 $magicWords: array of strings
861 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
862 $variableIDs: array of strings
864 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript is executed
865 &$vars: variable (or multiple variables) to be added into the output
866 of Skin::makeVariablesScript
868 'MarkPatrolled': before an edit is marked patrolled
869 $rcid: ID of the revision to be marked patrolled
870 $user: the user (object) marking the revision as patrolled
871 $wcOnlySysopsCanPatrol: config setting indicating whether the user
872 needs to be a sysop in order to mark an edit patrolled
874 'MarkPatrolledComplete': after an edit is marked patrolled
875 $rcid: ID of the revision marked as patrolled
876 $user: user (object) who marked the edit patrolled
877 $wcOnlySysopsCanPatrol: config setting indicating whether the user
878 must be a sysop to patrol the edit
880 'MathAfterTexvc': after texvc is executed when rendering mathematics
881 $mathRenderer: instance of MathRenderer
882 $errmsg: error message, in HTML (string). Nonempty indicates failure
883 of rendering the formula
885 'MediaWikiPerformAction': Override MediaWiki::performAction().
886 Use this to do something completely different, after the basic
887 globals have been set up, but before ordinary actions take place.
893 $this: The $mediawiki object
895 'MessagesPreLoad': When loading a message from the database
896 $title: title of the message (string)
897 $message: value (string), change it to the message you want to define
899 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
900 Note: this is only run for the Monobook skin. To add items to the toolbox
901 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
903 $tools: array of tools
905 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
906 $article: the article edited
907 $rev: the new revision
908 $baseID: the revision ID this was based off, if any
910 'NormalizeMessageKey': Called before the software gets the text of a message
911 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets displayed
912 &$key: the message being looked up. Change this to something else to change what message gets displayed (string)
913 &$useDB: whether or not to look up the message in the database (bool)
914 &$langCode: the language code to get the message for (string) - or -
915 whether to use the content language (true) or site language (false) (bool)
916 &$transform: whether or not to expand variables and templates in the message (bool)
918 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
919 &$changeslist: The OldChangesList instance.
920 &$s: HTML of the form "<li>...</li>" containing one RC entry.
921 &$rc: The RecentChange object.
923 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
924 Hooks can alter or append to the array of URLs for search & suggestion formats.
925 &$urls: array of associative arrays with Url element attributes
927 'OutputPageBeforeHTML': a page has been processed by the parser and
928 the resulting HTML is about to be displayed.
929 $parserOutput: the parserOutput (object) that corresponds to the page
930 $text: the text that will be displayed, in HTML (string)
932 'OutputPageCheckLastModified': when checking if the page has been modified since the last visit
933 &$modifiedTimes: array of timestamps, the following keys are set: page, user, epoch
935 'OutputPageParserOutput': after adding a parserOutput to $wgOut
936 $out: OutputPage instance (object)
937 $parserOutput: parserOutput instance being added in $out
939 'OutputPageMakeCategoryLinks': links are about to be generated for the page's categories.
940 Implementations should return false if they generate the category links, so the default link generation is skipped.
941 $out: OutputPage instance (object)
942 $categories: associative array, keys are category names, values are category types ("normal" or "hidden")
943 $links: array, intended to hold the result. Must be an associative array with category types as keys and arrays of HTML links as values.
945 'PageHistoryBeforeList': When a history page list is about to be constructed.
946 $article: the article that the history is loading for
948 'PageHistoryLineEnding' : right before the end <li> is added to a history line
949 $row: the revision row for this line
950 $s: the string representing this parsed line
952 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed
954 $queryInfo: the query parameters
956 'PageRenderingHash': alter the parser cache option hash key
957 A parser extension which depends on user options should install
958 this hook and append its values to the key.
959 $hash: reference to a hash key string which can be modified
961 'ParserAfterStrip': Same as ParserBeforeStrip
963 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
964 $parser: Parser object being used
965 $text: text that'll be returned
967 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
968 $parser: Parser object
970 $stripState: StripState instance being used
972 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
973 $parser: parser object
974 $text: text being parsed
975 $stripState: stripState used (object)
977 'ParserBeforeTidy': called before tidy and custom tags replacements
978 $parser: Parser object being used
981 'ParserClearState': called at the end of Parser::clearState()
982 $parser: Parser object being cleared
984 'ParserFirstCallInit': called when the parser initialises for the first time
985 &$parser: Parser object being cleared
987 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
988 $parser: Parser object
989 $varCache: array to store the value in case of multiples calls of the same magic word
990 $index: index (string) of the magic
991 $ret: value of the magic word (the hook should set it)
993 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
994 $parser: Parser object
995 $time: actual time (timestamp)
997 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
998 $parser: Parser object
999 $varCache: varaiable cache (array)
1001 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
1002 $parser: Parser object
1003 $limitReport: text that will be included (without comment tags)
1005 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
1006 $title: title object representing the file
1007 $file: file object that will be used to create the image
1008 &$params: 2-D array of parameters
1010 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
1011 $parser: Parser object created
1013 'ParserTestTables': alter the list of tables to duplicate when parser tests
1014 are run. Use when page save hooks require the presence of custom tables
1015 to ensure that tests continue to run properly.
1016 &$tables: array of table names
1018 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1019 my talk page, my contributions" etc).
1021 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1022 &$title: Title object representing the current page
1024 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1025 &$user : User performing the action
1026 $action : Action being performed
1027 &$result : Whether or not the action should be prevented
1028 Change $result and return false to give a definitive answer, otherwise
1029 the built-in rate limiting checks are used, if enabled.
1031 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
1032 $form : PreferencesForm object
1033 &$html : HTML to append to
1035 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1036 AJAX search suggestions. Put results into &$results outparam and return false.
1037 $ns : array of int namespace keys to search in
1038 $search : search term (not guaranteed to be conveniently normalized)
1039 $limit : maximum number of results to return
1040 &$results : out param: array of page names (strings)
1042 'PrefsEmailAudit': called when user changes his email address
1043 $user: User (object) changing his email address
1044 $oldaddr: old email address (string)
1045 $newaddr: new email address (string)
1047 'PrefsPasswordAudit': called when user changes his password
1048 $user: User (object) changing his passoword
1049 $newPass: new password
1050 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1052 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1053 &$obj: RawPage object
1054 &$text: The text that's going to be the output
1056 'RecentChange_save': called at the end of RecenChange::save()
1057 $recentChange: RecentChange object
1059 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
1060 $form: the PreferencesForm
1061 $out: output page to render to, probably $wgOut
1063 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
1064 $form: the PreferencesForm
1065 $user: the User object to load preferences from
1067 'RevisionInsertComplete': called after a revision is inserted into the DB
1068 &$revision: the Revision
1069 $data: the data stored in old_text. The meaning depends on $flags: if external
1070 is set, it's the URL of the revision text in external storage; otherwise,
1071 it's the revision text itself. In either case, if gzip is set, the revision
1073 $flags: a comma-delimited list of strings representing the options used. May
1074 include: utf8 (this will always be set for new revisions); gzip; external.
1076 'SavePreferences': called at the end of PreferencesForm::savePreferences;
1077 returning false prevents the preferences from being saved.
1078 $form: the PreferencesForm
1079 $user: the User object to save preferences to
1080 $message: change this to set an error message (ignored if the hook does not return false)
1081 $old: old preferences of the user
1083 'SearchUpdate': Prior to search update completion
1085 $namespace : Page namespace
1087 $text : Current text being indexed
1089 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1090 $term : Search term string
1091 &$title : Outparam; set to $title object and return false for a match
1093 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1094 $text: Text being shown
1095 $title: Title of the custom script/stylesheet page
1096 $output: Current OutputPage object
1098 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1099 &$siteNotice: HTML returned as the sitenotice
1100 Return true to allow the normal method of notice selection/rendering to work,
1101 or change the value of $siteNotice and return false to alter it.
1103 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1104 &$siteNotice: HTML sitenotice
1105 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1107 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1109 &$text: bottomScripts Text
1110 Append to $text to add additional text/scripts after the stock bottom scripts.
1112 'SkinAfterContent': Allows extensions to add text after the page content and
1114 &$data: (string) Text to be printed out directly (without parsing)
1115 This hook should work in all skins. Just set the &$data variable to the text
1116 you're going to add.
1118 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1120 &$bar: Sidebar contents
1121 Modify $bar to add or modify sidebar portlets.
1123 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1125 &$subpages: Subpage links HTML
1126 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
1127 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
1129 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
1130 $sktemplate: SkinTemplate object
1131 $content_actions: array of tabs
1133 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
1134 $sktemplate: SkinTemplate object
1135 $nav_urls: array of tabs
1137 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1138 &$content_actions: Content actions
1139 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1142 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
1143 &$sktemplate: SkinTemplate object
1144 &$tpl: Template engine object
1146 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1147 $sktemplate: SkinTemplate object
1148 $res: set to true to prevent active tabs
1150 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1153 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1154 You can either create your own array, or alter the parameters for the normal one.
1155 &$this: The SkinTemplate instance.
1156 $title: Title instance for the page.
1157 $message: Visible label of tab.
1158 $selected: Whether this is a selected tab.
1159 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1160 &$classes: Array of CSS classes to apply.
1161 &$query: Query string to add to link.
1163 &$result: Complete assoc. array if you want to return true.
1165 'SkinTemplateTabs': called when finished to build the actions tabs
1166 $sktemplate: SkinTemplate object
1167 $content_actions: array of tabs
1169 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1170 $tools: array of tools
1172 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1173 $id: User identifier
1175 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1176 $pager: The UsersPager instance
1177 $query: The query array to be returned
1179 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1180 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1181 $row: Database row object
1183 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1184 $pager: The UsersPager instance
1185 $out: The header HTML
1187 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1188 $pager: The UsersPager instance
1189 $out: The header HTML
1191 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1192 $pager: The UsersPager instance
1193 $query: The query array to be returned
1195 'SpecialMovepageAfterMove': called after moving a page
1196 $movePage: MovePageForm object
1197 $oldTitle: old title (object)
1198 $newTitle: new title (object)
1200 'SpecialPageExecuteAfterPage': called after executing a special page
1201 Warning: Not all the special pages call this hook
1202 $specialPage: SpecialPage object
1203 $par: paramter passed to the special page (string)
1204 $funct: function called to execute the special page
1206 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1207 Warning: Not all the special pages call this hook
1208 $specialPage: SpecialPage object
1209 $par: paramter passed to the special page (string)
1210 $funct: function called to execute the special page
1212 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1213 Warning: Not all the special pages call this hook
1214 $specialPage: SpecialPage object
1215 $par: paramter passed to the special page (string)
1216 $funct: function called to execute the special page
1218 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1219 $list: list (array) of core special pages
1221 'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges
1222 &$extraOpts: array of added items, to which can be added
1223 $opts: FormOptions for this request
1225 'SpecialRecentChangesQuery': called when building sql query for SpecialRecentChanges
1226 &$conds: array of where conditionals for query
1227 &$tables: array of tables to be queried
1228 &$join_conds: join conditions for the tables
1229 $opts: FormOptions for this request
1230 &$fields: select fields
1232 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1233 $title: title object generated from the text entred by the user
1235 'SpecialSearchResults': called before search result display when there are matches
1236 $term: string of search term
1237 &$titleMatches: empty or SearchResultSet object
1238 &$textMatches: empty or SearchResultSet object
1240 'SpecialSearchNoResults': called before search result display when there are no matches
1241 $term: string of search term
1243 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1244 $extTypes: associative array of extensions types
1246 'TitleArrayFromResult': called when creating an TitleArray object from a database result
1247 &$titleArray: set this to an object to override the default object returned
1248 $res: database result used to create the object
1250 'TitleMoveComplete': after moving an article (title)
1253 $user: user who did the move
1254 $pageid: database ID of the page that's been moved
1255 $redirid: database ID of the created redirect
1257 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1258 $title: title object related to the revision
1259 $rev: revision (object) that will be viewed
1261 'UnknownAction': An unknown "action" has occured (useful for defining
1263 $action: action name
1264 $article: article "acted on"
1266 'UnwatchArticle': before a watch is removed from an article
1267 $user: user watching
1268 $article: article object to be removed
1270 'UnwatchArticle': after a watch is removed from an article
1271 $user: user that was watching
1272 $article: article object removed
1274 'UnwatchArticleComplete': after a watch is removed from an article
1275 $user: user that watched
1276 $article: article object that was watched
1278 'UploadForm:initial': before the upload form is generated
1279 $form: UploadForm object
1280 You might set the member-variables $uploadFormTextTop and
1281 $uploadFormTextAfterSummary to inject text (HTML) either before
1282 or after the editform.
1284 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1285 $form: UploadForm object
1286 Lets you poke at member variables like $mUploadDescription before the
1289 'UploadVerification': additional chances to reject an uploaded file
1290 string $saveName: destination file name
1291 string $tempName: filesystem path to the temporary file for checks
1292 string &$error: output: HTML error to show if upload canceled by returning false
1294 'UploadComplete': Upon completion of a file upload
1295 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1297 'User::mailPasswordInternal': before creation and mailing of a user's new temporary password
1298 $user: the user who sent the message out
1299 $ip: IP of the user who sent the message out
1300 $u: the account whose new password will be set
1302 'UserArrayFromResult': called when creating an UserArray object from a database result
1303 &$userArray: set this to an object to override the default object returned
1304 $res: database result used to create the object
1306 'userCan': To interrupt/advise the "user can do X to Y article" check.
1307 If you want to display an error message, try getUserPermissionsErrors.
1308 $title: Title object being checked against
1309 $user : Current user object
1310 $action: Action being checked
1311 $result: Pointer to result returned if hook returns false. If null is returned,
1312 userCan checks are continued by internal code.
1314 'UserCanSendEmail': To override User::canSendEmail() permission check
1315 $user: User (object) whose permission is being checked
1316 &$canSend: bool set on input, can override on output
1319 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1320 $user: User (object) that'll clear the message
1322 'UserCreateForm': change to manipulate the login form
1323 $template: SimpleTemplate instance for the form
1325 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1326 $user: User to get groups for
1327 &$groups: Current effective groups
1329 'UserGetAllRights': after calculating a list of all available rights
1330 &$rights: Array of rights, which may be added to.
1332 'UserGetEmail': called when getting an user email address
1334 &$email: email, change this to override local email
1336 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1338 &$timestamp: timestamp, change this to override local email authentification timestamp
1340 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1341 &$groups: List of implicit (automatically-assigned) groups
1343 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1344 *&$reservedUsernames: $wgReservedUsernames
1346 'UserGetRights': Called in User::getRights()
1347 $user: User to get rights for
1348 &$rights: Current rights
1350 'UserLoadDefaults': called when loading a default user
1354 'UserLoadFromSession': called to authenticate users on external/environmental means
1355 $user: user object being loaded
1356 &$result: set this to a boolean value to abort the normal authentification process
1358 'UserLoginComplete': after a user has logged in
1359 $user: the user object that was created on login
1360 $inject_html: Any HTML to inject after the "logged in" message.
1362 'UserLoginForm': change to manipulate the login form
1363 $template: SimpleTemplate instance for the form
1365 'UserLogout': before a user logs out
1366 $user: the user object that is about to be logged out
1368 'UserLogoutComplete': after a user has logged out
1369 $user: the user object _after_ logout (won't have name, ID, etc.)
1370 $inject_html: Any HTML to inject after the "logged out" message.
1371 $oldName: name of the user before logout (string)
1373 'UserRights': After a user's group memberships are changed
1374 $user : User object that was changed
1375 $add : Array of strings corresponding to groups added
1376 $remove: Array of strings corresponding to groups removed
1378 'UserrightsChangeableGroups': allows modification of the groups a user may add or remove via Special:UserRights
1379 $userrights : UserrightsPage object
1380 $user : User object of the current user
1381 $addergroups : Array of groups that the user is in
1382 &$groups : Array of groups that can be added or removed. In format of
1384 'add' => array( addablegroups ),
1385 'remove' => array( removablegroups ),
1386 'add-self' => array( addablegroups to self ),
1387 'remove-self' => array( removable groups from self )
1390 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1391 $user: user retrieving new talks messages
1392 $talks: array of new talks page(s)
1394 'UserSaveSettings': called when saving user settings
1397 'UserSetCookies': called when setting user cookies
1399 &$session: session array, will be added to $_SESSION
1400 &$cookies: cookies array mapping cookie name to its value
1402 'UserSetEmail': called when changing user email address
1404 &$email: new email, change this to override new email address
1406 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1408 &$timestamp: new timestamp, change this to override local email authentification timestamp
1410 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1411 $toggles: array of toggles to add
1413 'WatchArticle': before a watch is added to an article
1414 $user: user that will watch
1415 $article: article object to be watched
1417 'WatchArticleComplete': after a watch is added to an article
1418 $user: user that watched
1419 $article: article object watched
1421 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1422 $query: $wgQueryPages itself
1424 More hooks might be available but undocumented, you can execute
1425 ./maintenance/findhooks.php to find hidden one.