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