Added new hook 'MessageCacheReplace' into MessageCache.php. For instance
[lhc/web/wiklou.git] / docs / hooks.txt
1 hooks.txt
2
3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
5
6 ==Glossary==
7
8 event
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
14 'ArticleDelete'.
15
16 hook
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
19
20 hook function
21 The function part of a hook.
22
23 ==Rationale==
24
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
31
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
36
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
39
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
42 }
43
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
46 }
47
48 # code to actually show the article goes here
49 }
50
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
54
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
57
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
60 }
61
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
64 }
65
66 # code to actually show the article goes here
67
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
70 }
71 }
72
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
75
76 function showAnArticle($article) {
77
78 if (wfRunHooks('ArticleShow', array(&$article))) {
79
80 # code to actually show the article goes here
81
82 wfRunHooks('ArticleShowComplete', array(&$article));
83 }
84 }
85
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
89
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
94 file:
95
96 function reverseArticleTitle($article) {
97 # ...
98 }
99
100 function reverseForExport($article) {
101 # ...
102 }
103
104 The setup function for the extension just has to add its hook functions to the
105 appropriate events:
106
107 setupTitleReversingExtension() {
108 global $wgHooks;
109
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
113 }
114
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
118
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
122
123 require_once('extensions/ReverseTitle.php');
124
125 ...to their LocalSettings.php file; those of us who don't want or need it can
126 just leave it out.
127
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
130
131 ==Writing hooks==
132
133 A hook is a chunk of code run at some particular event. It consists of:
134
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
137
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
140
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
144
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array($object, 'someMethod');
147 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148 $wgHooks['EventName'][] = array($object); # weird but OK
149
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
153
154 # function, no data
155 someFunction($param1, $param2)
156 # function with data
157 someFunction($someData, $param1, $param2)
158
159 # object only
160 $object->onEventName($param1, $param2)
161 # object with method
162 $object->someMethod($param1, $param2)
163 # object with method and data
164 $object->someMethod($someData, $param1, $param2)
165
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
169
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
172
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
175
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
178
179 Hooks can return three possible values:
180
181 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
185 function should skip
186
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
190
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
192
193 function ldapLogin($username, $password) {
194 # log user into LDAP
195 return false;
196 }
197
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
200
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
204
205 ==Using hooks==
206
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
209
210 class Article {
211 # ...
212 function protect() {
213 global $wgUser;
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
217 }
218 }
219 }
220
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
225
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
230 MediaWiki 1.4rc1.
231
232 ==Events and parameters==
233
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
236
237 'AbortAutoblock': Return false to cancel an autoblock.
238 $autoblockip: The IP going to be autoblocked.
239 $block: The block from which the autoblock is coming.
240
241 'AbortDiffCache': Can be used to cancel the caching of a diff
242 &$diffEngine: DifferenceEngine object
243
244 'AbortLogin': Return false to cancel account login.
245 $user: the User object being authenticated against
246 $password: the password being submitted, not yet checked for validity
247 &$retval: a LoginForm class constant to return from authenticateUserData();
248 default is LoginForm::ABORTED. Note that the client may be using
249 a machine API rather than the HTML user interface.
250
251 'AbortMove': allows to abort moving an article (title)
252 $old: old title
253 $nt: new title
254 $user: user who is doing the move
255 $err: error message
256 $reason: the reason for the move (added in 1.13)
257
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
262 'AddNewAccount': after a user account is created
263 $user: the User object that was created. (Parameter added in 1.7)
264 $byEmail: true when account was created "by email" (added in 1.12)
265
266 'AjaxAddScript': Called in output page just before the initialisation
267 of the javascript ajax engine. The hook is only called when ajax
268 is enabled ( $wgUseAjax = true; ).
269
270 'AlternateEdit': before checking if an user can edit a page and
271 before showing the edit form ( EditPage::edit() ). This is triggered
272 on &action=edit.
273 $EditPage : the EditPage object
274
275 'APIAfterExecute': after calling the execute() method of an API module.
276 Use this to extend core API modules.
277 &$module: Module object
278
279 'APIEditBeforeSave': before saving a page with api.php?action=edit,
280 after processing request parameters. Return false to let the request
281 fail, returning an error message or an <edit result="Failure"> tag
282 if $resultArr was filled.
283 $EditPage : the EditPage object
284 $text : the new text of the article (has yet to be saved)
285 $resultArr : data in this array will be added to the API result
286
287 'APIGetAllowedParams': use this hook to modify a module's parameters.
288 &$module: Module object
289 &$params: Array of parameters
290
291 'APIGetParamDescription': use this hook to modify a module's parameter
292 descriptions.
293 &$module: Module object
294 &$desc: Array of parameter descriptions
295
296 'APIQueryAfterExecute': after calling the execute() method of an
297 action=query submodule. Use this to extend core API modules.
298 &$module: Module object
299
300 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
301 method of an action=query submodule. Use this to extend core API modules.
302 &$module: Module object
303 &$resultPageSet: ApiPageSet object
304
305 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
306 Every token has an action, which will be used in the intoken parameter
307 and in the output (actiontoken="..."), and a callback function which
308 should return the token, or false if the user isn't allowed to obtain
309 it. The prototype of the callback function is func($pageid, $title)
310 where $pageid is the page ID of the page the token is requested for
311 and $title is the associated Title object. In the hook, just add
312 your callback to the $tokenFunctions array and return true (returning
313 false makes no sense)
314 $tokenFunctions: array(action => callback)
315
316 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
317 Every token has an action, which will be used in the rvtoken parameter
318 and in the output (actiontoken="..."), and a callback function which
319 should return the token, or false if the user isn't allowed to obtain
320 it. The prototype of the callback function is func($pageid, $title, $rev)
321 where $pageid is the page ID of the page associated to the revision the
322 token is requested for, $title the associated Title object and $rev the
323 associated Revision object. In the hook, just add your callback to the
324 $tokenFunctions array and return true (returning false makes no sense)
325 $tokenFunctions: array(action => callback)
326
327 'APIQueryRecentChangesTokens': use this hook to add custom tokens to list=recentchanges.
328 Every token has an action, which will be used in the rctoken parameter
329 and in the output (actiontoken="..."), and a callback function which
330 should return the token, or false if the user isn't allowed to obtain
331 it. The prototype of the callback function is func($pageid, $title, $rc)
332 where $pageid is the page ID of the page associated to the revision the
333 token is requested for, $title the associated Title object and $rc the
334 associated RecentChange object. In the hook, just add your callback to the
335 $tokenFunctions array and return true (returning false makes no sense)
336 $tokenFunctions: array(action => callback)
337
338 'ArticleAfterFetchContent': after fetching content of an article from the database
339 $article: the article (object) being loaded from the database
340 $content: the content (string) of the article
341
342 'ArticleDelete': before an article is deleted
343 $article: the article (object) being deleted
344 $user: the user (object) deleting the article
345 $reason: the reason (string) the article is being deleted
346 $error: if the deletion was prohibited, the (raw HTML) error message to display
347 (added in 1.13)
348
349 'ArticleDeleteComplete': after an article is deleted
350 $article: the article that was deleted
351 $user: the user that deleted the article
352 $reason: the reason the article was deleted
353 $id: id of the article that was deleted
354
355 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
356 $article: article (object) of the user talk page
357
358 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an article has been changed
359 $article: the article (object)
360 $editInfo: data holder that includes the parser output ($editInfo->output) for that page after the change
361 $changed: bool for if the page was changed
362
363 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
364 $article: article (object) being modified
365
366 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
367 $title: title (object) used to create the article object
368 $article: article (object) that will be returned
369
370 'ArticleInsertComplete': After a new article is created
371 $article: Article created
372 $user: User creating the article
373 $text: New content
374 $summary: Edit summary/comment
375 $isMinor: Whether or not the edit was marked as minor
376 $isWatch: (No longer used)
377 $section: (No longer used)
378 $flags: Flags passed to Article::doEdit()
379 $revision: New Revision of the article
380
381 'ArticleMergeComplete': after merging to article using Special:Mergehistory
382 $targetTitle: target title (object)
383 $destTitle: destination title (object)
384
385 'ArticlePageDataAfter': after loading data of an article from the database
386 $article: article (object) whose data were loaded
387 $row: row (object) returned from the database server
388
389 'ArticlePageDataBefore': before loading data of an article from the database
390 $article: article (object) that data will be loaded
391 $fields: fileds (array) to load from the database
392
393 'ArticleProtect': before an article is protected
394 $article: the article being protected
395 $user: the user doing the protection
396 $protect: boolean whether this is a protect or an unprotect
397 $reason: Reason for protect
398 $moveonly: boolean whether this is for move only or not
399
400 'ArticleProtectComplete': after an article is protected
401 $article: the article that was protected
402 $user: the user who did the protection
403 $protect: boolean whether it was a protect or an unprotect
404 $reason: Reason for protect
405 $moveonly: boolean whether it was for move only or not
406
407 'ArticlePurge': before executing "&action=purge"
408 $article: article (object) to purge
409
410 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
411 revision of an article
412 &$title: title object of the article
413
414 'ArticleRevisionUndeleted': after an article revision is restored
415 $title: the article title
416 $revision: the revision
417 $oldPageID: the page ID of the revision when archived (may be null)
418
419 'ArticleRollbackComplete': after an article rollback is completed
420 $article: the article that was edited
421 $user: the user who did the rollback
422 $revision: the revision the page was reverted back to
423 $current: the reverted revision
424
425 'ArticleSave': before an article is saved
426 $article: the article (object) being saved
427 $user: the user (object) saving the article
428 $text: the new article text
429 $summary: the article summary (comment)
430 $isminor: minor flag
431 $iswatch: watch flag
432 $section: section #
433
434 'ArticleSaveComplete': After an article has been updated
435 $article: Article modified
436 $user: User performing the modification
437 $text: New content
438 $summary: Edit summary/comment
439 $isMinor: Whether or not the edit was marked as minor
440 $isWatch: (No longer used)
441 $section: (No longer used)
442 $flags: Flags passed to Article::doEdit()
443 $revision: New Revision of the article
444 $baseRevId: the rev ID (or false) this edit was based on
445
446 'ArticleUndelete': When one or more revisions of an article are restored
447 $title: Title corresponding to the article restored
448 $create: Whether or not the restoration caused the page to be created
449 (i.e. it didn't exist before)
450
451 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
452 &$article: the article
453 &$sectionanchor: The section anchor link (e.g. "#overview" )
454 &$extraq: Extra query parameters which can be added via hooked functions
455
456 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
457 &$article: the article
458 &$pcache: whether to try the parser cache or not
459 &$outputDone: whether the output for this page finished or not
460
461 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
462 $article: target article (object)
463
464 'AuthPluginAutoCreate': Called when creating a local account for an user logged
465 in from an external authentication method
466 $user: User object created locally
467
468 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
469 Gives a chance for an extension to set it programattically to a variable class.
470 &$auth: the $wgAuth object, probably a stub
471
472 'AutopromoteCondition': check autopromote condition for user.
473 $type: condition type
474 $args: arguments
475 $user: user
476 $result: result of checking autopromote condition
477
478 'BadImage': When checking against the bad image list
479 $name: Image name being checked
480 &$bad: Whether or not the image is "bad"
481
482 Change $bad and return false to override. If an image is "bad", it is not
483 rendered inline in wiki pages or galleries in category pages.
484
485 'BeforeGalleryFindFile': before an image is fetched for a gallery
486 &$gallery,: the gallery object
487 &$nt: the image title
488 &$time: image timestamp
489
490 'BeforePageDisplay': Prior to outputting a page
491 &$out: OutputPage object
492 &$skin: Skin object
493
494 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
495 &$parser: Parser object
496 &$title: title of the template
497 &$skip: skip this template and link it?
498 &$id: the id of the revision being parsed
499
500 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
501 &$parser: Parser object
502 &$nt: the image title
503 &$skip: skip this image and link it?
504 &$time: the image timestamp
505
506 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
507 &$parser: Parser object
508 &$ig: ImageGallery object
509
510 'BlockIp': before an IP address or user is blocked
511 $block: the Block object about to be saved
512 $user: the user _doing_ the block (not the one being blocked)
513
514 'BlockIpComplete': after an IP address or user is blocked
515 $block: the Block object that was saved
516 $user: the user who did the block (not the one being blocked)
517
518 'BookInformation': Before information output on Special:Booksources
519 $isbn: ISBN to show information for
520 $output: OutputPage object in use
521
522 'CategoryPageView': before viewing a categorypage in CategoryPage::view
523 $catpage: CategoryPage instance
524
525 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
526 &$this: ChangesList instance.
527 &$articlelink: HTML of link to article (already filled-in).
528 &$s: HTML of row that is being constructed.
529 &$rc: RecentChange instance.
530 $unpatrolled: Whether or not we are showing unpatrolled changes.
531 $watched: Whether or not the change is watched by the user.
532
533 'ContribsPager::getQueryInfo': Before the contributions query is about to run
534 &$pager: Pager object for contributions
535 &queryInfo: The query for the contribs Pager
536
537 'ContributionsLineEnding': Called before a contributions HTML line is finished
538 $page: SpecialPage object for contributions
539 $ret: the HTML line
540 $row: the DB row for this line
541
542 'ContributionsToolLinks': Change tool links above Special:Contributions
543 $id: User identifier
544 $title: User page title
545 &$tools: Array of tool links
546
547 'CustomEditor': When invoking the page editor
548 $article: Article being edited
549 $user: User performing the edit
550
551 Return true to allow the normal editor to be used, or false
552 if implementing a custom editor, e.g. for a special namespace,
553 etc.
554
555 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
556 $title: the diff page title (nullable)
557 &$oldId: the actual old Id to use in the diff
558 &$newId: the actual new Id to use in the diff (0 means current)
559 $old: the ?old= param value from the url
560 $new: the ?new= param value from the url
561
562 'DiffViewHeader': called before diff display
563 $diff: DifferenceEngine object that's calling
564 $oldRev: Revision object of the "old" revision (may be null/invalid)
565 $newRev: Revision object of the "new" revision
566
567 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
568 $article: article (object) being viewed
569 $oldid: oldid (int) being viewed
570
571 'DoEditSectionLink': Override the HTML generated for section edit links
572 $skin: Skin object rendering the UI
573 $title: Title object for the title being linked to (may not be the same as
574 $wgTitle, if the section is included from a template)
575 $section: The designation of the section being pointed to, to be included in
576 the link, like "&section=$section"
577 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
578 By default, this is wrapped in the 'editsectionhint' message.
579 $result: The HTML to return, prefilled with the default plus whatever other
580 changes earlier hooks have made
581
582 'EditFilter': Perform checks on an edit
583 $editor: Edit form (see includes/EditPage.php)
584 $text: Contents of the edit box
585 $section: Section being edited
586 &$error: Error message to return
587 $summary: Edit summary for page
588
589 'EditFilterMerged': Post-section-merge edit filter
590 $editor: EditPage instance (object)
591 $text: content of the edit box
592 $error: error message to return
593 $summary: Edit summary for page
594
595 'EditFormPreloadText': Allows population of the edit form when creating new pages
596 &$text: Text to preload with
597 &$title: Title object representing the page being created
598
599 'EditPage::attemptSave': called before an article is
600 saved, that is before insertNewArticle() is called
601 &$editpage_Obj: the current EditPage object
602
603 'EditPage::showEditForm:fields': allows injection of form field into edit form
604 &$editor: the EditPage instance for reference
605 &$out: an OutputPage instance to write to
606 return value is ignored (should always return true)
607
608 'EditPage::showEditForm:initial': before showing the edit form
609 $editor: EditPage instance (object)
610
611 Return false to halt editing; you'll need to handle error messages, etc. yourself.
612 Alternatively, modifying $error and returning true will cause the contents of $error
613 to be echoed at the top of the edit form as wikitext. Return true without altering
614 $error to allow the edit to proceed.
615
616 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
617 when there's an edit conflict. Return false to halt normal diff output; in
618 this case you're responsible for computing and outputting the entire "conflict"
619 part, i.e., the "difference between revisions" and "your text" headers and
620 sections.
621 &$editor: EditPage instance
622 &$out: OutputPage instance
623
624 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
625 &$editpage: The current EditPage object
626 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
627 &$tabindex: HTML tabindex of the last edit check/button
628
629 'EditPageBeforeEditChecks': allows modifying the edit checks below the textarea in the edit form
630 &$editpage: The current EditPage object
631 &$checks: Array of edit checks like "watch this page"/"minor edit"
632 &$tabindex: HTML tabindex of the last edit check/button
633
634 'EditSectionLink': Do not use, use DoEditSectionLink instead.
635 $skin: Skin rendering the UI
636 $title: Title being linked to
637 $section: Section to link to
638 $link: Default link
639 $result: Result (alter this to override the generated links)
640
641 'EmailConfirmed': When checking that the user's email address is "confirmed"
642 $user: User being checked
643 $confirmed: Whether or not the email address is confirmed
644 This runs before the other checks, such as anonymity and the real check; return
645 true to allow those checks to occur, and false if checking is done.
646
647 'EmailUser': before sending email from one user to another
648 $to: address of receiving user
649 $from: address of sending user
650 $subject: subject of the mail
651 $text: text of the mail
652
653 'EmailUserComplete': after sending email from one user to another
654 $to: address of receiving user
655 $from: address of sending user
656 $subject: subject of the mail
657 $text: text of the mail
658
659 'FetchChangesList': When fetching the ChangesList derivative for a particular user
660 &$user: User the list is being fetched for
661 &$skin: Skin object to be used with the list
662 &$list: List object (defaults to NULL, change it to an object instance and return
663 false override the list derivative used)
664
665 'FileDeleteComplete': When a file is deleted
666 $file: reference to the deleted file
667 $oldimage: in case of the deletion of an old image, the name of the old file
668 $article: in case all revisions of the file are deleted a reference to the article
669 associated with the file.
670 $user: user who performed the deletion
671 $reason: reason
672
673 'FileUpload': When a file upload occurs
674 $file : Image object representing the file that was uploaded
675
676 'FileUndeleteComplete': When a file is undeleted
677 $title: title object to the file
678 $fileVersions: array of undeleted versions. Empty if all versions were restored
679 $user: user who performed the undeletion
680 $reason: reason
681
682 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
683 &$user: user to promote.
684 &$promote: groups that will be added.
685
686 'GetBlockedStatus': after loading blocking status of an user from the database
687 $user: user (object) being checked
688
689 'GetCacheVaryCookies': get cookies that should vary cache options
690 $out: OutputPage object
691 &$cookies: array of cookies name, add a value to it if you want to add a cookie
692 that have to vary cache options
693
694 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
695 $title: Title object of page
696 $url: string value as output (out parameter, can modify)
697 $query: query options passed to Title::getFullURL()
698
699 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
700 $title: Title object of page
701 $url: string value as output (out parameter, can modify)
702 $query: query options passed to Title::getInternalURL()
703
704 'GetLinkColours': modify the CSS class of an array of page links
705 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
706 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
707
708 'GetLocalURL': modify local URLs as output into page links
709 $title: Title object of page
710 $url: string value as output (out parameter, can modify)
711 $query: query options passed to Title::getLocalURL()
712
713 'getUserPermissionsErrors': Add a permissions error when permissions errors are
714 checked for. Use instead of userCan for most cases. Return false if the
715 user can't do it, and populate $result with the reason in the form of
716 array( messagename, param1, param2, ... ). For consistency, error messages
717 should be plain text with no special coloring, bolding, etc. to show that
718 they're errors; presenting them properly to the user as errors is done by
719 the caller.
720 $title: Title object being checked against
721 $user : Current user object
722 $action: Action being checked
723 $result: User permissions error to add. If none, return true.
724
725 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
726 if expensive checks are enabled.
727
728 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted into the job queue.
729 $title: Title object, pages linked to this title are purged.
730
731 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
732 image insertion. You can skip the default logic entirely by returning
733 false, or just modify a few things using call-by-reference.
734 &$this: Skin object
735 &$title: Title object of the image
736 &$file: File object, or false if it doesn't exist
737 &$frameParams: Various parameters with special meanings; see documentation in
738 includes/Linker.php for Linker::makeImageLink2
739 &$handlerParams: Various parameters with special meanings; see documentation in
740 includes/Linker.php for Linker::makeImageLink2
741 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
742 &$res: Final HTML output, used if you return false
743
744
745 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
746 the image on an image page
747 $imagePage: ImagePage object ($this)
748 $output: $wgOut
749
750 'ImagePageFileHistoryLine': called when a file history line is contructed
751 $file: the file
752 $line: the HTML of the history line
753 $css: the line CSS class
754
755 'ImagePageFindFile': called when fetching the file associated with an image page
756 $page: ImagePage object
757 &$file: File object
758 &$displayFile: displayed File object
759
760 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
761 $title: Title object ($wgTitle)
762 $request: WebRequest
763 $ignoreRedirect: boolean to skip redirect check
764 $target: Title/string of redirect target
765 $article: Article object
766
767 'InitPreferencesForm': called at the end of PreferencesForm's constructor
768 $form: the PreferencesForm
769 $request: the web request to initialized from
770
771 'InternalParseBeforeLinks': during Parser's internalParse method before links but
772 after noinclude/includeonly/onlyinclude and other processing.
773 &$this: Parser object
774 &$text: string containing partially parsed text
775 &$this->mStripState: Parser's internal StripState object
776
777 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
778 $article: article (object) being checked
779
780 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
781 $ip: IP being check
782 $result: Change this value to override the result of wfIsTrustedProxy()
783
784 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
785 tance to return false if the domain name doesn't match your organization
786 $addr: The e-mail address entered by the user
787 &$result: Set this and return false to override the internal checks
788
789 'isValidPassword': Override the result of User::isValidPassword()
790 $password: The password entered by the user
791 &$result: Set this and return false to override the internal checks
792 $user: User the password is being validated for
793
794 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
795 $magicExtensions: associative array of magic words synonyms
796 $lang: laguage code (string)
797
798 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
799 $specialPageAliases: associative array of magic words synonyms
800 $lang: laguage code (string)
801
802 'LinkBegin': Used when generating internal and interwiki links in
803 Linker::link(), before processing starts. Return false to skip default proces-
804 sing and return $ret. See documentation for Linker::link() for details on the
805 expected meanings of parameters.
806 $skin: the Skin object
807 $target: the Title that the link is pointing to
808 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
809 fault"
810 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
811 tive array form, with keys and values unescaped. Should be merged with de-
812 fault values, with a value of false meaning to suppress the attribute.
813 &$query: the query string to add to the generated URL (the bit after the "?"),
814 in associative array form, with keys and values unescaped.
815 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
816 &$ret: the value to return if your hook returns false.
817
818 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
819 just before the function returns a value. If you return true, an <a> element
820 with HTML attributes $attribs and contents $text will be returned. If you re-
821 turn false, $ret will be returned.
822 $skin: the Skin object
823 $target: the Title object that the link is pointing to
824 $options: the options. Will always include either 'known' or 'broken', and may
825 include 'noclasses'.
826 &$text: the final (raw HTML) contents of the <a> tag, after processing.
827 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
828 ciative array form.
829 &$ret: the value to return if your hook returns false.
830
831 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just before the return
832 &$url: the image url
833 &$alt: the image's alt text
834 &$img: the new image HTML (if returning false)
835
836 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
837 &$url: the link url
838 &$text: the link text
839 &$link: the new link HTML (if returning false)
840 &$attribs: the attributes to be applied.
841 $linkType: The external link type
842
843 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
844 &$linksUpdate: the LinkUpdate object
845
846 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
847 &$linksUpdate: the LinkUpdate object
848
849 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
850 &$linksUpdate: the LinkUpdate object
851
852 'ListDefinedTags': When trying to find all defined tags.
853 &$tags: The list of tags.
854
855 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
856
857 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
858
859 'LocalFile::getHistory': called before file history query performed
860 $file: the file
861 $tables: tables
862 $fields: select fields
863 $conds: conditions
864 $opts: query options
865 $join_conds: JOIN conditions
866
867 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
868 No return data is accepted; this hook is for auditing only.
869 $user: the User object being authenticated against
870 $password: the password being submitted and found wanting
871 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
872
873 'LogLine': Processes a single log entry on Special:Log
874 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
875 database field.
876 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
877 to logging.log_action database field.
878 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
879 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
880 appears to contain anything.
881 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
882 &$revert: string that is displayed in the UI, similar to $comment.
883 $time: timestamp of the log entry (added in 1.12)
884
885 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
886 &$type: array of strings
887
888 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
889 &$typeText: array of strings
890
891 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
892 &$headerText: array of strings
893
894 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
895 &$actionText: array of strings
896
897 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
898 $magicWords: array of strings
899
900 'MagicWordwgVariableIDs': When definig new magic words IDs.
901 $variableIDs: array of strings
902
903 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript is executed
904 &$vars: variable (or multiple variables) to be added into the output
905 of Skin::makeVariablesScript
906
907 'MarkPatrolled': before an edit is marked patrolled
908 $rcid: ID of the revision to be marked patrolled
909 $user: the user (object) marking the revision as patrolled
910 $wcOnlySysopsCanPatrol: config setting indicating whether the user
911 needs to be a sysop in order to mark an edit patrolled
912
913 'MarkPatrolledComplete': after an edit is marked patrolled
914 $rcid: ID of the revision marked as patrolled
915 $user: user (object) who marked the edit patrolled
916 $wcOnlySysopsCanPatrol: config setting indicating whether the user
917 must be a sysop to patrol the edit
918
919 'MathAfterTexvc': after texvc is executed when rendering mathematics
920 $mathRenderer: instance of MathRenderer
921 $errmsg: error message, in HTML (string). Nonempty indicates failure
922 of rendering the formula
923
924 'MediaWikiPerformAction': Override MediaWiki::performAction().
925 Use this to do something completely different, after the basic
926 globals have been set up, but before ordinary actions take place.
927 $output: $wgOut
928 $article: $wgArticle
929 $title: $wgTitle
930 $user: $wgUser
931 $request: $wgRequest
932 $this: The $mediawiki object
933
934 'MessagesPreLoad': When loading a message from the database
935 $title: title of the message (string)
936 $message: value (string), change it to the message you want to define
937
938 'MessageCacheReplace': When a message page is changed. Useful for updating caches.
939 $title: name of the page changed.
940 $text: new contents of the page.
941
942 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
943 Note: this is only run for the Monobook skin. To add items to the toolbox
944 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
945 instead.
946 $tools: array of tools
947
948 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
949 $article: the article edited
950 $rev: the new revision
951 $baseID: the revision ID this was based off, if any
952 $user: the editing user
953
954 'NormalizeMessageKey': Called before the software gets the text of a message
955 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets displayed
956 &$key: the message being looked up. Change this to something else to change what message gets displayed (string)
957 &$useDB: whether or not to look up the message in the database (bool)
958 &$langCode: the language code to get the message for (string) - or -
959 whether to use the content language (true) or site language (false) (bool)
960 &$transform: whether or not to expand variables and templates in the message (bool)
961
962 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
963 &$changeslist: The OldChangesList instance.
964 &$s: HTML of the form "<li>...</li>" containing one RC entry.
965 &$rc: The RecentChange object.
966
967 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
968 Hooks can alter or append to the array of URLs for search & suggestion formats.
969 &$urls: array of associative arrays with Url element attributes
970
971 'OutputPageBeforeHTML': a page has been processed by the parser and
972 the resulting HTML is about to be displayed.
973 $parserOutput: the parserOutput (object) that corresponds to the page
974 $text: the text that will be displayed, in HTML (string)
975
976 'OutputPageCheckLastModified': when checking if the page has been modified since the last visit
977 &$modifiedTimes: array of timestamps, the following keys are set: page, user, epoch
978
979 'OutputPageParserOutput': after adding a parserOutput to $wgOut
980 $out: OutputPage instance (object)
981 $parserOutput: parserOutput instance being added in $out
982
983 'OutputPageMakeCategoryLinks': links are about to be generated for the page's categories.
984 Implementations should return false if they generate the category links, so the default link generation is skipped.
985 $out: OutputPage instance (object)
986 $categories: associative array, keys are category names, values are category types ("normal" or "hidden")
987 $links: array, intended to hold the result. Must be an associative array with category types as keys and arrays of HTML links as values.
988
989 'PageHistoryBeforeList': When a history page list is about to be constructed.
990 $article: the article that the history is loading for
991
992 'PageHistoryLineEnding' : right before the end <li> is added to a history line
993 $row: the revision row for this line
994 $s: the string representing this parsed line
995
996 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed
997 $pager: the pager
998 $queryInfo: the query parameters
999
1000 'PageRenderingHash': alter the parser cache option hash key
1001 A parser extension which depends on user options should install
1002 this hook and append its values to the key.
1003 $hash: reference to a hash key string which can be modified
1004
1005 'ParserAfterStrip': Same as ParserBeforeStrip
1006
1007 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1008 $parser: Parser object being used
1009 $text: text that'll be returned
1010
1011 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1012 $parser: Parser object
1013 $text: text to parse
1014 $stripState: StripState instance being used
1015
1016 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
1017 $parser: parser object
1018 $text: text being parsed
1019 $stripState: stripState used (object)
1020
1021 'ParserBeforeTidy': called before tidy and custom tags replacements
1022 $parser: Parser object being used
1023 $text: actual text
1024
1025 'ParserClearState': called at the end of Parser::clearState()
1026 $parser: Parser object being cleared
1027
1028 'ParserFirstCallInit': called when the parser initialises for the first time
1029 &$parser: Parser object being cleared
1030
1031 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
1032 $parser: Parser object
1033 $varCache: array to store the value in case of multiples calls of the same magic word
1034 $index: index (string) of the magic
1035 $ret: value of the magic word (the hook should set it)
1036
1037 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
1038 $parser: Parser object
1039 $time: actual time (timestamp)
1040
1041 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
1042 $parser: Parser object
1043 $varCache: varaiable cache (array)
1044
1045 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
1046 $parser: Parser object
1047 $limitReport: text that will be included (without comment tags)
1048
1049 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
1050 $title: title object representing the file
1051 $file: file object that will be used to create the image
1052 &$params: 2-D array of parameters
1053
1054 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
1055 $parser: Parser object created
1056
1057 'ParserTestTables': alter the list of tables to duplicate when parser tests
1058 are run. Use when page save hooks require the presence of custom tables
1059 to ensure that tests continue to run properly.
1060 &$tables: array of table names
1061
1062 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1063 my talk page, my contributions" etc).
1064
1065 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1066 &$title: Title object representing the current page
1067
1068 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1069 &$user : User performing the action
1070 $action : Action being performed
1071 &$result : Whether or not the action should be prevented
1072 Change $result and return false to give a definitive answer, otherwise
1073 the built-in rate limiting checks are used, if enabled.
1074
1075 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
1076 $form : PreferencesForm object
1077 &$html : HTML to append to
1078
1079 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1080 AJAX search suggestions. Put results into &$results outparam and return false.
1081 $ns : array of int namespace keys to search in
1082 $search : search term (not guaranteed to be conveniently normalized)
1083 $limit : maximum number of results to return
1084 &$results : out param: array of page names (strings)
1085
1086 'PrefsEmailAudit': called when user changes his email address
1087 $user: User (object) changing his email address
1088 $oldaddr: old email address (string)
1089 $newaddr: new email address (string)
1090
1091 'PrefsPasswordAudit': called when user changes his password
1092 $user: User (object) changing his passoword
1093 $newPass: new password
1094 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1095
1096 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1097 &$obj: RawPage object
1098 &$text: The text that's going to be the output
1099
1100 'RecentChange_save': called at the end of RecenChange::save()
1101 $recentChange: RecentChange object
1102
1103 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
1104 $form: the PreferencesForm
1105 $out: output page to render to, probably $wgOut
1106
1107 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
1108 $form: the PreferencesForm
1109 $user: the User object to load preferences from
1110
1111 'RevisionInsertComplete': called after a revision is inserted into the DB
1112 &$revision: the Revision
1113 $data: the data stored in old_text. The meaning depends on $flags: if external
1114 is set, it's the URL of the revision text in external storage; otherwise,
1115 it's the revision text itself. In either case, if gzip is set, the revision
1116 text is gzipped.
1117 $flags: a comma-delimited list of strings representing the options used. May
1118 include: utf8 (this will always be set for new revisions); gzip; external.
1119
1120 'SavePreferences': called at the end of PreferencesForm::savePreferences;
1121 returning false prevents the preferences from being saved.
1122 $form: the PreferencesForm
1123 $user: the User object to save preferences to
1124 $message: change this to set an error message (ignored if the hook does not return false)
1125 $old: old preferences of the user
1126
1127 'SearchUpdate': Prior to search update completion
1128 $id : Page id
1129 $namespace : Page namespace
1130 $title : Page title
1131 $text : Current text being indexed
1132
1133 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1134 $term : Search term string
1135 &$title : Outparam; set to $title object and return false for a match
1136
1137 'SetupAfterCache': Called in Setup.php, after cache objects are set
1138
1139 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1140 $text: Text being shown
1141 $title: Title of the custom script/stylesheet page
1142 $output: Current OutputPage object
1143
1144 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1145 &$siteNotice: HTML returned as the sitenotice
1146 Return true to allow the normal method of notice selection/rendering to work,
1147 or change the value of $siteNotice and return false to alter it.
1148
1149 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1150 &$siteNotice: HTML sitenotice
1151 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1152
1153 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1154 $skin: Skin object
1155 &$text: bottomScripts Text
1156 Append to $text to add additional text/scripts after the stock bottom scripts.
1157
1158 'SkinAfterContent': Allows extensions to add text after the page content and
1159 article metadata.
1160 &$data: (string) Text to be printed out directly (without parsing)
1161 This hook should work in all skins. Just set the &$data variable to the text
1162 you're going to add.
1163
1164 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1165 $skin: Skin object
1166 &$bar: Sidebar contents
1167 Modify $bar to add or modify sidebar portlets.
1168
1169 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1170 $skin: Skin object
1171 &$subpages: Subpage links HTML
1172 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
1173 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
1174
1175 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
1176 $sktemplate: SkinTemplate object
1177 $content_actions: array of tabs
1178
1179 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
1180 $sktemplate: SkinTemplate object
1181 $nav_urls: array of tabs
1182
1183 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1184 &$content_actions: Content actions
1185 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1186 for an example]
1187
1188 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
1189 &$sktemplate: SkinTemplate object
1190 &$tpl: Template engine object
1191
1192 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1193 $sktemplate: SkinTemplate object
1194 $res: set to true to prevent active tabs
1195
1196 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1197 $out: Css to return
1198
1199 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1200 You can either create your own array, or alter the parameters for the normal one.
1201 &$this: The SkinTemplate instance.
1202 $title: Title instance for the page.
1203 $message: Visible label of tab.
1204 $selected: Whether this is a selected tab.
1205 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1206 &$classes: Array of CSS classes to apply.
1207 &$query: Query string to add to link.
1208 &$text: Link text.
1209 &$result: Complete assoc. array if you want to return true.
1210
1211 'SkinTemplateTabs': called when finished to build the actions tabs
1212 $sktemplate: SkinTemplate object
1213 $content_actions: array of tabs
1214
1215 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1216 $tools: array of tools
1217
1218 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1219 $id: User identifier
1220
1221 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1222 $pager: The UsersPager instance
1223 $query: The query array to be returned
1224
1225 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1226 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1227 $row: Database row object
1228
1229 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1230 $pager: The UsersPager instance
1231 $out: The header HTML
1232
1233 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1234 $pager: The UsersPager instance
1235 $out: The header HTML
1236
1237 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1238 $pager: The UsersPager instance
1239 $query: The query array to be returned
1240
1241 'SpecialMovepageAfterMove': called after moving a page
1242 $movePage: MovePageForm object
1243 $oldTitle: old title (object)
1244 $newTitle: new title (object)
1245
1246 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1247 $list: list (array) of core special pages
1248
1249 'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges
1250 &$extraOpts: array of added items, to which can be added
1251 $opts: FormOptions for this request
1252
1253 'SpecialRecentChangesQuery': called when building sql query for SpecialRecentChanges
1254 &$conds: array of WHERE conditionals for query
1255 &$tables: array of tables to be queried
1256 &$join_conds: join conditions for the tables
1257 $opts: FormOptions for this request
1258
1259 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1260 $title: title object generated from the text entred by the user
1261
1262 'SpecialSearchResults': called before search result display when there are matches
1263 $term: string of search term
1264 &$titleMatches: empty or SearchResultSet object
1265 &$textMatches: empty or SearchResultSet object
1266
1267 'SpecialSearchNoResults': called before search result display when there are no matches
1268 $term: string of search term
1269
1270 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1271 $extTypes: associative array of extensions types
1272
1273 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1274 &$conds: array of WHERE conditionals for query
1275 &$tables: array of tables to be queried
1276 &$join_conds: join conditions for the tables
1277 &$fields: array of query fields
1278
1279 'TitleArrayFromResult': called when creating an TitleArray object from a database result
1280 &$titleArray: set this to an object to override the default object returned
1281 $res: database result used to create the object
1282
1283 'TitleMoveComplete': after moving an article (title)
1284 $old: old title
1285 $nt: new title
1286 $user: user who did the move
1287 $pageid: database ID of the page that's been moved
1288 $redirid: database ID of the created redirect
1289
1290 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1291 $title: title object related to the revision
1292 $rev: revision (object) that will be viewed
1293
1294 'UnknownAction': An unknown "action" has occured (useful for defining
1295 your own actions)
1296 $action: action name
1297 $article: article "acted on"
1298
1299 'UnwatchArticle': before a watch is removed from an article
1300 $user: user watching
1301 $article: article object to be removed
1302
1303 'UnwatchArticle': after a watch is removed from an article
1304 $user: user that was watching
1305 $article: article object removed
1306
1307 'UnwatchArticleComplete': after a watch is removed from an article
1308 $user: user that watched
1309 $article: article object that was watched
1310
1311 'UploadForm:initial': before the upload form is generated
1312 $form: UploadForm object
1313 You might set the member-variables $uploadFormTextTop and
1314 $uploadFormTextAfterSummary to inject text (HTML) either before
1315 or after the editform.
1316
1317 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1318 $form: UploadForm object
1319 Lets you poke at member variables like $mUploadDescription before the
1320 file is saved.
1321
1322 'UploadVerification': additional chances to reject an uploaded file
1323 string $saveName: destination file name
1324 string $tempName: filesystem path to the temporary file for checks
1325 string &$error: output: HTML error to show if upload canceled by returning false
1326
1327 'UploadComplete': Upon completion of a file upload
1328 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1329
1330 'User::mailPasswordInternal': before creation and mailing of a user's new temporary password
1331 $user: the user who sent the message out
1332 $ip: IP of the user who sent the message out
1333 $u: the account whose new password will be set
1334
1335 'UserArrayFromResult': called when creating an UserArray object from a database result
1336 &$userArray: set this to an object to override the default object returned
1337 $res: database result used to create the object
1338
1339 'userCan': To interrupt/advise the "user can do X to Y article" check.
1340 If you want to display an error message, try getUserPermissionsErrors.
1341 $title: Title object being checked against
1342 $user : Current user object
1343 $action: Action being checked
1344 $result: Pointer to result returned if hook returns false. If null is returned,
1345 userCan checks are continued by internal code.
1346
1347 'UserCanSendEmail': To override User::canSendEmail() permission check
1348 $user: User (object) whose permission is being checked
1349 &$canSend: bool set on input, can override on output
1350
1351
1352 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1353 $user: User (object) that'll clear the message
1354
1355 'UserComparePasswords': called when checking passwords, return false to override the default password checks
1356 &$hash: String of the password hash (from the database)
1357 &$password: String of the plaintext password the user entered
1358 &$userId: Integer of the user's ID or Boolean false if the user ID was not supplied
1359 &$result: If the hook returns false, this Boolean value will be checked to determine if the password was valid
1360
1361 'UserCreateForm': change to manipulate the login form
1362 $template: SimpleTemplate instance for the form
1363
1364 'UserCryptPassword': called when hashing a password, return false to implement your own hashing method
1365 &$password: String of the plaintext password to encrypt
1366 &$salt: String of the password salt or Boolean false if no salt is provided
1367 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing method
1368 &$hash: If the hook returns false, this String will be used as the hash
1369
1370 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1371 $user: User to get groups for
1372 &$groups: Current effective groups
1373
1374 'UserGetAllRights': after calculating a list of all available rights
1375 &$rights: Array of rights, which may be added to.
1376
1377 'UserGetEmail': called when getting an user email address
1378 $user: User object
1379 &$email: email, change this to override local email
1380
1381 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1382 $user: User object
1383 &$timestamp: timestamp, change this to override local email authentification timestamp
1384
1385 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1386 &$groups: List of implicit (automatically-assigned) groups
1387
1388 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1389 *&$reservedUsernames: $wgReservedUsernames
1390
1391 'UserGetRights': Called in User::getRights()
1392 $user: User to get rights for
1393 &$rights: Current rights
1394
1395 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1396 &$user: User object
1397 $ip: User's IP address
1398 &$blocked: Whether the user is blocked, to be modified by the hook
1399
1400 'UserLoadDefaults': called when loading a default user
1401 $user: user object
1402 $name: user name
1403
1404 'UserLoadFromDatabase': called when loading a user from the database
1405 $user: user object
1406 &$s: database query object
1407
1408 'UserLoadFromSession': called to authenticate users on external/environmental means; occurs before session is loaded
1409 $user: user object being loaded
1410 &$result: set this to a boolean value to abort the normal authentification process
1411
1412 'UserLoadAfterLoadFromSession': called to authenticate users on external/environmental means; occurs after session is loaded
1413 $user: user object being loaded
1414
1415 'UserLoginComplete': after a user has logged in
1416 $user: the user object that was created on login
1417 $inject_html: Any HTML to inject after the "logged in" message.
1418
1419 'UserLoginForm': change to manipulate the login form
1420 $template: SimpleTemplate instance for the form
1421
1422 'UserLogout': before a user logs out
1423 $user: the user object that is about to be logged out
1424
1425 'UserLogoutComplete': after a user has logged out
1426 $user: the user object _after_ logout (won't have name, ID, etc.)
1427 $inject_html: Any HTML to inject after the "logged out" message.
1428 $oldName: name of the user before logout (string)
1429
1430 'UserRights': After a user's group memberships are changed
1431 $user : User object that was changed
1432 $add : Array of strings corresponding to groups added
1433 $remove: Array of strings corresponding to groups removed
1434
1435 'UserrightsChangeableGroups': allows modification of the groups a user may add or remove via Special:UserRights
1436 $userrights : UserrightsPage object
1437 $user : User object of the current user
1438 $addergroups : Array of groups that the user is in
1439 &$groups : Array of groups that can be added or removed. In format of
1440 array(
1441 'add' => array( addablegroups ),
1442 'remove' => array( removablegroups ),
1443 'add-self' => array( addablegroups to self ),
1444 'remove-self' => array( removable groups from self )
1445 )
1446
1447 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1448 $user: user retrieving new talks messages
1449 $talks: array of new talks page(s)
1450
1451 'UserSaveSettings': called when saving user settings
1452 $user: User object
1453
1454 'UserSetCookies': called when setting user cookies
1455 $user: User object
1456 &$session: session array, will be added to $_SESSION
1457 &$cookies: cookies array mapping cookie name to its value
1458
1459 'UserSetEmail': called when changing user email address
1460 $user: User object
1461 &$email: new email, change this to override new email address
1462
1463 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1464 $user: User object
1465 &$timestamp: new timestamp, change this to override local email authentification timestamp
1466
1467 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1468 $toggles: array of toggles to add
1469
1470 'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to alter the SQL query which gets the list of wanted pages
1471 &$wantedPages: WantedPagesPage object
1472 &$sql: raw SQL query used to get the list of wanted pages
1473
1474 'WatchArticle': before a watch is added to an article
1475 $user: user that will watch
1476 $article: article object to be watched
1477
1478 'WatchArticleComplete': after a watch is added to an article
1479 $user: user that watched
1480 $article: article object watched
1481
1482 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1483 $query: $wgQueryPages itself
1484
1485 More hooks might be available but undocumented, you can execute
1486 ./maintenance/findhooks.php to find hidden one.