Localisation updates German
[mediawiki.git] / docs / hooks.txt
blob64d6756f4b9a835b5bb6b417e9aca587233b490c
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 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
245 'AbortLogin': Return false to cancel account login.
246 $user: the User object being authenticated against
247 $password: the password being submitted, not yet checked for validity
248 &$retval: a LoginForm class constant to return from authenticateUserData();
249           default is LoginForm::ABORTED. Note that the client may be using
250           a machine API rather than the HTML user interface.
252 'AbortMove': allows to abort moving an article (title)
253 $old: old title
254 $nt: new title
255 $user: user who is doing the move
256 $err: error message
258 'AbortNewAccount': Return false to cancel account creation.
259 $user: the User object about to be created (read-only, incomplete)
260 $message: out parameter: error message to display on abort
262 'AddNewAccount': after a user account is created
263 $user: the User object that was created. (Parameter added in 1.7)
264 $byEmail: true when account was created "by email" (added in 1.12)
266 'AjaxAddScript': Called in output page just before the initialisation
267 of the javascript ajax engine. The hook is only called when ajax
268 is enabled ( $wgUseAjax = true; ).
270 'AlternateEdit': before checking if an user can edit a page and
271 before showing the edit form ( EditPage::edit() ). This is triggered
272 on &action=edit.
273 $EditPage : the EditPage object
275 'APIEditBeforeSave': before saving a page with api.php?action=edit,
276 after processing request parameters. Return false to let the request
277 fail, returning an error message or an <edit result="Failure"> tag
278 if $resultArr was filled.
279 $EditPage : the EditPage object
280 $text : the new text of the article (has yet to be saved)
281 $resultArr : data in this array will be added to the API result
283 'ArticleAfterFetchContent': after fetching content of an article from the database
284 $article: the article (object) being loaded from the database
285 $content: the content (string) of the article
287 'ArticleDelete': before an article is deleted
288 $article: the article (object) being deleted
289 $user: the user (object) deleting the article
290 $reason: the reason (string) the article is being deleted
292 'ArticleDeleteComplete': after an article is deleted
293 $article: the article that was deleted
294 $user: the user that deleted the article
295 $reason: the reason the article was deleted
296 $id: id of the article that was deleted
298 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
299 $article: article (object) of the user talk page
301 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
302 $article: article (object) being modified
304 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
305 $title: title (object) used to create the article object
306 $article: article (object) that will be returned
308 'ArticleInsertComplete': After an article is created
309 $article: Article created
310 $user: User creating the article
311 $text: New content
312 $summary: Edit summary/comment
313 $isMinor: Whether or not the edit was marked as minor
314 $isWatch: (No longer used)
315 $section: (No longer used)
316 $flags: Flags passed to Article::doEdit()
317 $revision: New Revision of the article
319 'ArticleMergeComplete': after merging to article using Special:Mergehistory
320 $targetTitle: target title (object)
321 $destTitle: destination title (object) 
323 'ArticlePageDataAfter': after loading data of an article from the database
324 $article: article (object) whose data were loaded
325 $row: row (object) returned from the database server
327 'ArticlePageDataBefore': before loading data of an article from the database
328 $article: article (object) that data will be loaded
329 $fields: fileds (array) to load from the database
331 'ArticleProtect': before an article is protected
332 $article: the article being protected
333 $user: the user doing the protection
334 $protect: boolean whether this is a protect or an unprotect
335 $reason: Reason for protect
336 $moveonly: boolean whether this is for move only or not
338 'ArticleProtectComplete': after an article is protected
339 $article: the article that was protected
340 $user: the user who did the protection
341 $protect: boolean whether it was a protect or an unprotect
342 $reason: Reason for protect
343 $moveonly: boolean whether it was for move only or not
345 'ArticlePurge': before executing "&action=purge" 
346 $article: article (object) to purge
348 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
349 revision of an article
350 &$title: title object of the article
352 'ArticleRevisionUndeleted': after an article revision is restored
353 $title: the article title
354 $revision: the revision
355 $oldPageID: the page ID of the revision when archived (may be null)
357 'ArticleRollbackComplete': after an article rollback is completed
358 $article: the article that was edited
359 $user: the user who did the rollback
360 $revision: the revision the page was reverted back to
362 'ArticleSave': before an article is saved
363 $article: the article (object) being saved
364 $user: the user (object) saving the article
365 $text: the new article text
366 $summary: the article summary (comment)
367 $isminor: minor flag
368 $iswatch: watch flag
369 $section: section #
371 'ArticleSaveComplete': After an article has been updated
372 $article: Article modified
373 $user: User performing the modification
374 $text: New content
375 $summary: Edit summary/comment
376 $isMinor: Whether or not the edit was marked as minor
377 $isWatch: (No longer used)
378 $section: (No longer used)
379 $flags: Flags passed to Article::doEdit()
380 $revision: New Revision of the article
382 'ArticleSaveComplete': after an article is saved
383 $article: the article (object) saved
384 $user: the user (object) who saved the article
385 $text: the new article text
386 $summary: the article summary (comment)
387 $isminor: minor flag
388 $iswatch: watch flag
389 $section: section #
391 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
393 'ArticleUndelete': When one or more revisions of an article are restored
394 $title: Title corresponding to the article restored
395 $create: Whether or not the restoration caused the page to be created
396 (i.e. it didn't exist before)
398 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
399 &$article: the article
400 &$sectionanchor: The section anchor link (e.g. "#overview" )
401 &$extraq: Extra query parameters which can be added via hooked functions
403 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
404 &$article: the article
405 &$pcache: whether to try the parser cache or not
406 &$outputDone: whether the output for this page finished or not
408 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
409 $article: target article (object)
411 'AuthPluginAutoCreate': Called when creating a local account for an user logged
412 in from an external authentication method
413 $user: User object created locally
415 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
416 Gives a chance for an extension to set it programattically to a variable class.
417 &$auth: the $wgAuth object, probably a stub
419 'AutopromoteCondition': check autopromote condition for user.
420 $type: condition type
421 $args: arguments
422 $user: user
423 $result: result of checking autopromote condition
425 'BadImage': When checking against the bad image list
426 $name: Image name being checked
427 &$bad: Whether or not the image is "bad"
429 Change $bad and return false to override. If an image is "bad", it is not
430 rendered inline in wiki pages or galleries in category pages.
432 'BeforeGalleryFindFile': before an image is fetched for a gallery
433 &$gallery,: the gallery object
434 &$nt: the image title 
435 &$time: image timestamp
437 'BeforePageDisplay': Prior to outputting a page
438 &$out: OutputPage object
439 &$skin: Skin object
441 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
442 &$parser: Parser object
443 &$title: title of the template
444 &$skip: skip this template and link it?
445 &$id: the id of the revision being parsed
447 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
448 &$parser: Parser object
449 &$nt: the image title
450 &$skip: skip this image and link it?
451 &$time: the image timestamp
453 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
454 &$parser: Parser object
455 &$ig: ImageGallery object
457 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
458 $nondefaults: Assoc array with the following keys:
459               days, hideOwn, hideBots, hideMinor, namespace
460 $wgUser: wgUser.
461 &$hookSql: a string which will be inserted without sanitation into the SQL query
462            used to get the watchlist, at the end of the WHERE part.
464 'BlockIp': before an IP address or user is blocked
465 $block: the Block object about to be saved
466 $user: the user _doing_ the block (not the one being blocked)
468 'BlockIpComplete': after an IP address or user is blocked
469 $block: the Block object that was saved
470 $user: the user who did the block (not the one being blocked)
472 'BookInformation': Before information output on Special:Booksources
473 $isbn: ISBN to show information for
474 $output: OutputPage object in use
476 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
477 &$linker: Linker instance
478 $nt: the page title
479 $query: the URL query string passed in
480 &$u: the URL of this link
481 &$style: the inline CSS style
482 &$prefix: a prefix prepended to the linked text
483 &$text: the text placed by the user in the wiki-link
484 &$inside: any additional alphanumeric characters placed after the wiki-link,
485 that are made part of the link text
486 &$trail: text placed immediately after the HTML link
488 'CategoryPageView': before viewing a categorypage in CategoryPage::view
489 $catpage: CategoryPage instance
491 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
492 &$this:        ChangesList instance.
493 &$articlelink: HTML of link to article (already filled-in).
494 &$s:           HTML of row that is being constructed.
495 &$rc:          RecentChange instance.
496 $unpatrolled:  Whether or not we are showing unpatrolled changes.
497 $watched:      Whether or not the change is watched by the user.
499 'ContributionsToolLinks': Change tool links above Special:Contributions
500 $id: User identifier
501 $title: User page title
502 &$tools: Array of tool links
504 'CustomEditor': When invoking the page editor
505 $article: Article being edited
506 $user: User performing the edit
508 Return true to allow the normal editor to be used, or false
509 if implementing a custom editor, e.g. for a special namespace,
510 etc.
512 'DiffViewHeader': called before diff display
513 $diff: DifferenceEngine object that's calling
514 $oldRev: Revision object of the "old" revision (may be null/invalid)
515 $newRev: Revision object of the "new" revision
517 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
518 $article: article (object) being viewed
519 $oldid: oldid (int) being viewed
521 'EditFilter': Perform checks on an edit
522 $editor: Edit form (see includes/EditPage.php)
523 $text: Contents of the edit box
524 $section: Section being edited
525 &$error: Error message to return
527 'EditFilterMerged': Post-section-merge edit filter
528 $editor: EditPage instance (object)
529 $text: content of the edit box
530 $error: error message to return
532 'EditFormPreloadText': Allows population of the edit form when creating new pages
533 &$text: Text to preload with
534 &$title: Title object representing the page being created
536 'EditPage::AfterEdit:Form': After the edit textbox has been displayed
537 &$this: EditPage instance (object)
539 'EditPage::attemptSave': called before an article is
540 saved, that is before insertNewArticle() is called
541 &$editpage_Obj: the current EditPage object
543 'EditPage:BeforeDisplayingTextbox': Before the edit textbox is displayed
544 &$this: EditPage instance (object)
545 &$hidden: extra parameters of the textarea element, by default it is style="display: none;"
547 'EditPage::showEditForm:fields': allows injection of form field into edit form
548 &$editor: the EditPage instance for reference
549 &$out: an OutputPage instance to write to
550 return value is ignored (should always return true)
552 'EditPage::showEditForm:initial': before showing the edit form
553 $editor: EditPage instance (object)
555 Return false to halt editing; you'll need to handle error messages, etc. yourself.
556 Alternatively, modifying $error and returning true will cause the contents of $error
557 to be echoed at the top of the edit form as wikitext. Return true without altering
558 $error to allow the edit to proceed.
560 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
561 when there's an edit conflict.  Return false to halt normal diff output; in
562 this case you're responsible for computing and outputting the entire "conflict"
563 part, i.e., the "difference between revisions" and "your text" headers and
564 sections.
565 &$editor: EditPage instance
566 &$out: OutputPage instance
568 'EditPageBeforeEditButtons':  allows modifying the edit buttons below the textarea in the edit form
569 &$editpage: The current EditPage object
570 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
572 'EditSectionLink': Override the return value of Linker::editSectionLink()
573 $skin: Skin rendering the UI
574 $title: Title being linked to
575 $section: Section to link to
576 $link: Default link
577 $result: Result (alter this to override the generated links)
579 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
580 $skin: Skin rendering the UI
581 $title: Title being linked to
582 $section: Section to link to
583 $hint: Anchor title/tooltip attributes
584 $link: Default link
585 $result: Result (alter this to override the generated links)
587 'EmailConfirmed': When checking that the user's email address is "confirmed"
588 $user: User being checked
589 $confirmed: Whether or not the email address is confirmed
590 This runs before the other checks, such as anonymity and the real check; return
591 true to allow those checks to occur, and false if checking is done.
593 'EmailUser': before sending email from one user to another
594 $to: address of receiving user
595 $from: address of sending user
596 $subject: subject of the mail
597 $text: text of the mail
599 'EmailUserComplete': after sending email from one user to another
600 $to: address of receiving user
601 $from: address of sending user
602 $subject: subject of the mail
603 $text: text of the mail
605 'FetchChangesList': When fetching the ChangesList derivative for a particular user
606 &$user: User the list is being fetched for
607 &$skin: Skin object to be used with the list
608 &$list: List object (defaults to NULL, change it to an object instance and return
609 false override the list derivative used)
611 'FileDeleteComplete': When a file is deleted
612 $file: reference to the deleted file
613 $oldimage: in case of the deletion of an old image, the name of the old file
614 $article: in case all revisions of the file are deleted a reference to the article 
615           associated with the file.
616 $user: user who performed the deletion
617 $reason: reason
619 'FileUpload': When a file upload occurs
620 $file : Image object representing the file that was uploaded
622 'FileUndeleteComplete': When a file is undeleted
623 $title: title object to the file
624 $fileVersions: array of undeleted versions. Empty if all versions were restored
625 $user: user who performed the undeletion
626 $reason: reason
628 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
629 &$user: user to promote.
630 &$promote: groups that will be added.
632 'GetBlockedStatus': after loading blocking status of an user from the database
633 $user: user (object) being checked
635 'GetCacheVaryCookies': get cookies that should vary cache options
636 $out: OutputPage object
637 &$cookies: array of cookies name, add a value to it if you want to add a cookie
638         that have to vary cache options
640 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
641 $title: Title object of page
642 $url: string value as output (out parameter, can modify)
643 $query: query options passed to Title::getFullURL()
645 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
646 $title: Title object of page
647 $url: string value as output (out parameter, can modify)
648 $query: query options passed to Title::getInternalURL()
650 'GetLinkColours': modify the CSS class of an array of page links
651 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
652 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
654 'GetLocalURL': modify local URLs as output into page links
655 $title: Title object of page
656 $url: string value as output (out parameter, can modify)
657 $query: query options passed to Title::getLocalURL()
659 'getUserPermissionsErrors': Add a permissions error when permissions errors are
660         checked for.  Use instead of userCan for most cases. Return false if the
661         user can't do it, and populate $result with the reason in the form of
662         array( messagename, param1, param2, ... ).  For consistency, error messages
663         should be plain text with no special coloring, bolding, etc. to show that
664         they're errors; presenting them properly to the user as errors is done by
665         the caller.
666 $title: Title object being checked against
667 $user : Current user object
668 $action: Action being checked
669 $result: User permissions error to add. If none, return true.
671 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
672         if expensive checks are enabled.
674 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
675         image insertion.  You can skip the default logic entirely by returning
676         false, or just modify a few things using call-by-reference.
677 &$this: Skin object
678 &$title: Title object of the image
679 &$file: File object, or false if it doesn't exist
680 &$frameParams: Various parameters with special meanings; see documentation in
681         includes/Linker.php for Linker::makeImageLink2
682 &$handlerParams: Various parameters with special meanings; see documentation in
683         includes/Linker.php for Linker::makeImageLink2
684 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
685 &$res: Final HTML output, used if you return false
688 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
689         the image on an image page
690 $imagePage: ImagePage object ($this)
691 $output: $wgOut
693 'ImagePageFileHistoryLine': called when a file history line is contructed
694 $file: the file
695 $line: the HTML of the history line
696 $css: the line CSS class
698 'ImagePageFindFile': called when fetching the file associated with an image page
699 $page: ImagePage object
700 &$file: File object
701 &$displayFile: displayed File object
703 'InitPreferencesForm': called at the end of PreferencesForm's constructor
704 $form: the PreferencesForm
705 $request: the web request to initialized from
707 'InternalParseBeforeLinks': during Parser's internalParse method before links but
708 after noinclude/includeonly/onlyinclude and other processing.
709 &$this: Parser object
710 &$text: string containing partially parsed text
711 &$this->mStripState: Parser's internal StripState object
713 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
714 $article: article (object) being checked
716 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
717 $ip: IP being check
718 $result: Change this value to override the result of wfIsTrustedProxy()
720 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
721 tance to return false if the domain name doesn't match your organization
722 $addr: The e-mail address entered by the user
723 &$result: Set this and return false to override the internal checks
725 'isValidPassword': Override the result of User::isValidPassword()
726 $password: The password entered by the user
727 &$result: Set this and return false to override the internal checks
728 $user: User the password is being validated for
730 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
731 $magicExtensions: associative array of magic words synonyms
732 $lang: laguage code (string)
734 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
735 $specialPageAliases: associative array of magic words synonyms
736 $lang: laguage code (string)
738 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
739 &$url: the link url
740 &$text: the link text
741 &$link: the new link HTML (if returning false)
743 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
744 &$linksUpdate: the LinkUpdate object
746 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
747 &$linksUpdate: the LinkUpdate object
749 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
750 &$linksUpdate: the LinkUpdate object
752 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
754 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
756 'LocalFile::getHistory': called before file history query performed
757 $file: the file
758 $tables: tables
759 $fields: select fields
760 $conds: conditions
761 $opts: query options
762 $join_conds: JOIN conditions
764 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
765                           No return data is accepted; this hook is for auditing only.
766 $user: the User object being authenticated against
767 $password: the password being submitted and found wanting
768 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
770 'LogLine': Processes a single log entry on Special:Log
771 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type 
772     database field.
773 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
774     to logging.log_action database field.
775 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
776 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
777     appears to contain anything.
778 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
779 &$revert: string that is displayed in the UI, similar to $comment.
780 $time: timestamp of the log entry (added in 1.12) 
782 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
783 &$type: array of strings
785 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
786 &$typeText: array of strings
788 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
789 &$headerText: array of strings
791 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
792 &$actionText: array of strings
794 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
795 $magicWords: array of strings
797 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
798 $variableIDs: array of strings
800 'MarkPatrolled': before an edit is marked patrolled
801 $rcid: ID of the revision to be marked patrolled
802 $user: the user (object) marking the revision as patrolled
803 $wcOnlySysopsCanPatrol: config setting indicating whether the user
804  needs to be a sysop in order to mark an edit patrolled
806 'MarkPatrolledComplete': after an edit is marked patrolled
807 $rcid: ID of the revision marked as patrolled
808 $user: user (object) who marked the edit patrolled
809 $wcOnlySysopsCanPatrol: config setting indicating whether the user
810  must be a sysop to patrol the edit
812 'MathAfterTexvc': after texvc is executed when rendering mathematics
813 $mathRenderer: instance of MathRenderer
814 $errmsg: error message, in HTML (string). Nonempty indicates failure
815  of rendering the formula
817 'MediaWikiPerformAction': Override MediaWiki::performAction().
818 Use this to do something completely different, after the basic
819 globals have been set up, but before ordinary actions take place.
820 $output:  $wgOut
821 $article: $wgArticle
822 $title:   $wgTitle
823 $user:    $wgUser
824 $request: $wgRequest
826 'MessagesPreLoad': When loading a message from the database
827 $title: title of the message (string)
828 $message: value (string), change it to the message you want to define
830 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
831 Note: this is only run for the Monobook skin.  To add items to the toolbox
832 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
833 instead.
834 $tools: array of tools
836 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
837 $article: the article edited
838 $rev: the new revision
839 $baseID: the revision ID this was based off, if any
841 'OutputPageBeforeHTML': a page has been processed by the parser and
842 the resulting HTML is about to be displayed.  
843 $parserOutput: the parserOutput (object) that corresponds to the page 
844 $text: the text that will be displayed, in HTML (string)
846 'OutputPageParserOutput': after adding a parserOutput to $wgOut
847 $out: OutputPage instance (object)
848 $parserOutput: parserOutput instance being added in $out
850 'PageHistoryBeforeList': When a history page list is about to be constructed.
851 $article: the article that the history is loading for
853 'PageHistoryLineEnding' : right before the end <li> is added to a history line
854 $row: the revision row for this line
855 $s: the string representing this parsed line
857 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed
858 $pager: the pager
859 $queryInfo: the query parameters
861 'PageRenderingHash': alter the parser cache option hash key
862   A parser extension which depends on user options should install
863   this hook and append its values to the key.
864 $hash: reference to a hash key string which can be modified
866 'ParserAfterStrip': Same as ParserBeforeStrip
868 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
869 $parser: Parser object being used 
870 $text: text that'll be returned
872 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
873 $parser: Parser object
874 $text: text to parse
875 $stripState: StripState instance being used
877 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
878 $parser: parser object
879 $text: text being parsed
880 $stripState: stripState used (object)
882 'ParserBeforeTidy': called before tidy and custom tags replacements
883 $parser: Parser object being used 
884 $text: actual text
886 'ParserClearState': called at the end of Parser::clearState()
887 $parser: Parser object being cleared
889 'ParserFirstCallInit': called when the parser initialises for the first time
890 &$parser: Parser object being cleared
892 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
893 $parser: Parser object
894 $varCache: array to store the value in case of multiples calls of the same magic word
895 $index: index (string) of the magic
896 $ret: value of the magic word (the hook should set it)
898 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
899 $parser: Parser object
900 $time: actual time (timestamp)
902 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
903 $parser: Parser object
904 $varCache: varaiable cache (array)
906 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
907 $parser: Parser object
908 $limitReport: text that will be included (without comment tags)
910 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
911 $title: title object representing the file
912 $file: file object that will be used to create the image
913 &$params: 2-D array of parameters
915 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
916 $parser: Parser object created
918 'ParserTestTables': alter the list of tables to duplicate when parser tests
919 are run. Use when page save hooks require the presence of custom tables
920 to ensure that tests continue to run properly.
921 &$tables: array of table names
923 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
924 my talk page, my contributions" etc).
926 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
927 &$title: Title object representing the current page
929 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
930 &$user : User performing the action
931 $action : Action being performed
932 &$result : Whether or not the action should be prevented
933 Change $result and return false to give a definitive answer, otherwise
934 the built-in rate limiting checks are used, if enabled.
936 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
937 $form : PreferencesForm object
938 &$html : HTML to append to
940 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
941 AJAX search suggestions. Put results into &$results outparam and return false.
942 $ns : array of int namespace keys to search in
943 $search : search term (not guaranteed to be conveniently normalized)
944 $limit : maximum number of results to return
945 &$results : out param: array of page names (strings)
947 'PrefsEmailAudit': called when user changes his email address
948 $user: User (object) changing his email address
949 $oldaddr: old email address (string)
950 $newaddr: new email address (string)
952 'PrefsPasswordAudit': called when user changes his password
953 $user: User (object) changing his passoword
954 $newPass: new password
955 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
957 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
958 &$obj: RawPage object
959 &$text: The text that's going to be the output
961 'RecentChange_save': called at the end of RecenChange::save()
962 $recentChange: RecentChange object
964 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
965 $form: the PreferencesForm
966 $out: output page to render to, probably $wgOut
968 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
969 $form: the PreferencesForm
970 $user: the User object to load preferences from
972 'RevisionInsertComplete': called after a revision is inserted into the DB
973 $revision: the Revision
975 'SavePreferences': called at the end of PreferencesForm::savePreferences; 
976                    returning false prevents the preferences from being saved.
977 $form: the PreferencesForm
978 $user: the User object to save preferences to
979 $message: change this to set an error message (ignored if the hook does not return false)
980 $old: old preferences of the user
982 'SearchUpdate': Prior to search update completion
983 $id : Page id
984 $namespace : Page namespace
985 $title : Page title
986 $text : Current text being indexed
988 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
989 $term : Search term string
990 &$title : Outparam; set to $title object and return false for a match
992 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
993 $text: Text being shown
994 $title: Title of the custom script/stylesheet page
995 $output: Current OutputPage object
997 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
998 &$siteNotice: HTML returned as the sitenotice
999 Return true to allow the normal method of notice selection/rendering to work,
1000 or change the value of $siteNotice and return false to alter it.
1002 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1003 &$siteNotice: HTML sitenotice
1004 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1006 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1007 $skin: Skin object
1008 &$text: bottomScripts Text
1009 Append to $text to add additional text/scripts after the stock bottom scripts.
1011 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1012 $skin: Skin object
1013 &$subpages: Subpage links HTML
1014 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
1015 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
1017 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab  when showing a special page
1018 $sktemplate: SkinTemplate object
1019 $content_actions: array of tabs
1021 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
1022 $sktemplate: SkinTemplate object
1023 $nav_urls: array of tabs
1025 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1026 &$content_actions: Content actions
1027 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1028 for an example]
1030 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
1031 &$sktemplate: SkinTemplate object
1032 &$tpl: Template engine object
1034 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1035 $sktemplate: SkinTemplate object
1036 $res: set to true to prevent active tabs
1038 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1039 $out: Css to return
1041 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1042        You can either create your own array, or alter the parameters for the normal one.
1043 &$this:     The SkinTemplate instance.
1044 $title:     Title instance for the page.
1045 $message:   Visible label of tab.
1046 $selected:  Whether this is a selected tab.
1047 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1048 &$classes:  Array of CSS classes to apply.
1049 &$query:    Query string to add to link.
1050 &$text:     Link text.
1051 &$result:   Complete assoc. array if you want to return true.
1053 'SkinTemplateTabs': called when finished to build the actions tabs
1054 $sktemplate: SkinTemplate object
1055 $content_actions: array of tabs
1057 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1058 $tools: array of tools
1060 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1061 $id: User identifier
1063 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1064 $pager: The UsersPager instance
1065 $query: The query array to be returned
1067 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1068 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1069 $row: Database row object
1071 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1072 $pager: The UsersPager instance
1073 $out: The header HTML
1075 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1076 $pager: The UsersPager instance
1077 $out: The header HTML
1079 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1080 $pager: The UsersPager instance
1081 $query: The query array to be returned
1083 'SpecialMovepageAfterMove': called after moving a page
1084 $movePage: MovePageForm object
1085 $oldTitle: old title (object)
1086 $newTitle: new title (object)
1088 'SpecialPageExecuteAfterPage': called after executing a special page
1089 Warning: Not all the special pages call this hook
1090 $specialPage: SpecialPage object
1091 $par: paramter passed to the special page (string)
1092 $funct: function called to execute the special page
1094 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1095 Warning: Not all the special pages call this hook
1096 $specialPage: SpecialPage object
1097 $par: paramter passed to the special page (string)
1098 $funct: function called to execute the special page
1100 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1101 Warning: Not all the special pages call this hook
1102 $specialPage: SpecialPage object
1103 $par: paramter passed to the special page (string)
1104 $funct: function called to execute the special page
1106 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1107 $list: list (array) of core special pages
1109 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1110 $title: title object generated from the text entred by the user
1112 'SpecialSearchResults': called before search result display when there are matches
1113 $term: string of search term
1114 &$titleMatches: empty or SearchResultSet object
1115 &$textMatches: empty or SearchResultSet object
1117 'SpecialSearchNoResults': called before search result display when there are no matches
1118 $term: string of search term
1120 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1121 $extTypes: associative array of extensions types
1123 'TitleMoveComplete': after moving an article (title)
1124 $old: old title
1125 $nt: new title
1126 $user: user who did the move
1127 $pageid: database ID of the page that's been moved
1128 $redirid: database ID of the created redirect
1130 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1131 $title: title object related to the revision
1132 $rev: revision (object) that will be viewed
1134 'UnknownAction': An unknown "action" has occured (useful for defining
1135                  your own actions)
1136 $action: action name
1137 $article: article "acted on"
1139 'UnwatchArticle': before a watch is removed from an article
1140 $user: user watching
1141 $article: article object to be removed
1143 'UnwatchArticle': after a watch is removed from an article
1144 $user: user that was watching
1145 $article: article object removed
1147 'UnwatchArticleComplete': after a watch is removed from an article
1148 $user: user that watched
1149 $article: article object that was watched
1151 'UploadForm:initial': before the upload form is generated
1152 $form: UploadForm object
1153 You might set the member-variables $uploadFormTextTop and 
1154 $uploadFormTextAfterSummary to inject text (HTML) either before
1155 or after the editform.
1157 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1158 $form: UploadForm object
1159 Lets you poke at member variables like $mUploadDescription before the
1160 file is saved.
1162 'UploadVerification': additional chances to reject an uploaded file
1163 string $saveName: destination file name
1164 string $tempName: filesystem path to the temporary file for checks
1165 string &$error: output: HTML error to show if upload canceled by returning false
1167 'UploadComplete': Upon completion of a file upload
1168 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1170 'UserArrayFromResult': called when creating an UserArray object from a database result
1171 &$userArray: set this to an object to override the default object returned
1172 $res: database result used to create the object
1174 'userCan': To interrupt/advise the "user can do X to Y article" check.
1175         If you want to display an error message, try getUserPermissionsErrors.
1176 $title: Title object being checked against
1177 $user : Current user object
1178 $action: Action being checked
1179 $result: Pointer to result returned if hook returns false. If null is returned,
1180  userCan checks are continued by internal code.
1182 'UserCanSendEmail': To override User::canSendEmail() permission check
1183 $user: User (object) whose permission is being checked
1184 &$canSend: bool set on input, can override on output
1187 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1188 $user: User (object) that'll clear the message
1190 'UserCreateForm': change to manipulate the login form
1191 $template: SimpleTemplate instance for the form
1193 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1194 $user: User to get groups for
1195 &$groups: Current effective groups
1197 'UserGetAllRights': after calculating a list of all available rights
1198 &$rights: Array of rights, which may be added to.
1200 'UserGetEmail': called when getting an user email address
1201 $user: User object
1202 &$email: email, change this to override local email
1204 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1205 $user: User object
1206 &$timestamp: timestamp, change this to override local email authentification timestamp
1208 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1209 &$groups: List of implicit (automatically-assigned) groups
1211 'UserGetRights': Called in User::getRights()
1212 $user: User to get rights for
1213 &$rights: Current rights
1215 'UserLoadFromSession': called to authenticate users on external/environmental means
1216 $user: user object being loaded
1217 &$result: set this to a boolean value to abort the normal authentification process
1219 'UserLoginComplete': after a user has logged in
1220 $user: the user object that was created on login
1221 $inject_html: Any HTML to inject after the "logged in" message.
1222                     
1223 'UserLoginForm': change to manipulate the login form
1224 $template: SimpleTemplate instance for the form
1226 'UserLogout': before a user logs out
1227 $user: the user object that is about to be logged out
1228        
1229 'UserLogoutComplete': after a user has logged out
1230 $user: the user object _after_ logout (won't have name, ID, etc.)
1231 $inject_html: Any HTML to inject after the "logged out" message.
1232 $oldName: name of the user before logout (string)
1234 'UserRights': After a user's group memberships are changed
1235 $user  : User object that was changed
1236 $add   : Array of strings corresponding to groups added
1237 $remove: Array of strings corresponding to groups removed
1239 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1240 $user: user retrieving new talks messages
1241 $talks: array of new talks page(s)
1243 'UserSaveSettings': called when saving user settings
1244 $user: User object
1246 'UserSetEmail': called when changing user email address
1247 $user: User object
1248 &$email: new email, change this to override new email address
1250 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1251 $user: User object
1252 &$timestamp: new timestamp, change this to override local email authentification timestamp
1254 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1255 $toggles: array of toggles to add
1257 'WatchArticle': before a watch is added to an article
1258 $user: user that will watch
1259 $article: article object to be watched
1261 'WatchArticleComplete': after a watch is added to an article
1262 $user: user that watched
1263 $article: article object watched
1265 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1266 $query: $wgQueryPages itself
1268 More hooks might be available but undocumented, you can execute
1269 ./maintenance/findhooks.php to find hidden one.