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