self revert r45512, r45513 and r45515 for now
[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
445 'ArticleUndelete': When one or more revisions of an article are restored
446 $title: Title corresponding to the article restored
447 $create: Whether or not the restoration caused the page to be created
448 (i.e. it didn't exist before)
449
450 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
451 &$article: the article
452 &$sectionanchor: The section anchor link (e.g. "#overview" )
453 &$extraq: Extra query parameters which can be added via hooked functions
454
455 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
456 &$article: the article
457 &$pcache: whether to try the parser cache or not
458 &$outputDone: whether the output for this page finished or not
459
460 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
461 $article: target article (object)
462
463 'AuthPluginAutoCreate': Called when creating a local account for an user logged
464 in from an external authentication method
465 $user: User object created locally
466
467 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
468 Gives a chance for an extension to set it programattically to a variable class.
469 &$auth: the $wgAuth object, probably a stub
470
471 'AutopromoteCondition': check autopromote condition for user.
472 $type: condition type
473 $args: arguments
474 $user: user
475 $result: result of checking autopromote condition
476
477 'BadImage': When checking against the bad image list
478 $name: Image name being checked
479 &$bad: Whether or not the image is "bad"
480
481 Change $bad and return false to override. If an image is "bad", it is not
482 rendered inline in wiki pages or galleries in category pages.
483
484 'BeforeGalleryFindFile': before an image is fetched for a gallery
485 &$gallery,: the gallery object
486 &$nt: the image title
487 &$time: image timestamp
488
489 'BeforePageDisplay': Prior to outputting a page
490 &$out: OutputPage object
491 &$skin: Skin object
492
493 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
494 &$parser: Parser object
495 &$title: title of the template
496 &$skip: skip this template and link it?
497 &$id: the id of the revision being parsed
498
499 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
500 &$parser: Parser object
501 &$nt: the image title
502 &$skip: skip this image and link it?
503 &$time: the image timestamp
504
505 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
506 &$parser: Parser object
507 &$ig: ImageGallery object
508
509 'BlockIp': before an IP address or user is blocked
510 $block: the Block object about to be saved
511 $user: the user _doing_ the block (not the one being blocked)
512
513 'BlockIpComplete': after an IP address or user is blocked
514 $block: the Block object that was saved
515 $user: the user who did the block (not the one being blocked)
516
517 'BookInformation': Before information output on Special:Booksources
518 $isbn: ISBN to show information for
519 $output: OutputPage object in use
520
521 'CategoryPageView': before viewing a categorypage in CategoryPage::view
522 $catpage: CategoryPage instance
523
524 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
525 &$this: ChangesList instance.
526 &$articlelink: HTML of link to article (already filled-in).
527 &$s: HTML of row that is being constructed.
528 &$rc: RecentChange instance.
529 $unpatrolled: Whether or not we are showing unpatrolled changes.
530 $watched: Whether or not the change is watched by the user.
531
532 'ContribsPager::getQueryInfo': Before the contributions query is about to run
533 &$pager: Pager object for contributions
534 &queryInfo: The query for the contribs Pager
535
536 'ContributionsLineEnding': Called before a contributions HTML line is finished
537 $page: SpecialPage object for contributions
538 $ret: the HTML line
539 $row: the DB row for this line
540
541 'ContributionsToolLinks': Change tool links above Special:Contributions
542 $id: User identifier
543 $title: User page title
544 &$tools: Array of tool links
545
546 'CustomEditor': When invoking the page editor
547 $article: Article being edited
548 $user: User performing the edit
549
550 Return true to allow the normal editor to be used, or false
551 if implementing a custom editor, e.g. for a special namespace,
552 etc.
553
554 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
555 $title: the diff page title (nullable)
556 &$oldId: the actual old Id to use in the diff
557 &$newId: the actual new Id to use in the diff (0 means current)
558 $old: the ?old= param value from the url
559 $new: the ?new= param value from the url
560
561 'DiffViewHeader': called before diff display
562 $diff: DifferenceEngine object that's calling
563 $oldRev: Revision object of the "old" revision (may be null/invalid)
564 $newRev: Revision object of the "new" revision
565
566 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
567 $article: article (object) being viewed
568 $oldid: oldid (int) being viewed
569
570 'DoEditSectionLink': Override the HTML generated for section edit links
571 $skin: Skin object rendering the UI
572 $title: Title object for the title being linked to (may not be the same as
573 $wgTitle, if the section is included from a template)
574 $section: The designation of the section being pointed to, to be included in
575 the link, like "&section=$section"
576 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
577 By default, this is wrapped in the 'editsectionhint' message.
578 $result: The HTML to return, prefilled with the default plus whatever other
579 changes earlier hooks have made
580
581 'EditFilter': Perform checks on an edit
582 $editor: Edit form (see includes/EditPage.php)
583 $text: Contents of the edit box
584 $section: Section being edited
585 &$error: Error message to return
586 $summary: Edit summary for page
587
588 'EditFilterMerged': Post-section-merge edit filter
589 $editor: EditPage instance (object)
590 $text: content of the edit box
591 $error: error message to return
592 $summary: Edit summary for page
593
594 'EditFormPreloadText': Allows population of the edit form when creating new pages
595 &$text: Text to preload with
596 &$title: Title object representing the page being created
597
598 'EditPage::attemptSave': called before an article is
599 saved, that is before insertNewArticle() is called
600 &$editpage_Obj: the current EditPage object
601
602 'EditPage::showEditForm:fields': allows injection of form field into edit form
603 &$editor: the EditPage instance for reference
604 &$out: an OutputPage instance to write to
605 return value is ignored (should always return true)
606
607 'EditPage::showEditForm:initial': before showing the edit form
608 $editor: EditPage instance (object)
609
610 Return false to halt editing; you'll need to handle error messages, etc. yourself.
611 Alternatively, modifying $error and returning true will cause the contents of $error
612 to be echoed at the top of the edit form as wikitext. Return true without altering
613 $error to allow the edit to proceed.
614
615 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
616 when there's an edit conflict. Return false to halt normal diff output; in
617 this case you're responsible for computing and outputting the entire "conflict"
618 part, i.e., the "difference between revisions" and "your text" headers and
619 sections.
620 &$editor: EditPage instance
621 &$out: OutputPage instance
622
623 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
624 &$editpage: The current EditPage object
625 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
626 &$tabindex: HTML tabindex of the last edit check/button
627
628 'EditPageBeforeEditChecks': allows modifying the edit checks below the textarea in the edit form
629 &$editpage: The current EditPage object
630 &$checks: Array of edit checks like "watch this page"/"minor edit"
631 &$tabindex: HTML tabindex of the last edit check/button
632
633 'EditSectionLink': Do not use, use DoEditSectionLink instead.
634 $skin: Skin rendering the UI
635 $title: Title being linked to
636 $section: Section to link to
637 $link: Default link
638 $result: Result (alter this to override the generated links)
639
640 'EmailConfirmed': When checking that the user's email address is "confirmed"
641 $user: User being checked
642 $confirmed: Whether or not the email address is confirmed
643 This runs before the other checks, such as anonymity and the real check; return
644 true to allow those checks to occur, and false if checking is done.
645
646 'EmailUser': before sending email from one user to another
647 $to: address of receiving user
648 $from: address of sending user
649 $subject: subject of the mail
650 $text: text of the mail
651
652 'EmailUserComplete': after sending email from one user to another
653 $to: address of receiving user
654 $from: address of sending user
655 $subject: subject of the mail
656 $text: text of the mail
657
658 'FetchChangesList': When fetching the ChangesList derivative for a particular user
659 &$user: User the list is being fetched for
660 &$skin: Skin object to be used with the list
661 &$list: List object (defaults to NULL, change it to an object instance and return
662 false override the list derivative used)
663
664 'FileDeleteComplete': When a file is deleted
665 $file: reference to the deleted file
666 $oldimage: in case of the deletion of an old image, the name of the old file
667 $article: in case all revisions of the file are deleted a reference to the article
668 associated with the file.
669 $user: user who performed the deletion
670 $reason: reason
671
672 'FileUpload': When a file upload occurs
673 $file : Image object representing the file that was uploaded
674
675 'FileUndeleteComplete': When a file is undeleted
676 $title: title object to the file
677 $fileVersions: array of undeleted versions. Empty if all versions were restored
678 $user: user who performed the undeletion
679 $reason: reason
680
681 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
682 &$user: user to promote.
683 &$promote: groups that will be added.
684
685 'GetBlockedStatus': after loading blocking status of an user from the database
686 $user: user (object) being checked
687
688 'GetCacheVaryCookies': get cookies that should vary cache options
689 $out: OutputPage object
690 &$cookies: array of cookies name, add a value to it if you want to add a cookie
691 that have to vary cache options
692
693 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
694 $title: Title object of page
695 $url: string value as output (out parameter, can modify)
696 $query: query options passed to Title::getFullURL()
697
698 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
699 $title: Title object of page
700 $url: string value as output (out parameter, can modify)
701 $query: query options passed to Title::getInternalURL()
702
703 'GetLinkColours': modify the CSS class of an array of page links
704 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
705 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
706
707 'GetLocalURL': modify local URLs as output into page links
708 $title: Title object of page
709 $url: string value as output (out parameter, can modify)
710 $query: query options passed to Title::getLocalURL()
711
712 'getUserPermissionsErrors': Add a permissions error when permissions errors are
713 checked for. Use instead of userCan for most cases. Return false if the
714 user can't do it, and populate $result with the reason in the form of
715 array( messagename, param1, param2, ... ). For consistency, error messages
716 should be plain text with no special coloring, bolding, etc. to show that
717 they're errors; presenting them properly to the user as errors is done by
718 the caller.
719 $title: Title object being checked against
720 $user : Current user object
721 $action: Action being checked
722 $result: User permissions error to add. If none, return true.
723
724 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
725 if expensive checks are enabled.
726
727 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted into the job queue.
728 $title: Title object, pages linked to this title are purged.
729
730 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
731 image insertion. You can skip the default logic entirely by returning
732 false, or just modify a few things using call-by-reference.
733 &$this: Skin object
734 &$title: Title object of the image
735 &$file: File object, or false if it doesn't exist
736 &$frameParams: Various parameters with special meanings; see documentation in
737 includes/Linker.php for Linker::makeImageLink2
738 &$handlerParams: Various parameters with special meanings; see documentation in
739 includes/Linker.php for Linker::makeImageLink2
740 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
741 &$res: Final HTML output, used if you return false
742
743
744 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
745 the image on an image page
746 $imagePage: ImagePage object ($this)
747 $output: $wgOut
748
749 'ImagePageFileHistoryLine': called when a file history line is contructed
750 $file: the file
751 $line: the HTML of the history line
752 $css: the line CSS class
753
754 'ImagePageFindFile': called when fetching the file associated with an image page
755 $page: ImagePage object
756 &$file: File object
757 &$displayFile: displayed File object
758
759 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
760 $title: Title object ($wgTitle)
761 $request: WebRequest
762 $ignoreRedirect: boolean to skip redirect check
763 $target: Title/string of redirect target
764 $article: Article object
765
766 'InitPreferencesForm': called at the end of PreferencesForm's constructor
767 $form: the PreferencesForm
768 $request: the web request to initialized from
769
770 'InternalParseBeforeLinks': during Parser's internalParse method before links but
771 after noinclude/includeonly/onlyinclude and other processing.
772 &$this: Parser object
773 &$text: string containing partially parsed text
774 &$this->mStripState: Parser's internal StripState object
775
776 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
777 $article: article (object) being checked
778
779 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
780 $ip: IP being check
781 $result: Change this value to override the result of wfIsTrustedProxy()
782
783 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
784 tance to return false if the domain name doesn't match your organization
785 $addr: The e-mail address entered by the user
786 &$result: Set this and return false to override the internal checks
787
788 'isValidPassword': Override the result of User::isValidPassword()
789 $password: The password entered by the user
790 &$result: Set this and return false to override the internal checks
791 $user: User the password is being validated for
792
793 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
794 $magicExtensions: associative array of magic words synonyms
795 $lang: laguage code (string)
796
797 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
798 $specialPageAliases: associative array of magic words synonyms
799 $lang: laguage code (string)
800
801 'LinkBegin': Used when generating internal and interwiki links in
802 Linker::link(), before processing starts. Return false to skip default proces-
803 sing and return $ret. See documentation for Linker::link() for details on the
804 expected meanings of parameters.
805 $skin: the Skin object
806 $target: the Title that the link is pointing to
807 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
808 fault"
809 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
810 tive array form, with keys and values unescaped. Should be merged with de-
811 fault values, with a value of false meaning to suppress the attribute.
812 &$query: the query string to add to the generated URL (the bit after the "?"),
813 in associative array form, with keys and values unescaped.
814 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
815 &$ret: the value to return if your hook returns false.
816
817 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
818 just before the function returns a value. If you return true, an <a> element
819 with HTML attributes $attribs and contents $text will be returned. If you re-
820 turn false, $ret will be returned.
821 $skin: the Skin object
822 $target: the Title object that the link is pointing to
823 $options: the options. Will always include either 'known' or 'broken', and may
824 include 'noclasses'.
825 &$text: the final (raw HTML) contents of the <a> tag, after processing.
826 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
827 ciative array form.
828 &$ret: the value to return if your hook returns false.
829
830 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just before the return
831 &$url: the image url
832 &$alt: the image's alt text
833 &$img: the new image HTML (if returning false)
834
835 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
836 &$url: the link url
837 &$text: the link text
838 &$link: the new link HTML (if returning false)
839
840 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
841 &$linksUpdate: the LinkUpdate object
842
843 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
844 &$linksUpdate: the LinkUpdate object
845
846 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
847 &$linksUpdate: the LinkUpdate object
848
849 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
850
851 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
852
853 'LocalFile::getHistory': called before file history query performed
854 $file: the file
855 $tables: tables
856 $fields: select fields
857 $conds: conditions
858 $opts: query options
859 $join_conds: JOIN conditions
860
861 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
862 No return data is accepted; this hook is for auditing only.
863 $user: the User object being authenticated against
864 $password: the password being submitted and found wanting
865 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
866
867 'LogLine': Processes a single log entry on Special:Log
868 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
869 database field.
870 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
871 to logging.log_action database field.
872 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
873 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
874 appears to contain anything.
875 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
876 &$revert: string that is displayed in the UI, similar to $comment.
877 $time: timestamp of the log entry (added in 1.12)
878
879 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
880 &$type: array of strings
881
882 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
883 &$typeText: array of strings
884
885 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
886 &$headerText: array of strings
887
888 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
889 &$actionText: array of strings
890
891 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
892 $magicWords: array of strings
893
894 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
895 $variableIDs: array of strings
896
897 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript is executed
898 &$vars: variable (or multiple variables) to be added into the output
899 of Skin::makeVariablesScript
900
901 'MarkPatrolled': before an edit is marked patrolled
902 $rcid: ID of the revision to be marked patrolled
903 $user: the user (object) marking the revision as patrolled
904 $wcOnlySysopsCanPatrol: config setting indicating whether the user
905 needs to be a sysop in order to mark an edit patrolled
906
907 'MarkPatrolledComplete': after an edit is marked patrolled
908 $rcid: ID of the revision marked as patrolled
909 $user: user (object) who marked the edit patrolled
910 $wcOnlySysopsCanPatrol: config setting indicating whether the user
911 must be a sysop to patrol the edit
912
913 'MathAfterTexvc': after texvc is executed when rendering mathematics
914 $mathRenderer: instance of MathRenderer
915 $errmsg: error message, in HTML (string). Nonempty indicates failure
916 of rendering the formula
917
918 'MediaWikiPerformAction': Override MediaWiki::performAction().
919 Use this to do something completely different, after the basic
920 globals have been set up, but before ordinary actions take place.
921 $output: $wgOut
922 $article: $wgArticle
923 $title: $wgTitle
924 $user: $wgUser
925 $request: $wgRequest
926 $this: The $mediawiki object
927
928 'MessagesPreLoad': When loading a message from the database
929 $title: title of the message (string)
930 $message: value (string), change it to the message you want to define
931
932 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
933 Note: this is only run for the Monobook skin. To add items to the toolbox
934 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
935 instead.
936 $tools: array of tools
937
938 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
939 $article: the article edited
940 $rev: the new revision
941 $baseID: the revision ID this was based off, if any
942 $user: the editing user
943
944 'NormalizeMessageKey': Called before the software gets the text of a message
945 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets displayed
946 &$key: the message being looked up. Change this to something else to change what message gets displayed (string)
947 &$useDB: whether or not to look up the message in the database (bool)
948 &$langCode: the language code to get the message for (string) - or -
949 whether to use the content language (true) or site language (false) (bool)
950 &$transform: whether or not to expand variables and templates in the message (bool)
951
952 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
953 &$changeslist: The OldChangesList instance.
954 &$s: HTML of the form "<li>...</li>" containing one RC entry.
955 &$rc: The RecentChange object.
956
957 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
958 Hooks can alter or append to the array of URLs for search & suggestion formats.
959 &$urls: array of associative arrays with Url element attributes
960
961 'OutputPageBeforeHTML': a page has been processed by the parser and
962 the resulting HTML is about to be displayed.
963 $parserOutput: the parserOutput (object) that corresponds to the page
964 $text: the text that will be displayed, in HTML (string)
965
966 'OutputPageCheckLastModified': when checking if the page has been modified since the last visit
967 &$modifiedTimes: array of timestamps, the following keys are set: page, user, epoch
968
969 'OutputPageParserOutput': after adding a parserOutput to $wgOut
970 $out: OutputPage instance (object)
971 $parserOutput: parserOutput instance being added in $out
972
973 'OutputPageMakeCategoryLinks': links are about to be generated for the page's categories.
974 Implementations should return false if they generate the category links, so the default link generation is skipped.
975 $out: OutputPage instance (object)
976 $categories: associative array, keys are category names, values are category types ("normal" or "hidden")
977 $links: array, intended to hold the result. Must be an associative array with category types as keys and arrays of HTML links as values.
978
979 'PageHistoryBeforeList': When a history page list is about to be constructed.
980 $article: the article that the history is loading for
981
982 'PageHistoryLineEnding' : right before the end <li> is added to a history line
983 $row: the revision row for this line
984 $s: the string representing this parsed line
985
986 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed
987 $pager: the pager
988 $queryInfo: the query parameters
989
990 'PageRenderingHash': alter the parser cache option hash key
991 A parser extension which depends on user options should install
992 this hook and append its values to the key.
993 $hash: reference to a hash key string which can be modified
994
995 'ParserAfterStrip': Same as ParserBeforeStrip
996
997 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
998 $parser: Parser object being used
999 $text: text that'll be returned
1000
1001 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1002 $parser: Parser object
1003 $text: text to parse
1004 $stripState: StripState instance being used
1005
1006 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
1007 $parser: parser object
1008 $text: text being parsed
1009 $stripState: stripState used (object)
1010
1011 'ParserBeforeTidy': called before tidy and custom tags replacements
1012 $parser: Parser object being used
1013 $text: actual text
1014
1015 'ParserClearState': called at the end of Parser::clearState()
1016 $parser: Parser object being cleared
1017
1018 'ParserFirstCallInit': called when the parser initialises for the first time
1019 &$parser: Parser object being cleared
1020
1021 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
1022 $parser: Parser object
1023 $varCache: array to store the value in case of multiples calls of the same magic word
1024 $index: index (string) of the magic
1025 $ret: value of the magic word (the hook should set it)
1026
1027 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
1028 $parser: Parser object
1029 $time: actual time (timestamp)
1030
1031 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
1032 $parser: Parser object
1033 $varCache: varaiable cache (array)
1034
1035 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
1036 $parser: Parser object
1037 $limitReport: text that will be included (without comment tags)
1038
1039 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
1040 $title: title object representing the file
1041 $file: file object that will be used to create the image
1042 &$params: 2-D array of parameters
1043
1044 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
1045 $parser: Parser object created
1046
1047 'ParserTestTables': alter the list of tables to duplicate when parser tests
1048 are run. Use when page save hooks require the presence of custom tables
1049 to ensure that tests continue to run properly.
1050 &$tables: array of table names
1051
1052 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1053 my talk page, my contributions" etc).
1054
1055 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1056 &$title: Title object representing the current page
1057
1058 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1059 &$user : User performing the action
1060 $action : Action being performed
1061 &$result : Whether or not the action should be prevented
1062 Change $result and return false to give a definitive answer, otherwise
1063 the built-in rate limiting checks are used, if enabled.
1064
1065 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
1066 $form : PreferencesForm object
1067 &$html : HTML to append to
1068
1069 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1070 AJAX search suggestions. Put results into &$results outparam and return false.
1071 $ns : array of int namespace keys to search in
1072 $search : search term (not guaranteed to be conveniently normalized)
1073 $limit : maximum number of results to return
1074 &$results : out param: array of page names (strings)
1075
1076 'PrefsEmailAudit': called when user changes his email address
1077 $user: User (object) changing his email address
1078 $oldaddr: old email address (string)
1079 $newaddr: new email address (string)
1080
1081 'PrefsPasswordAudit': called when user changes his password
1082 $user: User (object) changing his passoword
1083 $newPass: new password
1084 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1085
1086 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1087 &$obj: RawPage object
1088 &$text: The text that's going to be the output
1089
1090 'RecentChange_save': called at the end of RecenChange::save()
1091 $recentChange: RecentChange object
1092
1093 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
1094 $form: the PreferencesForm
1095 $out: output page to render to, probably $wgOut
1096
1097 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
1098 $form: the PreferencesForm
1099 $user: the User object to load preferences from
1100
1101 'RevisionInsertComplete': called after a revision is inserted into the DB
1102 &$revision: the Revision
1103 $data: the data stored in old_text. The meaning depends on $flags: if external
1104 is set, it's the URL of the revision text in external storage; otherwise,
1105 it's the revision text itself. In either case, if gzip is set, the revision
1106 text is gzipped.
1107 $flags: a comma-delimited list of strings representing the options used. May
1108 include: utf8 (this will always be set for new revisions); gzip; external.
1109
1110 'SavePreferences': called at the end of PreferencesForm::savePreferences;
1111 returning false prevents the preferences from being saved.
1112 $form: the PreferencesForm
1113 $user: the User object to save preferences to
1114 $message: change this to set an error message (ignored if the hook does not return false)
1115 $old: old preferences of the user
1116
1117 'SearchUpdate': Prior to search update completion
1118 $id : Page id
1119 $namespace : Page namespace
1120 $title : Page title
1121 $text : Current text being indexed
1122
1123 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1124 $term : Search term string
1125 &$title : Outparam; set to $title object and return false for a match
1126
1127 'SetupAfterCache': Called in Setup.php, after cache objects are set
1128
1129 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1130 $text: Text being shown
1131 $title: Title of the custom script/stylesheet page
1132 $output: Current OutputPage object
1133
1134 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1135 &$siteNotice: HTML returned as the sitenotice
1136 Return true to allow the normal method of notice selection/rendering to work,
1137 or change the value of $siteNotice and return false to alter it.
1138
1139 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1140 &$siteNotice: HTML sitenotice
1141 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1142
1143 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1144 $skin: Skin object
1145 &$text: bottomScripts Text
1146 Append to $text to add additional text/scripts after the stock bottom scripts.
1147
1148 'SkinAfterContent': Allows extensions to add text after the page content and
1149 article metadata.
1150 &$data: (string) Text to be printed out directly (without parsing)
1151 This hook should work in all skins. Just set the &$data variable to the text
1152 you're going to add.
1153
1154 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1155 $skin: Skin object
1156 &$bar: Sidebar contents
1157 Modify $bar to add or modify sidebar portlets.
1158
1159 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1160 $skin: Skin object
1161 &$subpages: Subpage links HTML
1162 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
1163 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
1164
1165 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
1166 $sktemplate: SkinTemplate object
1167 $content_actions: array of tabs
1168
1169 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
1170 $sktemplate: SkinTemplate object
1171 $nav_urls: array of tabs
1172
1173 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1174 &$content_actions: Content actions
1175 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1176 for an example]
1177
1178 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
1179 &$sktemplate: SkinTemplate object
1180 &$tpl: Template engine object
1181
1182 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1183 $sktemplate: SkinTemplate object
1184 $res: set to true to prevent active tabs
1185
1186 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1187 $out: Css to return
1188
1189 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1190 You can either create your own array, or alter the parameters for the normal one.
1191 &$this: The SkinTemplate instance.
1192 $title: Title instance for the page.
1193 $message: Visible label of tab.
1194 $selected: Whether this is a selected tab.
1195 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1196 &$classes: Array of CSS classes to apply.
1197 &$query: Query string to add to link.
1198 &$text: Link text.
1199 &$result: Complete assoc. array if you want to return true.
1200
1201 'SkinTemplateTabs': called when finished to build the actions tabs
1202 $sktemplate: SkinTemplate object
1203 $content_actions: array of tabs
1204
1205 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1206 $tools: array of tools
1207
1208 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1209 $id: User identifier
1210
1211 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1212 $pager: The UsersPager instance
1213 $query: The query array to be returned
1214
1215 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1216 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1217 $row: Database row object
1218
1219 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1220 $pager: The UsersPager instance
1221 $out: The header HTML
1222
1223 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1224 $pager: The UsersPager instance
1225 $out: The header HTML
1226
1227 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1228 $pager: The UsersPager instance
1229 $query: The query array to be returned
1230
1231 'SpecialMovepageAfterMove': called after moving a page
1232 $movePage: MovePageForm object
1233 $oldTitle: old title (object)
1234 $newTitle: new title (object)
1235
1236 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1237 $list: list (array) of core special pages
1238
1239 'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges
1240 &$extraOpts: array of added items, to which can be added
1241 $opts: FormOptions for this request
1242
1243 'SpecialRecentChangesQuery': called when building sql query for SpecialRecentChanges
1244 &$conds: array of WHERE conditionals for query
1245 &$tables: array of tables to be queried
1246 &$join_conds: join conditions for the tables
1247 $opts: FormOptions for this request
1248
1249 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1250 $title: title object generated from the text entred by the user
1251
1252 'SpecialSearchResults': called before search result display when there are matches
1253 $term: string of search term
1254 &$titleMatches: empty or SearchResultSet object
1255 &$textMatches: empty or SearchResultSet object
1256
1257 'SpecialSearchNoResults': called before search result display when there are no matches
1258 $term: string of search term
1259
1260 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1261 $extTypes: associative array of extensions types
1262
1263 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1264 &$conds: array of WHERE conditionals for query
1265 &$tables: array of tables to be queried
1266 &$join_conds: join conditions for the tables
1267 &$fields: array of query fields
1268
1269 'TitleArrayFromResult': called when creating an TitleArray object from a database result
1270 &$titleArray: set this to an object to override the default object returned
1271 $res: database result used to create the object
1272
1273 'TitleMoveComplete': after moving an article (title)
1274 $old: old title
1275 $nt: new title
1276 $user: user who did the move
1277 $pageid: database ID of the page that's been moved
1278 $redirid: database ID of the created redirect
1279
1280 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1281 $title: title object related to the revision
1282 $rev: revision (object) that will be viewed
1283
1284 'UnknownAction': An unknown "action" has occured (useful for defining
1285 your own actions)
1286 $action: action name
1287 $article: article "acted on"
1288
1289 'UnwatchArticle': before a watch is removed from an article
1290 $user: user watching
1291 $article: article object to be removed
1292
1293 'UnwatchArticle': after a watch is removed from an article
1294 $user: user that was watching
1295 $article: article object removed
1296
1297 'UnwatchArticleComplete': after a watch is removed from an article
1298 $user: user that watched
1299 $article: article object that was watched
1300
1301 'UploadForm:initial': before the upload form is generated
1302 $form: UploadForm object
1303 You might set the member-variables $uploadFormTextTop and
1304 $uploadFormTextAfterSummary to inject text (HTML) either before
1305 or after the editform.
1306
1307 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1308 $form: UploadForm object
1309 Lets you poke at member variables like $mUploadDescription before the
1310 file is saved.
1311
1312 'UploadVerification': additional chances to reject an uploaded file
1313 string $saveName: destination file name
1314 string $tempName: filesystem path to the temporary file for checks
1315 string &$error: output: HTML error to show if upload canceled by returning false
1316
1317 'UploadComplete': Upon completion of a file upload
1318 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1319
1320 'User::mailPasswordInternal': before creation and mailing of a user's new temporary password
1321 $user: the user who sent the message out
1322 $ip: IP of the user who sent the message out
1323 $u: the account whose new password will be set
1324
1325 'UserArrayFromResult': called when creating an UserArray object from a database result
1326 &$userArray: set this to an object to override the default object returned
1327 $res: database result used to create the object
1328
1329 'userCan': To interrupt/advise the "user can do X to Y article" check.
1330 If you want to display an error message, try getUserPermissionsErrors.
1331 $title: Title object being checked against
1332 $user : Current user object
1333 $action: Action being checked
1334 $result: Pointer to result returned if hook returns false. If null is returned,
1335 userCan checks are continued by internal code.
1336
1337 'UserCanSendEmail': To override User::canSendEmail() permission check
1338 $user: User (object) whose permission is being checked
1339 &$canSend: bool set on input, can override on output
1340
1341
1342 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1343 $user: User (object) that'll clear the message
1344
1345 'UserComparePasswords': called when checking passwords, return false to override the default password checks
1346 &$hash: String of the password hash (from the database)
1347 &$password: String of the plaintext password the user entered
1348 &$userId: Integer of the user's ID or Boolean false if the user ID was not supplied
1349 &$result: If the hook returns false, this Boolean value will be checked to determine if the password was valid
1350
1351 'UserCreateForm': change to manipulate the login form
1352 $template: SimpleTemplate instance for the form
1353
1354 'UserCryptPassword': called when hashing a password, return false to implement your own hashing method
1355 &$password: String of the plaintext password to encrypt
1356 &$salt: String of the password salt or Boolean false if no salt is provided
1357 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing method
1358 &$hash: If the hook returns false, this String will be used as the hash
1359
1360 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1361 $user: User to get groups for
1362 &$groups: Current effective groups
1363
1364 'UserGetAllRights': after calculating a list of all available rights
1365 &$rights: Array of rights, which may be added to.
1366
1367 'UserGetEmail': called when getting an user email address
1368 $user: User object
1369 &$email: email, change this to override local email
1370
1371 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1372 $user: User object
1373 &$timestamp: timestamp, change this to override local email authentification timestamp
1374
1375 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1376 &$groups: List of implicit (automatically-assigned) groups
1377
1378 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1379 *&$reservedUsernames: $wgReservedUsernames
1380
1381 'UserGetRights': Called in User::getRights()
1382 $user: User to get rights for
1383 &$rights: Current rights
1384
1385 'UserLoadDefaults': called when loading a default user
1386 $user: user object
1387 $name: user name
1388
1389 'UserLoadFromDatabase': called when loading a user from the database
1390 $user: user object
1391 &$s: database query object
1392
1393 'UserLoadFromSession': called to authenticate users on external/environmental means; occurs before session is loaded
1394 $user: user object being loaded
1395 &$result: set this to a boolean value to abort the normal authentification process
1396
1397 'UserLoadAfterLoadFromSession': called to authenticate users on external/environmental means; occurs after session is loaded
1398 $user: user object being loaded
1399
1400 'UserLoginComplete': after a user has logged in
1401 $user: the user object that was created on login
1402 $inject_html: Any HTML to inject after the "logged in" message.
1403
1404 'UserLoginForm': change to manipulate the login form
1405 $template: SimpleTemplate instance for the form
1406
1407 'UserLogout': before a user logs out
1408 $user: the user object that is about to be logged out
1409
1410 'UserLogoutComplete': after a user has logged out
1411 $user: the user object _after_ logout (won't have name, ID, etc.)
1412 $inject_html: Any HTML to inject after the "logged out" message.
1413 $oldName: name of the user before logout (string)
1414
1415 'UserRights': After a user's group memberships are changed
1416 $user : User object that was changed
1417 $add : Array of strings corresponding to groups added
1418 $remove: Array of strings corresponding to groups removed
1419
1420 'UserrightsChangeableGroups': allows modification of the groups a user may add or remove via Special:UserRights
1421 $userrights : UserrightsPage object
1422 $user : User object of the current user
1423 $addergroups : Array of groups that the user is in
1424 &$groups : Array of groups that can be added or removed. In format of
1425 array(
1426 'add' => array( addablegroups ),
1427 'remove' => array( removablegroups ),
1428 'add-self' => array( addablegroups to self ),
1429 'remove-self' => array( removable groups from self )
1430 )
1431 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1432 $user: user retrieving new talks messages
1433 $talks: array of new talks page(s)
1434
1435 'UserSaveSettings': called when saving user settings
1436 $user: User object
1437
1438 'UserSetCookies': called when setting user cookies
1439 $user: User object
1440 &$session: session array, will be added to $_SESSION
1441 &$cookies: cookies array mapping cookie name to its value
1442
1443 'UserSetEmail': called when changing user email address
1444 $user: User object
1445 &$email: new email, change this to override new email address
1446
1447 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1448 $user: User object
1449 &$timestamp: new timestamp, change this to override local email authentification timestamp
1450
1451 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1452 $toggles: array of toggles to add
1453
1454 'WatchArticle': before a watch is added to an article
1455 $user: user that will watch
1456 $article: article object to be watched
1457
1458 'WatchArticleComplete': after a watch is added to an article
1459 $user: user that watched
1460 $article: article object watched
1461
1462 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1463 $query: $wgQueryPages itself
1464
1465 More hooks might be available but undocumented, you can execute
1466 ./maintenance/findhooks.php to find hidden one.