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