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