* (bug 6695) Fix native language name of Southern Sotho (Sesotho) (st)
[mediawiki.git] / docs / hooks.txt
blobd9adf9603d16fcf547863222eebf7ef1ca4e24f0
1 hooks.txt
3 This document describes how event hooks work in MediaWiki; how to add
4 hooks for an event; and how to run hooks for an event.
6 ==Glossary==
8 event
9      Something that happens with the wiki. For example: a user logs
10      in. A wiki page is saved. A wiki page is deleted. Often there are
11      two events associated with a single action: one before the code
12      is run to make the event happen, and one after. Each event has a
13      name, preferably in CamelCase. For example, 'UserLogin',
14      'ArticleSave', 'ArticleSaveComplete', 'ArticleDelete'.
16 hook
17      A clump of code and data that should be run when an event
18      happens. This can be either a function and a chunk of data, or an
19      object and a method.
20      
21 hook function
22      The function part of a hook.
23      
24 ==Rationale==
26 Hooks allow us to decouple optionally-run code from code that is run
27 for everyone. It allows MediaWiki hackers, third-party developers and
28 local administrators to define code that will be run at certain points
29 in the mainline code, and to modify the data run by that mainline
30 code. Hooks can keep mainline code simple, and make it easier to
31 write extensions. Hooks are a principled alternative to local patches.
33 Consider, for example, two options in MediaWiki. One reverses the
34 order of a title before displaying the article; the other converts the
35 title to all uppercase letters. Currently, in MediaWiki code, we
36 would handle this as follows (note: not real code, here):
38         function showAnArticle($article) {
39                 global $wgReverseTitle, $wgCapitalizeTitle;
41                 if ($wgReverseTitle) {
42                         wfReverseTitle($article);
43                 }
45                 if ($wgCapitalizeTitle) {
46                         wfCapitalizeTitle($article);
47                 }
49                 # code to actually show the article goes here
50         }
52 An extension writer, or a local admin, will often add custom code to
53 the function -- with or without a global variable. For example,
54 someone wanting email notification when an article is shown may add:
56     function showAnArticle($article) {
57         global $wgReverseTitle, $wgCapitalizeTitle;
58         
59         if ($wgReverseTitle) {
60             wfReverseTitle($article);
61         }
62         
63         if ($wgCapitalizeTitle) {
64            wfCapitalizeTitle($article);
65         }
67         # code to actually show the article goes here
68         
69         if ($wgNotifyArticle) {
70            wfNotifyArticleShow($article));
71         }
72     }
74 Using a hook-running strategy, we can avoid having all this
75 option-specific stuff in our mainline code. Using hooks, the function
76 becomes:
78         function showAnArticle($article) {
80                 if (wfRunHooks('ArticleShow', array(&$article))) {
82                         # code to actually show the article goes here
84                         wfRunHooks('ArticleShowComplete', array(&$article));
85                 }
86         }
88 We've cleaned up the code here by removing clumps of weird,
89 infrequently used code and moving them off somewhere else. It's much
90 easier for someone working with this code to see what's _really_ going
91 on, and make changes or fix bugs.
93 In addition, we can take all the code that deals with the little-used
94 title-reversing options (say) and put it in one place. Instead of
95 having little title-reversing if-blocks spread all over the codebase
96 in showAnArticle, deleteAnArticle, exportArticle, etc., we can
97 concentrate it all in an extension file:
99         function reverseArticleTitle($article) {
100                 # ...
101         }
103         function reverseForExport($article) {
104                 # ...
105         }
107 The setup function for the extension just has to add its hook
108 functions to the appropriate events:
110         setupTitleReversingExtension() {
111                 global $wgHooks;
113                 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
114                 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
115                 $wgHooks['ArticleExport'][] = 'reverseForExport';
116         }
118 Having all this code related to the title-reversion option in one
119 place means that it's easier to read and understand; you don't have to
120 do a grep-find to see where the $wgReverseTitle variable is used, say.
122 If the code is well enough isolated, it can even be excluded when not
123 used -- making for some slight savings in memory and load-up
124 performance at runtime. Admins who want to have all the reversed
125 titles can add:
127         require_once('extensions/ReverseTitle.php');
129 ...to their LocalSettings.php file; those of us who don't want or need
130 it can just leave it out.
132 The extensions don't even have to be shipped with MediaWiki; they
133 could be provided by a third-party developer or written by the admin
134 him/herself.
136 ==Writing hooks==
138 A hook is a chunk of code run at some particular event. It consists of:
140   * a function with some optional accompanying data, or
141   * an object with a method and some optional accompanying data.
143 Hooks are registered by adding them to the global $wgHooks array for a
144 given event. All the following are valid ways to define hooks:
146         $wgHooks['EventName'][] = 'someFunction'; # function, no data
147         $wgHooks['EventName'][] = array('someFunction', $someData);
148         $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
150         $wgHooks['EventName'][] = $object; # object only
151         $wgHooks['EventName'][] = array($object, 'someMethod');
152         $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
153         $wgHooks['EventName'][] = array($object); # weird but OK
155 When an event occurs, the function (or object method) will be called
156 with the optional data provided as well as event-specific parameters.
157 The above examples would result in the following code being executed
158 when 'EventName' happened:
160         # function, no data
161         someFunction($param1, $param2)
162         # function with data
163         someFunction($someData, $param1, $param2)
165         # object only
166         $object->onEventName($param1, $param2)
167         # object with method
168         $object->someMethod($param1, $param2)
169         # object with method and data
170         $object->someMethod($someData, $param1, $param2)
171       
172 Note that when an object is the hook, and there's no specified method,
173 the default method called is 'onEventName'. For different events this
174 would be different: 'onArticleSave', 'onUserLogin', etc.
176 The extra data is useful if we want to use the same function or object
177 for different purposes. For example:
179         $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
180         $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
182 This code would result in ircNotify being run twice when an article is
183 saved: once for 'TimStarling', and once for 'brion'.
185 Hooks can return three possible values:
187   * true: the hook has operated successfully
188   * "some string": an error occurred; processing should
189           stop and the error should be shown to the user
190   * false: the hook has successfully done the work
191            necessary and the calling function should skip
192         
193 The last result would be for cases where the hook function replaces
194 the main functionality. For example, if you wanted to authenticate
195 users to a custom system (LDAP, another PHP program, whatever), you
196 could do:
198         $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
199   
200         function ldapLogin($username, $password) {
201                 # log user into LDAP
202                 return false;
203         }
205 Returning false makes less sense for events where the action is
206 complete, and will normally be ignored.
208 ==Using hooks==
210 A calling function or method uses the wfRunHooks() function to run
211 the hooks related to a particular event, like so:
213         class Article { 
214                 # ...
215                 function protect() {
216                         global $wgUser;
217                         if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
218                                 # protect the article
219                                 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
220                         }
221                 }
222         }
223                                                     
224 wfRunHooks() returns true if the calling function should continue
225 processing (the hooks ran OK, or there are no hooks to run), or false
226 if it shouldn't (an error occurred, or one of the hooks handled the
227 action already). Checking the return value matters more for "before"
228 hooks than for "complete" hooks.
230 Note that hook parameters are passed in an array; this is a necessary
231 inconvenience to make it possible to pass reference values (that can
232 be changed) into the hook code. Also note that earlier versions of
233 wfRunHooks took a variable number of arguments; the array() calling
234 protocol came about after MediaWiki 1.4rc1.
236 ==Events and parameters==
238 This is a list of known events and parameters; please add to it if
239 you're going to add events to the MediaWiki code.
241 'AbortLogin': Return false to cancel account login.
242 $user: the User object being authenticated against
243 $password: the password being submitted, not yet checked for validity
244 &$retval: a LoginForm class constant to return from authenticateUserData();
245           default is LoginForm::ABORTED. Note that the client may be using
246           a machine API rather than the HTML user interface.
248 'AbortNewAccount': Return false to cancel account creation.
249 $user: the User object about to be created (read-only, incomplete)
250 $message: out parameter: error message to display on abort
252 'AddNewAccount': after a user account is created
253 $user: the User object that was created. (Parameter added in 1.7)
255 'AjaxAddScript': Called in output page just before the initialisation
256 of the javascript ajax engine. The hook is only called when ajax
257 is enabled ( $wgUseAjax = true; ).
259 'AlternateEdit': before checking if an user can edit a page and
260 before showing the edit form ( EditPage::edit() ). This is triggered
261 on &action=edit.
262 $EditPage : the EditPage object
264 'ArticleDelete': before an article is deleted
265 $article: the article (object) being deleted
266 $user: the user (object) deleting the article
267 $reason: the reason (string) the article is being deleted
269 'ArticleDeleteComplete': after an article is deleted
270 $article: the article that was deleted
271 $user: the user that deleted the article
272 $reason: the reason the article was deleted
274 'ArticleInsertComplete': After an article is created
275 $article: Article created
276 $user: User creating the article
277 $text: New content
278 $summary: Edit summary/comment
279 $isMinor: Whether or not the edit was marked as minor
280 $isWatch: (No longer used)
281 $section: (No longer used)
282 $flags: Flags passed to Article::doEdit()
283 $revision: New Revision of the article
285 'ArticleProtect': before an article is protected
286 $article: the article being protected
287 $user: the user doing the protection
288 $protect: boolean whether this is a protect or an unprotect
289 $reason: Reason for protect
290 $moveonly: boolean whether this is for move only or not
292 'ArticleProtectComplete': after an article is protected
293 $article: the article that was protected
294 $user: the user who did the protection
295 $protect: boolean whether it was a protect or an unprotect
296 $reason: Reason for protect
297 $moveonly: boolean whether it was for move only or not
299 'ArticleRollbackComplete': after an article rollback is completed
300 $article: the article that was edited
301 $user: the user who did the rollback
302 $revision: the revision the page was reverted back to
304 'ArticleSave': before an article is saved
305 $article: the article (object) being saved
306 $user: the user (object) saving the article
307 $text: the new article text
308 $summary: the article summary (comment)
309 $isminor: minor flag
310 $iswatch: watch flag
311 $section: section #
313 'ArticleSaveComplete': After an article has been updated
314 $article: Article modified
315 $user: User performing the modification
316 $text: New content
317 $summary: Edit summary/comment
318 $isMinor: Whether or not the edit was marked as minor
319 $isWatch: (No longer used)
320 $section: (No longer used)
321 $flags: Flags passed to Article::doEdit()
322 $revision: New Revision of the article
324 'ArticleSaveComplete': after an article is saved
325 $article: the article (object) saved
326 $user: the user (object) who saved the article
327 $text: the new article text
328 $summary: the article summary (comment)
329 $isminor: minor flag
330 $iswatch: watch flag
331 $section: section #
333 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
335 'ArticleUndeleted': When one or more revisions of an article are restored
336 $title: Title corresponding to the article restored
337 $create: Whether or not the restoration caused the page to be created
338 (i.e. it didn't exist before)
340 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
341 &$article: the article
342 &$pcache: whether to try the parser cache or not
343 &$outputDone: whether the output for this page finished or not
345 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
346 &$article: the article
347 &$sectionanchor: The section anchor link (e.g. "#overview" )
348 &$extraq: Extra query parameters which can be added via hooked functions
350 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
351 Gives a chance for an extension to set it programattically to a variable class.
352 &$auth: the $wgAuth object, probably a stub
354 'AutoAuthenticate': called to authenticate users on external/environmental means
355 $user: writes user object to this parameter
357 'BadImage': When checking against the bad image list
358 $name: Image name being checked
359 &$bad: Whether or not the image is "bad"
361 Change $bad and return false to override. If an image is "bad", it is not
362 rendered inline in wiki pages or galleries in category pages.
364 'BeforeGalleryFindFile': before an image is fetched for a gallery
365 &$gallery,: the gallery object
366 &$nt: the image title 
367 &$time: image timestamp
369 'BeforePageDisplay': Prior to outputting a page
370 $out: OutputPage object
372 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
373 &$parser: Parser object
374 &$title: title of the template
375 &$skip: skip this template and link it?
376 &$id: the id of the revision being parsed
378 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
379 &$parser: Parser object
380 &$nt: the image title
381 &$skip: skip this image and link it?
382 &$time: the image timestamp
384 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
385 &$parser: Parser object
386 &$ig: ImageGallery object
388 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
389 $nondefaults: Assoc array with the following keys:
390               days, hideOwn, hideBots, hideMinor, namespace
391 $wgUser: wgUser.
392 &$hookSql: a string which will be inserted without sanitation into the SQL query
393            used to get the watchlist, at the end of the WHERE part.
395 'BlockIp': before an IP address or user is blocked
396 $block: the Block object about to be saved
397 $user: the user _doing_ the block (not the one being blocked)
399 'BlockIpComplete': after an IP address or user is blocked
400 $block: the Block object that was saved
401 $user: the user who did the block (not the one being blocked)
403 'BookInformation': Before information output on Special:Booksources
404 $isbn: ISBN to show information for
405 $output: OutputPage object in use
407 'CategoryPageView': before viewing a categorypage in CategoryPage::view
408 $catpage: CategoryPage instance
410 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
411 &$this:        ChangesList instance.
412 &$articlelink: HTML of link to article (already filled-in).
413 &$s:           HTML of row that is being constructed.
414 &$rc:          RecentChange instance.
415 $unpatrolled:  Whether or not we are showing unpatrolled changes.
416 $watched:      Whether or not the change is watched by the user.
418 'ContributionsToolLinks': Change tool links above Special:Contributions
419 $id: User identifier
420 $title: User page title
421 &$tools: Array of tool links
423 'CustomEditor': When invoking the page editor
424 $article: Article being edited
425 $user: User performing the edit
427 Return true to allow the normal editor to be used, or false
428 if implementing a custom editor, e.g. for a special namespace,
429 etc.
431 'DiffViewHeader': called before diff display
432 $diff: DifferenceEngine object that's calling
433 $oldRev: Revision object of the "old" revision (may be null/invalid)
434 $newRev: Revision object of the "new" revision
436 'EditPage::attemptSave': called before an article is
437 saved, that is before insertNewArticle() is called
438 &$editpage_Obj: the current EditPage object
440 'EditFormPreloadText': Allows population of the edit form when creating new pages
441 &$text: Text to preload with
442 &$title: Title object representing the page being created
444 'EditPage::showEditForm:fields': allows injection of form field into edit form
445 &$editor: the EditPage instance for reference
446 &$out: an OutputPage instance to write to
447 return value is ignored (should always return true)
449 'EditFilter': Perform checks on an edit
450 $editor: Edit form (see includes/EditPage.php)
451 $text: Contents of the edit box
452 $section: Section being edited
453 &$error: Error message to return
455 Return false to halt editing; you'll need to handle error messages, etc. yourself.
456 Alternatively, modifying $error and returning true will cause the contents of $error
457 to be echoed at the top of the edit form as wikitext. Return true without altering
458 $error to allow the edit to proceed.
460 'EditSectionLink': Override the return value of Linker::editSectionLink()
461 $skin: Skin rendering the UI
462 $title: Title being linked to
463 $section: Section to link to
464 $link: Default link
465 $result: Result (alter this to override the generated links)
467 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
468 $skin: Skin rendering the UI
469 $title: Title being linked to
470 $section: Section to link to
471 $hint: Anchor title/tooltip attributes
472 $link: Default link
473 $result: Result (alter this to override the generated links)
475 'EmailConfirmed': When checking that the user's email address is "confirmed"
476 $user: User being checked
477 $confirmed: Whether or not the email address is confirmed
478 This runs before the other checks, such as anonymity and the real check; return
479 true to allow those checks to occur, and false if checking is done.
481 'EmailUser': before sending email from one user to another
482 $to: address of receiving user
483 $from: address of sending user
484 $subject: subject of the mail
485 $text: text of the mail
487 'EmailUserComplete': after sending email from one user to another
488 $to: address of receiving user
489 $from: address of sending user
490 $subject: subject of the mail
491 $text: text of the mail
493 'FetchChangesList': When fetching the ChangesList derivative for a particular user
494 &$user: User the list is being fetched for
495 &$skin: Skin object to be used with the list
496 &$list: List object (defaults to NULL, change it to an object instance and return
497 false override the list derivative used)
499 'FileUpload': When a file upload occurs
500 $file : Image object representing the file that was uploaded
502 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
503 $title: Title object of page
504 $url: string value as output (out parameter, can modify)
505 $query: query options passed to Title::getInternalURL()
507 'GetLocalURL': modify local URLs as output into page links
508 $title: Title object of page
509 $url: string value as output (out parameter, can modify)
510 $query: query options passed to Title::getLocalURL()
512 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
513 $title: Title object of page
514 $url: string value as output (out parameter, can modify)
515 $query: query options passed to Title::getFullURL()
517 'getUserPermissionsErrors': Add a permissions error when permissions errors are checked for.
518         Use instead of userCan for most cases. Return false if the user can't do it,
519         and populate $result with the reason in the form of array( messagename, param1, param2 )
520 $title: Title object being checked against
521 $user : Current user object
522 $action: Action being checked
523 $result: User permissions error to add. If none, return true.
525 'ImageOpenShowImageInlineBefore': Call potential extension just before showing the image on an image page
526 $imagePage: ImagePage object ($this)
527 $output: $wgOut
529 'InitPreferencesForm': called at the end of PreferencesForm's constructor
530 $form: the PreferencesForm
531 $request: the web request to initialized from
533 'InternalParseBeforeLinks': during Parser's internalParse method before links but
534 after noinclude/includeonly/onlyinclude and other processing.
535 &$this: Parser object
536 &$text: string containing partially parsed text
537 &$this->mStripState: Parser's internal StripState object
539 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
540 tance to return false if the domain name doesn't match your organization
541 $addr: The e-mail address entered by the user
542 &$result: Set this and return false to override the internal checks
544 'isValidPassword': Override the result of User::isValidPassword()
545 $password: The password entered by the user
546 &$result: Set this and return false to override the internal checks
547 $user: User the password is being validated for
549 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
550 &$linksUpdate: the LinkUpdate object
552 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
553                           No return data is accepted; this hook is for auditing only.
554 $user: the User object being authenticated against
555 $password: the password being submitted and found wanting
556 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
558 'LogLine': Processes a single log entry on Special:Log
559 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type 
560     database field.
561 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
562     to logging.log_action database field.
563 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
564 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
565     appears to contain anything.
566 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
567 &$revert: string that is displayed in the UI, similar to $comment.
569 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
570 &$type: array of strings
572 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
573 &$typeText: array of strings
575 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
576 &$headerText: array of strings
578 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
579 &$actionText: array of strings
581 'MarkPatrolled': before an edit is marked patrolled
582 $rcid: ID of the revision to be marked patrolled
583 $user: the user (object) marking the revision as patrolled
584 $wcOnlySysopsCanPatrol: config setting indicating whether the user
585  needs to be a sysop in order to mark an edit patrolled
587 'MarkPatrolledComplete': after an edit is marked patrolled
588 $rcid: ID of the revision marked as patrolled
589 $user: user (object) who marked the edit patrolled
590 $wcOnlySysopsCanPatrol: config setting indicating whether the user
591  must be a sysop to patrol the edit
593 'MathAfterTexvc': after texvc is executed when rendering mathematics
594 $mathRenderer: instance of MathRenderer
595 $errmsg: error message, in HTML (string). Nonempty indicates failure
596  of rendering the formula
598 'MediaWikiPerformAction': Override MediaWiki::performAction().
599        Use this to do something completely different, after the basic
600        globals have been set up, but before ordinary actions take place.
601 $output:  $wgOut
602 $article: $wgArticle
603 $title:   $wgTitle
604 $user:    $wgUser
605 $request: $wgRequest
607 'OutputPageBeforeHTML': a page has been processed by the parser and
608 the resulting HTML is about to be displayed.  
609 $parserOutput: the parserOutput (object) that corresponds to the page 
610 $text: the text that will be displayed, in HTML (string)
612 'PageHistoryBeforeList': When a history page list is about to be constructed.
613 $article: the article that the history is loading for
615 'PageHistoryLineEnding' : right before the end <li> is added to a history line
616 $row: the revision row for this line
617 $s: the string representing this parsed line
619 'PageRenderingHash': alter the parser cache option hash key
620   A parser extension which depends on user options should install
621   this hook and append its values to the key.
622 $hash: reference to a hash key string which can be modified
624 'ParserTestTables': alter the list of tables to duplicate when parser tests
625 are run. Use when page save hooks require the presence of custom tables
626 to ensure that tests continue to run properly.
627 &$tables: array of table names
629 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
630 my talk page, my contributions" etc).
632 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
633 &$title: Title object representing the current page
635 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
636 &$user : User performing the action
637 $action : Action being performed
638 &$result : Whether or not the action should be prevented
639 Change $result and return false to give a definitive answer, otherwise
640 the built-in rate limiting checks are used, if enabled.
642 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
643 $form : PreferencesForm object
644 &$html : HTML to append to
646 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
647 &$obj: RawPage object
648 &$text: The text that's going to be the output
650 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
651 $form: the PreferencesForm
652 $out: output page to render to, probably $wgOut
654 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
655 $form: the PreferencesForm
656 $user: the User object to load preferences from
658 'SavePreferences': called at the end of PreferencesForm::savePreferences; 
659                    returning false prevents the preferences from being saved.
660 $form: the PreferencesForm
661 $user: the User object to save preferences to
662 $message: change this to set an error message (ignored if the hook does notreturn fals)
664 'SearchUpdate': Prior to search update completion
665 $id : Page id
666 $namespace : Page namespace
667 $title : Page title
668 $text : Current text being indexed
670 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
671 $text: Text being shown
672 $title: Title of the custom script/stylesheet page
673 $output: Current OutputPage object
675 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
676 &$siteNotice: HTML returned as the sitenotice
677 Return true to allow the normal method of notice selection/rendering to work,
678 or change the value of $siteNotice and return false to alter it.
680 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
681 &$siteNotice: HTML sitenotice
682 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
684 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
685 $skin: Skin object
686 &$text: bottomScripts Text
687 Append to $text to add additional text/scripts after the stock bottom scripts.
689 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
690 &$content_actions: Content actions
691 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
692 for an example]
694 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
695 &$sktemplate: SkinTemplate object
696 &$tpl: Template engine object
698 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
699        You can either create your own array, or alter the parameters for the normal one.
700 &$this:     The SkinTemplate instance.
701 $title:     Title instance for the page.
702 $message:   Visible label of tab.
703 $selected:  Whether this is a selected tab.
704 $checkEdit: Whether or not the action=edit query should be added if appropriate.
705 &$classes:  Array of CSS classes to apply.
706 &$query:    Query string to add to link.
707 &$text:     Link text.
708 &$result:   Complete assoc. array if you want to return true.
710 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
711 $id: User identifier
713 'TitleMoveComplete': after moving an article (title)
714 $old: old title
715 $nt: new title
716 $user: user who did the move
717 $pageid: database ID of the page that's been moved
718 $redirid: database ID of the created redirect
720 'UnknownAction': An unknown "action" has occured (useful for defining
721                  your own actions)
722 $action: action name
723 $article: article "acted on"
725 'UnwatchArticle': before a watch is removed from an article
726 $user: user watching
727 $article: article object to be removed
729 'UnwatchArticle': after a watch is removed from an article
730 $user: user that was watching
731 $article: article object removed
733 'UnwatchArticleComplete': after a watch is removed from an article
734 $user: user that watched
735 $article: article object that was watched
737 'UploadForm:initial': before the upload form is generated
738 $form: UploadForm object
739 You might set the member-variables $uploadFormTextTop and 
740 $uploadFormTextAfterSummary to inject text (HTML) either before
741 or after the editform.
743 'UploadForm:BeforeProcessing': at the beginning of processUpload()
744 $form: UploadForm object
745 Lets you poke at member variables like $mUploadDescription before the
746 file is saved.
748 'UploadVerification': additional chances to reject an uploaded file
749 string $saveName: destination file name
750 string $tempName: filesystem path to the temporary file for checks
751 string &$error: output: HTML error to show if upload canceled by returning false
753 'UploadComplete': Upon completion of a file upload
754 $image: Image object representing the file that was uploaded
756 'UserCan': To interrupt/advise the "user can do X to Y article" check.
757         If you want to display an error message, try getUserPermissionsErrors.
758 $title: Title object being checked against
759 $user : Current user object
760 $action: Action being checked
761 $result: Pointer to result returned if hook returns false. If null is returned,
762  UserCan checks are continued by internal code.
764 'UserCreateForm': change to manipulate the login form
765 $template: SimpleTemplate instance for the form
767 'UserLoginComplete': after a user has logged in
768 $user: the user object that was created on login
769                     
770 'UserLoginForm': change to manipulate the login form
771 $template: SimpleTemplate instance for the form
773 'UserLogout': before a user logs out
774 $user: the user object that is about to be logged out
775        
776 'UserLogoutComplete': after a user has logged out
777 $user: the user object _after_ logout (won't have name, ID, etc.)
779 'UserRights': After a user's group memberships are changed
780 $user  : User object that was changed
781 $add   : Array of strings corresponding to groups added
782 $remove: Array of strings corresponding to groups removed
783                       
784 'UserGetImplicitGroups': Called in User::getImplicitGroups()
785 &$groups: List of implicit (automatically-assigned) groups
787 'UserGetRights': Called in User::getRights()
788 $user: User to get rights for
789 &$rights: Current rights
791 'UserEffectiveGroups': Called in User::getEffectiveGroups()
792 $user: User to get groups for
793 &$groups: Current effective groups
795 'WatchArticle': before a watch is added to an article
796 $user: user that will watch
797 $article: article object to be watched
799 'WatchArticleComplete': after a watch is added to an article
800 $user: user that watched
801 $article: article object watched
804 More hooks might be available but undocumented, you can execute
805 ./maintenance/findhooks.php to find hidden one.