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