seek() does nothing here
[mediawiki.git] / docs / hooks.txt
blob42ee77f83cc2f8c71a1659c0f02ee5449d1199ad
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 'AbortMove': allows to abort moving an article (title)
249 $old: old title
250 $nt: new title
251 $user: user who is doing the move
252 $err: error message
254 'AbortNewAccount': Return false to cancel account creation.
255 $user: the User object about to be created (read-only, incomplete)
256 $message: out parameter: error message to display on abort
258 'AddNewAccount': after a user account is created
259 $user: the User object that was created. (Parameter added in 1.7)
260 $byEmail: true when account was created "by email" (added in 1.12)
262 'AjaxAddScript': Called in output page just before the initialisation
263 of the javascript ajax engine. The hook is only called when ajax
264 is enabled ( $wgUseAjax = true; ).
266 'AlternateEdit': before checking if an user can edit a page and
267 before showing the edit form ( EditPage::edit() ). This is triggered
268 on &action=edit.
269 $EditPage : the EditPage object
271 'APIEditBeforeSave': before saving a page with api.php?action=edit,
272 after processing request parameters. Return false to let the request
273 fail, returning an error message or an <edit result="Failure"> tag
274 if $resultArr was filled.
275 $EditPage : the EditPage object
276 $text : the new text of the article (has yet to be saved)
277 $resultArr : data in this array will be added to the API result
279 'ArticleAfterFetchContent': after fetching content of an article from the database
280 $article: the article (object) being loaded from the database
281 $content: the content (string) of the article
283 'ArticleDelete': before an article is deleted
284 $article: the article (object) being deleted
285 $user: the user (object) deleting the article
286 $reason: the reason (string) the article is being deleted
288 'ArticleDeleteComplete': after an article is deleted
289 $article: the article that was deleted
290 $user: the user that deleted the article
291 $reason: the reason the article was deleted
293 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
294 $article: article (object) of the user talk page
296 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
297 $article: article (object) being modified
299 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
300 $title: title (object) used to create the article object
301 $article: article (object) that will be returned
303 'ArticleInsertComplete': After an article is created
304 $article: Article created
305 $user: User creating the article
306 $text: New content
307 $summary: Edit summary/comment
308 $isMinor: Whether or not the edit was marked as minor
309 $isWatch: (No longer used)
310 $section: (No longer used)
311 $flags: Flags passed to Article::doEdit()
312 $revision: New Revision of the article
314 'ArticleMergeComplete': after merging to article using Special:Mergehistory
315 $targetTitle: target title (object)
316 $destTitle: destination title (object) 
318 'ArticlePageDataAfter': after loading data of an article from the database
319 $article: article (object) whose data were loaded
320 $row: row (object) returned from the database server
322 'ArticlePageDataBefore': before loading data of an article from the database
323 $article: article (object) that data will be loaded
324 $fields: fileds (array) to load from the database
326 'ArticleProtect': before an article is protected
327 $article: the article being protected
328 $user: the user doing the protection
329 $protect: boolean whether this is a protect or an unprotect
330 $reason: Reason for protect
331 $moveonly: boolean whether this is for move only or not
333 'ArticleProtectComplete': after an article is protected
334 $article: the article that was protected
335 $user: the user who did the protection
336 $protect: boolean whether it was a protect or an unprotect
337 $reason: Reason for protect
338 $moveonly: boolean whether it was for move only or not
340 'ArticlePurge': before executing "&action=purge" 
341 $article: article (object) to purge
343 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
344 revision of an article
345 &$title: title object of the article
347 'ArticleRevisionUndeleted': after an article revision is restored
348 $title: the article title
349 $revision: the revision
350 $oldPageID: the page ID of the revision when archived (may be null)
352 'ArticleRollbackComplete': after an article rollback is completed
353 $article: the article that was edited
354 $user: the user who did the rollback
355 $revision: the revision the page was reverted back to
357 'ArticleSave': before an article is saved
358 $article: the article (object) being saved
359 $user: the user (object) saving the article
360 $text: the new article text
361 $summary: the article summary (comment)
362 $isminor: minor flag
363 $iswatch: watch flag
364 $section: section #
366 'ArticleSaveComplete': After an article has been updated
367 $article: Article modified
368 $user: User performing the modification
369 $text: New content
370 $summary: Edit summary/comment
371 $isMinor: Whether or not the edit was marked as minor
372 $isWatch: (No longer used)
373 $section: (No longer used)
374 $flags: Flags passed to Article::doEdit()
375 $revision: New Revision of the article
377 'ArticleSaveComplete': after an article is saved
378 $article: the article (object) saved
379 $user: the user (object) who saved the article
380 $text: the new article text
381 $summary: the article summary (comment)
382 $isminor: minor flag
383 $iswatch: watch flag
384 $section: section #
386 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
388 'ArticleUndelete': When one or more revisions of an article are restored
389 $title: Title corresponding to the article restored
390 $create: Whether or not the restoration caused the page to be created
391 (i.e. it didn't exist before)
393 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
394 &$article: the article
395 &$sectionanchor: The section anchor link (e.g. "#overview" )
396 &$extraq: Extra query parameters which can be added via hooked functions
398 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
399 &$article: the article
400 &$pcache: whether to try the parser cache or not
401 &$outputDone: whether the output for this page finished or not
403 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
404 $article: target article (object)
406 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
407 Gives a chance for an extension to set it programattically to a variable class.
408 &$auth: the $wgAuth object, probably a stub
410 'AutoAuthenticate': called to authenticate users on external/environmental means
411 $user: writes user object to this parameter
413 'AutopromoteCondition': check autopromote condition for user.
414 $type: condition type
415 $args: arguments
416 $user: user
417 $result: result of checking autopromote condition
419 'BadImage': When checking against the bad image list
420 $name: Image name being checked
421 &$bad: Whether or not the image is "bad"
423 Change $bad and return false to override. If an image is "bad", it is not
424 rendered inline in wiki pages or galleries in category pages.
426 'BeforeGalleryFindFile': before an image is fetched for a gallery
427 &$gallery,: the gallery object
428 &$nt: the image title 
429 &$time: image timestamp
431 'BeforePageDisplay': Prior to outputting a page
432 &$out: OutputPage object
433 &$skin: Skin object
435 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
436 &$parser: Parser object
437 &$title: title of the template
438 &$skip: skip this template and link it?
439 &$id: the id of the revision being parsed
441 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
442 &$parser: Parser object
443 &$nt: the image title
444 &$skip: skip this image and link it?
445 &$time: the image timestamp
447 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
448 &$parser: Parser object
449 &$ig: ImageGallery object
451 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
452 $nondefaults: Assoc array with the following keys:
453               days, hideOwn, hideBots, hideMinor, namespace
454 $wgUser: wgUser.
455 &$hookSql: a string which will be inserted without sanitation into the SQL query
456            used to get the watchlist, at the end of the WHERE part.
458 'BlockIp': before an IP address or user is blocked
459 $block: the Block object about to be saved
460 $user: the user _doing_ the block (not the one being blocked)
462 'BlockIpComplete': after an IP address or user is blocked
463 $block: the Block object that was saved
464 $user: the user who did the block (not the one being blocked)
466 'BookInformation': Before information output on Special:Booksources
467 $isbn: ISBN to show information for
468 $output: OutputPage object in use
470 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
471 &$this: Linker instance
472 $nt: the page title
473 $query: the URL query string passed in
474 &$u: the URL of this link
475 &$style: the inline CSS style
476 &$prefix: a prefix prepended to the linked text
477 &$text: the text placed by the user in the wiki-link
478 &$inside: any additional alphanumeric characters placed after the wiki-link,
479 that are made part of the link text
480 &$trail: text placed immediately after the HTML link
482 'CategoryPageView': before viewing a categorypage in CategoryPage::view
483 $catpage: CategoryPage instance
485 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
486 &$this:        ChangesList instance.
487 &$articlelink: HTML of link to article (already filled-in).
488 &$s:           HTML of row that is being constructed.
489 &$rc:          RecentChange instance.
490 $unpatrolled:  Whether or not we are showing unpatrolled changes.
491 $watched:      Whether or not the change is watched by the user.
493 'ContributionsToolLinks': Change tool links above Special:Contributions
494 $id: User identifier
495 $title: User page title
496 &$tools: Array of tool links
498 'CustomEditor': When invoking the page editor
499 $article: Article being edited
500 $user: User performing the edit
502 Return true to allow the normal editor to be used, or false
503 if implementing a custom editor, e.g. for a special namespace,
504 etc.
506 'DiffViewHeader': called before diff display
507 $diff: DifferenceEngine object that's calling
508 $oldRev: Revision object of the "old" revision (may be null/invalid)
509 $newRev: Revision object of the "new" revision
511 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
512 $article: article (object) being viewed
513 $oldid: oldid (int) being viewed
515 'EditFilter': Perform checks on an edit
516 $editor: Edit form (see includes/EditPage.php)
517 $text: Contents of the edit box
518 $section: Section being edited
519 &$error: Error message to return
521 'EditFilterMerged': Post-section-merge edit filter
522 $editor: EditPage instance (object)
523 $text: content of the edit box
524 $error: error message to return
526 'EditFormPreloadText': Allows population of the edit form when creating new pages
527 &$text: Text to preload with
528 &$title: Title object representing the page being created
530 'EditPage::attemptSave': called before an article is
531 saved, that is before insertNewArticle() is called
532 &$editpage_Obj: the current EditPage object
534 'EditPage::showEditForm:fields': allows injection of form field into edit form
535 &$editor: the EditPage instance for reference
536 &$out: an OutputPage instance to write to
537 return value is ignored (should always return true)
539 'EditPage::showEditForm:initial': before showing the edit form
540 $editor: EditPage instance (object)
542 Return false to halt editing; you'll need to handle error messages, etc. yourself.
543 Alternatively, modifying $error and returning true will cause the contents of $error
544 to be echoed at the top of the edit form as wikitext. Return true without altering
545 $error to allow the edit to proceed.
547 'EditPageBeforeEditButtons':  allows modifying the edit buttons below the textarea in the edit form
548 &$editpage: The current EditPage object
549 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
551 'EditSectionLink': Override the return value of Linker::editSectionLink()
552 $skin: Skin rendering the UI
553 $title: Title being linked to
554 $section: Section to link to
555 $link: Default link
556 $result: Result (alter this to override the generated links)
558 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
559 $skin: Skin rendering the UI
560 $title: Title being linked to
561 $section: Section to link to
562 $hint: Anchor title/tooltip attributes
563 $link: Default link
564 $result: Result (alter this to override the generated links)
566 'EmailConfirmed': When checking that the user's email address is "confirmed"
567 $user: User being checked
568 $confirmed: Whether or not the email address is confirmed
569 This runs before the other checks, such as anonymity and the real check; return
570 true to allow those checks to occur, and false if checking is done.
572 'EmailUser': before sending email from one user to another
573 $to: address of receiving user
574 $from: address of sending user
575 $subject: subject of the mail
576 $text: text of the mail
578 'EmailUserComplete': after sending email from one user to another
579 $to: address of receiving user
580 $from: address of sending user
581 $subject: subject of the mail
582 $text: text of the mail
584 'FetchChangesList': When fetching the ChangesList derivative for a particular user
585 &$user: User the list is being fetched for
586 &$skin: Skin object to be used with the list
587 &$list: List object (defaults to NULL, change it to an object instance and return
588 false override the list derivative used)
590 'FileDeleteComplete': When a file is deleted
591 $file: reference to the deleted file
592 $oldimage: in case of the deletion of an old image, the name of the old file
593 $article: in case all revisions of the file are deleted a reference to the article 
594           associated with the file.
595 $user: user who performed the deletion
596 $reason: reason
598 'FileUpload': When a file upload occurs
599 $file : Image object representing the file that was uploaded
601 'FileUndeleteComplete': When a file is undeleted
602 $title: title object to the file
603 $fileVersions: array of undeleted versions. Empty if all versions were restored
604 $user: user who performed the undeletion
605 $reason: reason
607 'GetBlockedStatus': after loading blocking status of an user from the database
608 $user: user (object) being checked
610 'GetCacheVaryCookies': get cookies that should vary cache options
611 $out: OutputPage object
612 &$cookies: array of cookies name, add a value to it if you want to add a cookie
613         that have to vary cache options
615 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
616 $title: Title object of page
617 $url: string value as output (out parameter, can modify)
618 $query: query options passed to Title::getFullURL()
620 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
621 $title: Title object of page
622 $url: string value as output (out parameter, can modify)
623 $query: query options passed to Title::getInternalURL()
625 'GetLinkColours': modify the CSS class of an array of page links
626 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
627 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
629 'GetLocalURL': modify local URLs as output into page links
630 $title: Title object of page
631 $url: string value as output (out parameter, can modify)
632 $query: query options passed to Title::getLocalURL()
634 'getUserPermissionsErrors': Add a permissions error when permissions errors are
635         checked for.  Use instead of userCan for most cases. Return false if the
636         user can't do it, and populate $result with the reason in the form of
637         array( messagename, param1, param2, ... ).  For consistency, error messages
638         should be plain text with no special coloring, bolding, etc. to show that
639         they're errors; presenting them properly to the user as errors is done by
640         the caller.
641 $title: Title object being checked against
642 $user : Current user object
643 $action: Action being checked
644 $result: User permissions error to add. If none, return true.
646 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
647         if expensive checks are enabled.
649 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
650         the image on an image page
651 $imagePage: ImagePage object ($this)
652 $output: $wgOut
654 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
655         image insertion.  You can skip the default logic entirely by returning
656         false, or just modify a few things using call-by-reference.
657 &$this: Skin object
658 &$title: Title object of the image
659 &$file: File object, or false if it doesn't exist
660 &$frameParams: Various parameters with special meanings; see documentation in
661         includes/Linker.php for Linker::makeImageLink2
662 &$handlerParams: Various parameters with special meanings; see documentation in
663         includes/Linker.php for Linker::makeImageLink2
664 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
665 &$res: Final HTML output, used if you return false
667 'InitPreferencesForm': called at the end of PreferencesForm's constructor
668 $form: the PreferencesForm
669 $request: the web request to initialized from
671 'InternalParseBeforeLinks': during Parser's internalParse method before links but
672 after noinclude/includeonly/onlyinclude and other processing.
673 &$this: Parser object
674 &$text: string containing partially parsed text
675 &$this->mStripState: Parser's internal StripState object
677 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
678 $article: article (object) being checked
680 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
681 $ip: IP being check
682 $result: Change this value to override the result of wfIsTrustedProxy()
684 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
685 tance to return false if the domain name doesn't match your organization
686 $addr: The e-mail address entered by the user
687 &$result: Set this and return false to override the internal checks
689 'isValidPassword': Override the result of User::isValidPassword()
690 $password: The password entered by the user
691 &$result: Set this and return false to override the internal checks
692 $user: User the password is being validated for
694 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
695 $magicExtensions: associative array of magic words synonyms
696 $lang: laguage code (string)
698 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
699 $specialPageAliases: associative array of magic words synonyms
700 $lang: laguage code (string)
702 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
703 &$linksUpdate: the LinkUpdate object
705 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
706 &$linksUpdate: the LinkUpdate object
708 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
709 &$linksUpdate: the LinkUpdate object
711 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
713 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
715 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
716                           No return data is accepted; this hook is for auditing only.
717 $user: the User object being authenticated against
718 $password: the password being submitted and found wanting
719 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
721 'LogLine': Processes a single log entry on Special:Log
722 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type 
723     database field.
724 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
725     to logging.log_action database field.
726 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
727 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
728     appears to contain anything.
729 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
730 &$revert: string that is displayed in the UI, similar to $comment.
731 $time: timestamp of the log entry (added in 1.12) 
733 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
734 &$type: array of strings
736 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
737 &$typeText: array of strings
739 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
740 &$headerText: array of strings
742 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
743 &$actionText: array of strings
745 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
746 $magicWords: array of strings
748 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
749 $variableIDs: array of strings
751 'MarkPatrolled': before an edit is marked patrolled
752 $rcid: ID of the revision to be marked patrolled
753 $user: the user (object) marking the revision as patrolled
754 $wcOnlySysopsCanPatrol: config setting indicating whether the user
755  needs to be a sysop in order to mark an edit patrolled
757 'MarkPatrolledComplete': after an edit is marked patrolled
758 $rcid: ID of the revision marked as patrolled
759 $user: user (object) who marked the edit patrolled
760 $wcOnlySysopsCanPatrol: config setting indicating whether the user
761  must be a sysop to patrol the edit
763 'MathAfterTexvc': after texvc is executed when rendering mathematics
764 $mathRenderer: instance of MathRenderer
765 $errmsg: error message, in HTML (string). Nonempty indicates failure
766  of rendering the formula
768 'MediaWikiPerformAction': Override MediaWiki::performAction().
769 Use this to do something completely different, after the basic
770 globals have been set up, but before ordinary actions take place.
771 $output:  $wgOut
772 $article: $wgArticle
773 $title:   $wgTitle
774 $user:    $wgUser
775 $request: $wgRequest
777 'MessagesPreLoad': When loading a message from the database
778 $title: title of the message (string)
779 $message: value (string), change it to the message you want to define
781 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
782 $tools: array of tools
784 'OutputPageBeforeHTML': a page has been processed by the parser and
785 the resulting HTML is about to be displayed.  
786 $parserOutput: the parserOutput (object) that corresponds to the page 
787 $text: the text that will be displayed, in HTML (string)
789 'OutputPageParserOutput': after adding a parserOutput to $wgOut
790 $out: OutputPage instance (object)
791 $parserOutput: parserOutput instance being added in $out
793 'PageHistoryBeforeList': When a history page list is about to be constructed.
794 $article: the article that the history is loading for
796 'PageHistoryLineEnding' : right before the end <li> is added to a history line
797 $row: the revision row for this line
798 $s: the string representing this parsed line
800 'PageRenderingHash': alter the parser cache option hash key
801   A parser extension which depends on user options should install
802   this hook and append its values to the key.
803 $hash: reference to a hash key string which can be modified
805 'ParserAfterStrip': Same as ParserBeforeStrip
807 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
808 $parser: Parser object being used 
809 $text: text that'll be returned
811 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
812 $parser: Parser object
813 $text: text to parse
814 $stripState: StripState instance being used
816 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
817 $parser: parser object
818 $text: text being parsed
819 $stripState: stripState used (object)
821 'ParserBeforeTidy': called before tidy and custom tags replacements
822 $parser: Parser object being used 
823 $text: actual text
825 'ParserClearState': called at the end of Parser::clearState()
826 $parser: Parser object being cleared
828 'ParserFirstCallInit': called when the parser initialises for the first time
829 &$parser: Parser object being cleared
831 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
832 $parser: Parser object
833 $varCache: array to store the value in case of multiples calls of the same magic word
834 $index: index (string) of the magic
835 $ret: value of the magic word (the hook should set it)
837 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
838 $parser: Parser object
839 $time: actual time (timestamp)
841 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
842 $parser: Parser object
843 $varCache: varaiable cache (array)
845 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
846 $parser: Parser object
847 $limitReport: text that will be included (without comment tags)
849 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
850 $title: title object representing the file
851 $file: file object that will be used to create the image
852 &$params: 2-D array of parameters
854 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
855 $parser: Parser object created
857 'ParserTestTables': alter the list of tables to duplicate when parser tests
858 are run. Use when page save hooks require the presence of custom tables
859 to ensure that tests continue to run properly.
860 &$tables: array of table names
862 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
863 my talk page, my contributions" etc).
865 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
866 &$title: Title object representing the current page
868 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
869 &$user : User performing the action
870 $action : Action being performed
871 &$result : Whether or not the action should be prevented
872 Change $result and return false to give a definitive answer, otherwise
873 the built-in rate limiting checks are used, if enabled.
875 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
876 $form : PreferencesForm object
877 &$html : HTML to append to
879 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
880 AJAX search suggestions. Put results into &$results outparam and return false.
881 $ns : int namespace key to search in
882 $search : search term (not guaranteed to be conveniently normalized)
883 $limit : maximum number of results to return
884 &$results : out param: array of page names (strings)
886 'PrefsEmailAudit': called when user changes his email address
887 $user: User (object) changing his email address
888 $oldaddr: old email address (string)
889 $newaddr: new email address (string)
891 'PrefsPasswordAudit': called when user changes his password
892 $user: User (object) changing his passoword
893 $newPass: new password
894 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
896 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
897 &$obj: RawPage object
898 &$text: The text that's going to be the output
900 'RecentChange_save': called at the end of RecenChange::save()
901 $recentChange: RecentChange object
903 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
904 $form: the PreferencesForm
905 $out: output page to render to, probably $wgOut
907 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
908 $form: the PreferencesForm
909 $user: the User object to load preferences from
911 'SavePreferences': called at the end of PreferencesForm::savePreferences; 
912                    returning false prevents the preferences from being saved.
913 $form: the PreferencesForm
914 $user: the User object to save preferences to
915 $message: change this to set an error message (ignored if the hook does not return false)
916 $old: old preferences of the user
918 'SearchUpdate': Prior to search update completion
919 $id : Page id
920 $namespace : Page namespace
921 $title : Page title
922 $text : Current text being indexed
924 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
925 $term : Search term string
926 &$title : Outparam; set to $title object and return false for a match
928 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
929 $text: Text being shown
930 $title: Title of the custom script/stylesheet page
931 $output: Current OutputPage object
933 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
934 &$siteNotice: HTML returned as the sitenotice
935 Return true to allow the normal method of notice selection/rendering to work,
936 or change the value of $siteNotice and return false to alter it.
938 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
939 &$siteNotice: HTML sitenotice
940 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
942 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
943 $skin: Skin object
944 &$text: bottomScripts Text
945 Append to $text to add additional text/scripts after the stock bottom scripts.
947 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
948 $skin: Skin object
949 &$subpages: Subpage links HTML
950 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
951 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
953 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab  when showing a special page
954 $sktemplate: SkinTemplate object
955 $content_actions: array of tabs
957 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
958 $sktemplate: SkinTemplate object
959 $nav_urls: array of tabs
961 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
962 &$content_actions: Content actions
963 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
964 for an example]
966 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
967 &$sktemplate: SkinTemplate object
968 &$tpl: Template engine object
970 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
971 $sktemplate: SkinTemplate object
972 $res: set to true to prevent active tabs
974 'SkinTemplateSetupPageCss': use this to provide per-page CSS
975 $out: Css to return
977 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
978        You can either create your own array, or alter the parameters for the normal one.
979 &$this:     The SkinTemplate instance.
980 $title:     Title instance for the page.
981 $message:   Visible label of tab.
982 $selected:  Whether this is a selected tab.
983 $checkEdit: Whether or not the action=edit query should be added if appropriate.
984 &$classes:  Array of CSS classes to apply.
985 &$query:    Query string to add to link.
986 &$text:     Link text.
987 &$result:   Complete assoc. array if you want to return true.
989 'SkinTemplateTabs': called when finished to build the actions tabs
990 $sktemplate: SkinTemplate object
991 $content_actions: array of tabs
993 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
994 $id: User identifier
996 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
997 $pager: The UsersPager instance
998 $query: The query array to be returned
1000 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1001 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1002 $row: Database row object
1004 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1005 $pager: The UsersPager instance
1006 $out: The header HTML
1008 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1009 $pager: The UsersPager instance
1010 $out: The header HTML
1012 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1013 $pager: The UsersPager instance
1014 $query: The query array to be returned
1016 'SpecialMovepageAfterMove': called after moving a page
1017 $movePage: MovePageForm object
1018 $oldTitle: old title (object)
1019 $newTitle: new title (object)
1021 'SpecialPageExecuteAfterPage': called after executing a special page
1022 Warning: Not all the special pages call this hook
1023 $specialPage: SpecialPage object
1024 $par: paramter passed to the special page (string)
1025 $funct: function called to execute the special page
1027 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1028 Warning: Not all the special pages call this hook
1029 $specialPage: SpecialPage object
1030 $par: paramter passed to the special page (string)
1031 $funct: function called to execute the special page
1033 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1034 Warning: Not all the special pages call this hook
1035 $specialPage: SpecialPage object
1036 $par: paramter passed to the special page (string)
1037 $funct: function called to execute the special page
1039 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1040 $list: list (array) of core special pages
1042 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1043 $title: title object generated from the text entred by the user
1045 'SpecialSearchResults': called before search result display when there are matches
1046 $term: string of search term
1047 $titleMatches: empty or SearchResultSet object
1048 $textMatches: empty or SearchResultSet object
1050 'SpecialSearchNoResults': called before search result display when there are no matches
1051 $term: string of search term
1053 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1054 $extTypes: associative array of extensions types
1056 'TitleMoveComplete': after moving an article (title)
1057 $old: old title
1058 $nt: new title
1059 $user: user who did the move
1060 $pageid: database ID of the page that's been moved
1061 $redirid: database ID of the created redirect
1063 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1064 $title: title object related to the revision
1065 $rev: revision (object) that will be viewed
1067 'UnknownAction': An unknown "action" has occured (useful for defining
1068                  your own actions)
1069 $action: action name
1070 $article: article "acted on"
1072 'UnwatchArticle': before a watch is removed from an article
1073 $user: user watching
1074 $article: article object to be removed
1076 'UnwatchArticle': after a watch is removed from an article
1077 $user: user that was watching
1078 $article: article object removed
1080 'UnwatchArticleComplete': after a watch is removed from an article
1081 $user: user that watched
1082 $article: article object that was watched
1084 'UploadForm:initial': before the upload form is generated
1085 $form: UploadForm object
1086 You might set the member-variables $uploadFormTextTop and 
1087 $uploadFormTextAfterSummary to inject text (HTML) either before
1088 or after the editform.
1090 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1091 $form: UploadForm object
1092 Lets you poke at member variables like $mUploadDescription before the
1093 file is saved.
1095 'UploadVerification': additional chances to reject an uploaded file
1096 string $saveName: destination file name
1097 string $tempName: filesystem path to the temporary file for checks
1098 string &$error: output: HTML error to show if upload canceled by returning false
1100 'UploadComplete': Upon completion of a file upload
1101 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1103 'userCan': To interrupt/advise the "user can do X to Y article" check.
1104         If you want to display an error message, try getUserPermissionsErrors.
1105 $title: Title object being checked against
1106 $user : Current user object
1107 $action: Action being checked
1108 $result: Pointer to result returned if hook returns false. If null is returned,
1109  userCan checks are continued by internal code.
1111 'UserCanSendEmail': To override User::canSendEmail() permission check
1112 $user: User (object) whose permission is being checked
1113 &$canSend: bool set on input, can override on output
1116 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1117 $user: User (object) that'll clear the message
1119 'UserCreateForm': change to manipulate the login form
1120 $template: SimpleTemplate instance for the form
1122 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1123 $user: User to get groups for
1124 &$groups: Current effective groups
1126 'UserLoginComplete': after a user has logged in
1127 $user: the user object that was created on login
1128 $inject_html: Any HTML to inject after the "logged in" message.
1129                     
1130 'UserLoginForm': change to manipulate the login form
1131 $template: SimpleTemplate instance for the form
1133 'UserLogout': before a user logs out
1134 $user: the user object that is about to be logged out
1135        
1136 'UserLogoutComplete': after a user has logged out
1137 $user: the user object _after_ logout (won't have name, ID, etc.)
1138 $inject_html: Any HTML to inject after the "logged out" message.
1140 'UserRights': After a user's group memberships are changed
1141 $user  : User object that was changed
1142 $add   : Array of strings corresponding to groups added
1143 $remove: Array of strings corresponding to groups removed
1144                       
1145 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1146 &$groups: List of implicit (automatically-assigned) groups
1148 'UserGetRights': Called in User::getRights()
1149 $user: User to get rights for
1150 &$rights: Current rights
1152 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1153 $user: user retrieving new talks messages
1154 $talks: array of new talks page(s)
1156 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1157 $toggles: array of toggles to add
1159 'WatchArticle': before a watch is added to an article
1160 $user: user that will watch
1161 $article: article object to be watched
1163 'WatchArticleComplete': after a watch is added to an article
1164 $user: user that watched
1165 $article: article object watched
1167 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1168 $query: $wgQueryPages itself
1170 More hooks might be available but undocumented, you can execute
1171 ./maintenance/findhooks.php to find hidden one.