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