abe40a7b73462983191bee3165f7c3906d27518b
[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 'AbortAutoAccount': Return false to cancel automated local account creation, where normally authentication against an external auth plugin would be creating a local account.
238 $user: the User object about to be created (read-only, incomplete)
239 &$abortMsg: out parameter: name of error message to be displayed to user
240
241 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
244
245 'AbortDiffCache': Can be used to cancel the caching of a diff
246 &$diffEngine: DifferenceEngine object
247
248 'AbortLogin': Return false to cancel account login.
249 $user: the User object being authenticated against
250 $password: the password being submitted, not yet checked for validity
251 &$retval: a LoginForm class constant to return from authenticateUserData();
252 default is LoginForm::ABORTED. Note that the client may be using
253 a machine API rather than the HTML user interface.
254 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
255
256 'AbortMove': allows to abort moving an article (title)
257 $old: old title
258 $nt: new title
259 $user: user who is doing the move
260 $err: error message
261 $reason: the reason for the move (added in 1.13)
262
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: name of error message to display on abort
266
267 'ActionBeforeFormDisplay': before executing the HTMLForm object
268 $name: name of the action
269 &$form: HTMLForm object
270 $article: Article object
271
272 'ActionModifyFormFields': before creating an HTMLForm object for a page action;
273 allows to change the fields on the form that will be generated
274 $name: name of the action
275 &$fields: HTMLForm descriptor array
276 $article: Article object
277
278 'AddNewAccount': after a user account is created
279 $user: the User object that was created. (Parameter added in 1.7)
280 $byEmail: true when account was created "by email" (added in 1.12)
281
282 'AfterImportPage': When a page import is completed
283 $title: Title under which the revisions were imported
284 $origTitle: Title provided by the XML file
285 $revCount: Number of revisions in the XML file
286 $sRevCount: Number of sucessfully imported revisions
287 $pageInfo: associative array of page information
288
289 'AjaxAddScript': Called in output page just before the initialisation
290 of the javascript ajax engine. The hook is only called when ajax
291 is enabled ( $wgUseAjax = true; ).
292
293 'AlternateEdit': before checking if an user can edit a page and
294 before showing the edit form ( EditPage::edit() ). This is triggered
295 on &action=edit.
296 $EditPage: the EditPage object
297
298 'AlternateUserMailer': Called before mail is sent so that mail could
299 be logged (or something else) instead of using PEAR or SMTP
300 $UserMailer: the EditPage object
301 $headers: Associative array of headers for the email
302 $to: MailAddress object or array
303 $from: From address
304 $subject: Subject of the email
305 $body: Body of the message
306
307 'APIAfterExecute': after calling the execute() method of an API module.
308 Use this to extend core API modules.
309 &$module: Module object
310
311 'APIEditBeforeSave': before saving a page with api.php?action=edit,
312 after processing request parameters. Return false to let the request
313 fail, returning an error message or an <edit result="Failure"> tag
314 if $resultArr was filled.
315 $EditPage : the EditPage object
316 $text : the new text of the article (has yet to be saved)
317 &$resultArr : data in this array will be added to the API result
318
319 'APIGetAllowedParams': use this hook to modify a module's parameters.
320 &$module: Module object
321 &$params: Array of parameters
322
323 'APIGetParamDescription': use this hook to modify a module's parameter
324 descriptions.
325 &$module: Module object
326 &$desc: Array of parameter descriptions
327
328 'APIQueryAfterExecute': after calling the execute() method of an
329 action=query submodule. Use this to extend core API modules.
330 &$module: Module object
331
332 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
333 method of an action=query submodule. Use this to extend core API modules.
334 &$module: Module object
335 &$resultPageSet: ApiPageSet object
336
337 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
338 Every token has an action, which will be used in the intoken parameter
339 and in the output (actiontoken="..."), and a callback function which
340 should return the token, or false if the user isn't allowed to obtain
341 it. The prototype of the callback function is func($pageid, $title)
342 where $pageid is the page ID of the page the token is requested for
343 and $title is the associated Title object. In the hook, just add
344 your callback to the $tokenFunctions array and return true (returning
345 false makes no sense)
346 $tokenFunctions: array(action => callback)
347
348 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
349 Every token has an action, which will be used in the rvtoken parameter
350 and in the output (actiontoken="..."), and a callback function which
351 should return the token, or false if the user isn't allowed to obtain
352 it. The prototype of the callback function is func($pageid, $title, $rev)
353 where $pageid is the page ID of the page associated to the revision the
354 token is requested for, $title the associated Title object and $rev the
355 associated Revision object. In the hook, just add your callback to the
356 $tokenFunctions array and return true (returning false makes no sense)
357 $tokenFunctions: array(action => callback)
358
359 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
360 list=recentchanges.
361 Every token has an action, which will be used in the rctoken parameter
362 and in the output (actiontoken="..."), and a callback function which
363 should return the token, or false if the user isn't allowed to obtain
364 it. The prototype of the callback function is func($pageid, $title, $rc)
365 where $pageid is the page ID of the page associated to the revision the
366 token is requested for, $title the associated Title object and $rc the
367 associated RecentChange object. In the hook, just add your callback to the
368 $tokenFunctions array and return true (returning false makes no sense)
369 $tokenFunctions: array(action => callback)
370
371 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
372 the sites general information.
373 $module: the current ApiQuerySiteInfo module
374 &$results: array of results, add things here
375
376 'APIQueryUsersTokens': use this hook to add custom token to list=users.
377 Every token has an action, which will be used in the ustoken parameter
378 and in the output (actiontoken="..."), and a callback function which
379 should return the token, or false if the user isn't allowed to obtain
380 it. The prototype of the callback function is func($user) where $user
381 is the User object. In the hook, just add your callback to the
382 $tokenFunctions array and return true (returning false makes no sense)
383 $tokenFunctions: array(action => callback)
384
385 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
386 Each service should have its own entry in the $apis array and have a
387 unique name, passed as key for the array that represents the service data.
388 In this data array, the key-value-pair identified by the apiLink key is
389 required.
390 &$apis: array of services
391
392 'ArticleAfterFetchContent': after fetching content of an article from
393 the database
394 $article: the article (object) being loaded from the database
395 $content: the content (string) of the article
396
397 'ArticleConfirmDelete': before writing the confirmation form for article
398 deletion
399 $article: the article (object) being deleted
400 $output: the OutputPage object ($wgOut)
401 &$reason: the reason (string) the article is being deleted
402
403 'ArticleContentOnDiff': before showing the article content below a diff.
404 Use this to change the content in this area or how it is loaded.
405 $diffEngine: the DifferenceEngine
406 $output: the OutputPage object ($wgOut)
407
408 'ArticleDelete': before an article is deleted
409 $article: the WikiPage (object) being deleted
410 $user: the user (object) deleting the article
411 $reason: the reason (string) the article is being deleted
412 $error: if the deletion was prohibited, the (raw HTML) error message to display
413 (added in 1.13)
414
415 'ArticleDeleteComplete': after an article is deleted
416 $article: the WikiPage that was deleted
417 $user: the user that deleted the article
418 $reason: the reason the article was deleted
419 $id: id of the article that was deleted
420
421 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
422 was changed
423 $article: WikiPage (object) of the user talk page
424
425 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
426 article has been changed
427 $article: the WikiPage (object)
428 $editInfo: data holder that includes the parser output ($editInfo->output) for
429 that page after the change
430 $changed: bool for if the page was changed
431
432 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
433 recentchanges table, return false to not delete old entries
434 $article: WikiPage (object) being modified
435
436 'ArticleFromTitle': when creating an article object from a title object using
437 Wiki::articleFromTitle()
438 $title: title (object) used to create the article object
439 $article: article (object) that will be returned
440
441 'ArticleInsertComplete': After a new article is created
442 $article: WikiPage created
443 $user: User creating the article
444 $text: New content
445 $summary: Edit summary/comment
446 $isMinor: Whether or not the edit was marked as minor
447 $isWatch: (No longer used)
448 $section: (No longer used)
449 $flags: Flags passed to Article::doEdit()
450 $revision: New Revision of the article
451
452 'ArticleMergeComplete': after merging to article using Special:Mergehistory
453 $targetTitle: target title (object)
454 $destTitle: destination title (object)
455
456 'ArticlePageDataAfter': after loading data of an article from the database
457 $article: WikiPage (object) whose data were loaded
458 $row: row (object) returned from the database server
459
460 'ArticlePageDataBefore': before loading data of an article from the database
461 $article: WikiPage (object) that data will be loaded
462 $fields: fileds (array) to load from the database
463
464 'ArticlePrepareTextForEdit': called when preparing text to be saved
465 $article: the WikiPage being saved
466 $popts: parser options to be used for pre-save transformation
467
468 'ArticleProtect': before an article is protected
469 $article: the WikiPage being protected
470 $user: the user doing the protection
471 $protect: boolean whether this is a protect or an unprotect
472 $reason: Reason for protect
473 $moveonly: boolean whether this is for move only or not
474
475 'ArticleProtectComplete': after an article is protected
476 $article: the WikiPage that was protected
477 $user: the user who did the protection
478 $protect: boolean whether it was a protect or an unprotect
479 $reason: Reason for protect
480 $moveonly: boolean whether it was for move only or not
481
482 'ArticlePurge': before executing "&action=purge"
483 $article: WikiPage (object) to purge
484
485 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
486 revision of an article
487 &$title: title object of the article
488
489 'ArticleRevisionUndeleted': after an article revision is restored
490 $title: the article title
491 $revision: the revision
492 $oldPageID: the page ID of the revision when archived (may be null)
493
494 'ArticleRollbackComplete': after an article rollback is completed
495 $article: the WikiPage that was edited
496 $user: the user who did the rollback
497 $revision: the revision the page was reverted back to
498 $current: the reverted revision
499
500 'ArticleSave': before an article is saved
501 $article: the WikiPage (object) being saved
502 $user: the user (object) saving the article
503 $text: the new article text
504 $summary: the article summary (comment)
505 $isminor: minor flag
506 $iswatch: watch flag
507 $section: section #
508
509 'ArticleSaveComplete': After an article has been updated
510 $article: WikiPage modified
511 $user: User performing the modification
512 $text: New content
513 $summary: Edit summary/comment
514 $isMinor: Whether or not the edit was marked as minor
515 $isWatch: (No longer used)
516 $section: (No longer used)
517 $flags: Flags passed to Article::doEdit()
518 $revision: New Revision of the article
519 $baseRevId: the rev ID (or false) this edit was based on
520
521 'ArticleUndelete': When one or more revisions of an article are restored
522 $title: Title corresponding to the article restored
523 $create: Whether or not the restoration caused the page to be created
524 (i.e. it didn't exist before)
525 $comment: The comment associated with the undeletion.
526
527 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
528 before the user is redirected back to the page
529 &$article: the article
530 &$sectionanchor: The section anchor link (e.g. "#overview" )
531 &$extraq: Extra query parameters which can be added via hooked functions
532
533 'ArticleViewFooter': After showing the footer section of an ordinary page view
534 $article: Article object
535
536 'ArticleViewHeader': Before the parser cache is about to be tried for article
537 viewing.
538 &$article: the article
539 &$pcache: whether to try the parser cache or not
540 &$outputDone: whether the output for this page finished or not
541
542 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
543 follwed an redirect
544 $article: target article (object)
545
546 'AuthPluginAutoCreate': Called when creating a local account for an user logged
547 in from an external authentication method
548 $user: User object created locally
549
550 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
551 Gives a chance for an extension to set it programattically to a variable class.
552 &$auth: the $wgAuth object, probably a stub
553
554 'AutopromoteCondition': check autopromote condition for user.
555 $type: condition type
556 $args: arguments
557 $user: user
558 $result: result of checking autopromote condition
559
560 'BadImage': When checking against the bad image list
561 $name: Image name being checked
562 &$bad: Whether or not the image is "bad"
563
564 Change $bad and return false to override. If an image is "bad", it is not
565 rendered inline in wiki pages or galleries in category pages.
566
567 'BeforeInitialize': before anything is initialized in performRequestForTitle()
568 &$title: Title being used for request
569 &$article: The associated Article object
570 &$output: OutputPage object
571 &$user: User
572 $request: WebRequest object
573 $mediaWiki: Mediawiki object
574
575 'BeforePageDisplay': Prior to outputting a page
576 &$out: OutputPage object
577 &$skin: Skin object
578
579 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
580 $parser: Parser object
581 $nt: the image title
582 &$time: the image timestamp (use '0' to force a broken thumbnail)
583 &$sha1: image base 36 sha1 (used to specify the file, $nt will be ignored if this is set)
584 &$descQuery: query string to add to thumbnail URL
585
586 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
587 $parser: Parser object
588 $title: title of the template
589 &$skip: skip this template and link it?
590 &$id: the id of the revision being parsed
591
592 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
593 &$parser: Parser object
594 &$ig: ImageGallery object
595
596 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
597 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
598 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
599
600 'BitmapHandlerTransform': before a file is transformed, gives extension the
601 possibility to transform it themselves
602 $handler: BitmapHandler
603 $image: File
604 &$scalerParams: Array with scaler parameters
605 &$mto: null, set to a MediaTransformOutput
606
607 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
608 $block: Block object (which is set to be autoblocking)
609 &$blockIds: Array of block IDs of the autoblock
610
611 'BlockIp': before an IP address or user is blocked
612 $block: the Block object about to be saved
613 $user: the user _doing_ the block (not the one being blocked)
614
615 'BlockIpComplete': after an IP address or user is blocked
616 $block: the Block object that was saved
617 $user: the user who did the block (not the one being blocked)
618
619 'BookInformation': Before information output on Special:Booksources
620 $isbn: ISBN to show information for
621 $output: OutputPage object in use
622
623 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
624 &$namespaces: Array of namespace numbers with corresponding canonical names
625
626 'CategoryPageView': before viewing a categorypage in CategoryPage::view
627 $catpage: CategoryPage instance
628
629 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
630 &$changesList: ChangesList instance.
631 &$articlelink: HTML of link to article (already filled-in).
632 &$s: HTML of row that is being constructed.
633 &$rc: RecentChange instance.
634 $unpatrolled: Whether or not we are showing unpatrolled changes.
635 $watched: Whether or not the change is watched by the user.
636
637 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
638 $collationName: Name of the collation in question
639 &$collationObject: Null. Replace with a subclass of the Collation class that implements
640 the collation given in $collationName.
641
642 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
643 $user: user (object) whose email is being confirmed
644
645 'ContribsPager::getQueryInfo': Before the contributions query is about to run
646 &$pager: Pager object for contributions
647 &queryInfo: The query for the contribs Pager
648
649 'ContributionsLineEnding': Called before a contributions HTML line is finished
650 $page: SpecialPage object for contributions
651 $ret: the HTML line
652 $row: the DB row for this line
653
654 'ContributionsToolLinks': Change tool links above Special:Contributions
655 $id: User identifier
656 $title: User page title
657 &$tools: Array of tool links
658
659 'CustomEditor': When invoking the page editor
660 $article: Article being edited
661 $user: User performing the edit
662
663 Return true to allow the normal editor to be used, or false
664 if implementing a custom editor, e.g. for a special namespace,
665 etc.
666
667 'DatabaseOraclePostInit': Called after initialising an Oracle database
668 &$db: the DatabaseOracle object
669
670 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
671 $text: plaintext string to be output
672 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
673
674 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
675 $title: the diff page title (nullable)
676 &$oldId: the actual old Id to use in the diff
677 &$newId: the actual new Id to use in the diff (0 means current)
678 $old: the ?old= param value from the url
679 $new: the ?new= param value from the url
680
681 'DiffViewHeader': called before diff display
682 $diff: DifferenceEngine object that's calling
683 $oldRev: Revision object of the "old" revision (may be null/invalid)
684 $newRev: Revision object of the "new" revision
685
686 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
687 an article
688 $article: article (object) being viewed
689 $oldid: oldid (int) being viewed
690
691 'DoEditSectionLink': Override the HTML generated for section edit links
692 $skin: Skin object rendering the UI
693 $title: Title object for the title being linked to (may not be the same as
694 $wgTitle, if the section is included from a template)
695 $section: The designation of the section being pointed to, to be included in
696 the link, like "&section=$section"
697 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
698 By default, this is wrapped in the 'editsectionhint' message.
699 &$result: The HTML to return, prefilled with the default plus whatever other
700 changes earlier hooks have made
701 $lang: The language code to use for the link in the wfMsg* functions
702
703 'EditFilter': Perform checks on an edit
704 $editor: Edit form (see includes/EditPage.php)
705 $text: Contents of the edit box
706 $section: Section being edited
707 &$error: Error message to return
708 $summary: Edit summary for page
709
710 'EditFilterMerged': Post-section-merge edit filter
711 $editor: EditPage instance (object)
712 $text: content of the edit box
713 &$error: error message to return
714 $summary: Edit summary for page
715
716 'EditFormPreloadText': Allows population of the edit form when creating
717 new pages
718 &$text: Text to preload with
719 &$title: Title object representing the page being created
720
721 'EditFormInitialText': Allows modifying the edit form when editing existing
722 pages
723 $editPage: EditPage object
724
725 'EditPage::attemptSave': called before an article is
726 saved, that is before Article::doEdit() is called
727 $editpage_Obj: the current EditPage object
728
729 'EditPage::importFormData': allow extensions to read additional data
730 posted in the form
731 $editpage: EditPage instance
732 $request: Webrequest
733 return value is ignored (should always return true)
734
735 'EditPage::showEditForm:fields': allows injection of form field into edit form
736 &$editor: the EditPage instance for reference
737 &$out: an OutputPage instance to write to
738 return value is ignored (should always return true)
739
740 'EditPage::showEditForm:initial': before showing the edit form
741 $editor: EditPage instance (object)
742 $formCallback: Array for callback of modifying the edit form
743
744 Return false to halt editing; you'll need to handle error messages, etc.
745 yourself. Alternatively, modifying $error and returning true will cause the
746 contents of $error to be echoed at the top of the edit form as wikitext.
747 Return true without altering $error to allow the edit to proceed.
748
749 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
750 when there's an edit conflict. Return false to halt normal diff output; in
751 this case you're responsible for computing and outputting the entire "conflict"
752 part, i.e., the "difference between revisions" and "your text" headers and
753 sections.
754 &$editor: EditPage instance
755 &$out: OutputPage instance
756
757 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
758 textarea in the edit form
759 &$editpage: The current EditPage object
760 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
761 &$tabindex: HTML tabindex of the last edit check/button
762
763 'EditPageBeforeEditChecks': allows modifying the edit checks below the
764 textarea in the edit form
765 &$editpage: The current EditPage object
766 &$checks: Array of edit checks like "watch this page"/"minor edit"
767 &$tabindex: HTML tabindex of the last edit check/button
768
769 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
770 textarea in the edit form
771 &$toolbar: The toolbar HTMl
772
773 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
774 $title: title of page being edited
775 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
776
777 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
778 "Show changes"
779 $editPage: EditPage object
780 &$newtext: wikitext that will be used as "your version"
781
782 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
783 $editPage: EditPage object
784 &$toparse: wikitext that will be parsed
785
786 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
787 &$editpage: The current EditPage object
788 &$res: the HTML of the error text
789
790 'EditPageTosSummary': Give a chance for site and per-namespace customizations
791 of terms of service summary link that might exist separately from the copyright
792 notice.
793 $title: title of page being edited
794 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
795
796 'EditSectionLink': Do not use, use DoEditSectionLink instead.
797 $skin: Skin rendering the UI
798 $title: Title being linked to
799 $section: Section to link to
800 $link: Default link
801 &$result: Result (alter this to override the generated links)
802 $lang: The language code to use for the link in the wfMsg* functions
803
804 'EmailConfirmed': When checking that the user's email address is "confirmed"
805 $user: User being checked
806 $confirmed: Whether or not the email address is confirmed
807 This runs before the other checks, such as anonymity and the real check; return
808 true to allow those checks to occur, and false if checking is done.
809
810 'EmailUser': before sending email from one user to another
811 $to: address of receiving user
812 $from: address of sending user
813 $subject: subject of the mail
814 $text: text of the mail
815
816 'EmailUserCC': before sending the copy of the email to the author
817 $to: address of receiving user
818 $from: address of sending user
819 $subject: subject of the mail
820 $text: text of the mail
821
822 'EmailUserComplete': after sending email from one user to another
823 $to: address of receiving user
824 $from: address of sending user
825 $subject: subject of the mail
826 $text: text of the mail
827
828 'EmailUserForm': after building the email user form object
829 $form: HTMLForm object
830
831 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
832 $user: The user who is trying to email another user.
833 $editToken: The user's edit token.
834 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
835
836 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
837 &$extTypes: associative array of extensions types
838
839 'FetchChangesList': When fetching the ChangesList derivative for
840 a particular user
841 $user: User the list is being fetched for
842 &$skin: Skin object to be used with the list
843 &$list: List object (defaults to NULL, change it to an object
844 instance and return false override the list derivative used)
845
846 'FileDeleteComplete': When a file is deleted
847 $file: reference to the deleted file
848 $oldimage: in case of the deletion of an old image, the name of the old file
849 $article: in case all revisions of the file are deleted a reference to the
850 article associated with the file.
851 $user: user who performed the deletion
852 $reason: reason
853
854 'FileUpload': When a file upload occurs
855 $file : Image object representing the file that was uploaded
856 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
857 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
858
859 'FileUndeleteComplete': When a file is undeleted
860 $title: title object to the file
861 $fileVersions: array of undeleted versions. Empty if all versions were restored
862 $user: user who performed the undeletion
863 $reason: reason
864
865 'GetAutoPromoteGroups': When determining which autopromote groups a user
866 is entitled to be in.
867 &$user: user to promote.
868 &$promote: groups that will be added.
869
870 'GetBlockedStatus': after loading blocking status of an user from the database
871 $user: user (object) being checked
872
873 'GetCacheVaryCookies': get cookies that should vary cache options
874 $out: OutputPage object
875 &$cookies: array of cookies name, add a value to it if you want to add a cookie
876 that have to vary cache options
877
878 'GetDefaultSortkey': Override the default sortkey for a page.
879 $title: Title object that we need to get a sortkey for
880 &$sortkey: Sortkey to use.
881
882 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
883 $title: Title object of page
884 $url: string value as output (out parameter, can modify)
885 $query: query options passed to Title::getFullURL()
886
887 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
888 $title: Title object of page
889 $url: string value as output (out parameter, can modify)
890 $query: query options passed to Title::getInternalURL()
891
892 'GetIP': modify the ip of the current user (called only once)
893 &$ip: string holding the ip as determined so far
894
895 'GetLinkColours': modify the CSS class of an array of page links
896 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
897 indexed by page_id.
898 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
899
900 'GetLocalURL': modify local URLs as output into page links
901 $title: Title object of page
902 $url: string value as output (out parameter, can modify)
903 $query: query options passed to Title::getLocalURL()
904
905 'GetMetadataVersion': modify the image metadata version currently in use. This is
906 used when requesting image metadata from a ForiegnApiRepo. Media handlers
907 that need to have versioned metadata should add an element to the end of
908 the version array of the form 'handler_name=version'. Most media handlers
909 won't need to do this unless they broke backwards compatibility with a
910 previous version of the media handler metadata output.
911 &$version: Array of version strings
912
913 'GetPreferences': modify user preferences
914 $user: User whose preferences are being modified.
915 &$preferences: Preferences description array, to be fed to an HTMLForm object
916
917 'getUserPermissionsErrors': Add a permissions error when permissions errors are
918 checked for. Use instead of userCan for most cases. Return false if the
919 user can't do it, and populate $result with the reason in the form of
920 array( messagename, param1, param2, ... ). For consistency, error messages
921 should be plain text with no special coloring, bolding, etc. to show that
922 they're errors; presenting them properly to the user as errors is done by
923 the caller.
924 $title: Title object being checked against
925 $user : Current user object
926 $action: Action being checked
927 $result: User permissions error to add. If none, return true.
928
929 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
930 if expensive checks are enabled.
931
932 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
933 image insertion. You can skip the default logic entirely by returning
934 false, or just modify a few things using call-by-reference.
935 &$skin: Skin object
936 &$title: Title object of the image
937 &$file: File object, or false if it doesn't exist
938 &$frameParams: Various parameters with special meanings; see documentation in
939 includes/Linker.php for Linker::makeImageLink2
940 &$handlerParams: Various parameters with special meanings; see documentation in
941 includes/Linker.php for Linker::makeImageLink2
942 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
943 &$res: Final HTML output, used if you return false
944
945
946 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
947 the image on an image page
948 $imagePage: ImagePage object ($this)
949 $output: $wgOut
950
951 'ImagePageAfterImageLinks': called after the image links section on an image
952 page is built
953 $imagePage: ImagePage object ($this)
954 &$html: HTML for the hook to add
955
956 'ImagePageFileHistoryLine': called when a file history line is contructed
957 $file: the file
958 $line: the HTML of the history line
959 $css: the line CSS class
960
961 'ImagePageFindFile': called when fetching the file associated with an image page
962 $page: ImagePage object
963 &$file: File object
964 &$displayFile: displayed File object
965
966 'ImagePageShowTOC': called when the file toc on an image page is generated
967 $page: ImagePage object
968 &$toc: Array of <li> strings
969
970 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
971 using img_auth.php
972 &$title: the Title object of the file as it would appear for the upload page
973 &$path: the original file and path name when img_auth was invoked by the the web
974 server
975 &$name: the name only component of the file
976 &$result: The location to pass back results of the hook routine (only used if
977 failed)
978 $result[0]=The index of the header message
979 $result[1]=The index of the body text message
980 $result[2 through n]=Parameters passed to body text message. Please note the
981 header message cannot receive/use parameters.
982
983 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
984 $reader: XMLReader object
985 $logInfo: Array of information
986 Return false to stop further processing of the tag
987
988 'ImportHandlePageXMLTag': When parsing a XML tag in a page
989 $reader: XMLReader object
990 $pageInfo: Array of information
991 Return false to stop further processing of the tag
992
993 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
994 $reader: XMLReader object
995 $revInfo: Array of information
996 Return false to stop further processing of the tag
997
998 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
999 $reader: XMLReader object
1000 Return false to stop further processing of the tag
1001
1002 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
1003 $reader: XMLReader object
1004 $revisionInfo: Array of information
1005 Return false to stop further processing of the tag
1006
1007 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
1008 $title: Title object ($wgTitle)
1009 $request: WebRequest
1010 $ignoreRedirect: boolean to skip redirect check
1011 $target: Title/string of redirect target
1012 $article: Article object
1013
1014 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1015 Return true without providing an interwiki to continue interwiki search.
1016 $prefix: interwiki prefix we are looking for.
1017 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1018 iw_trans and optionally iw_api and iw_wikiid.
1019
1020 'InternalParseBeforeLinks': during Parser's internalParse method before links
1021 but after noinclude/includeonly/onlyinclude and other processing.
1022 &$parser: Parser object
1023 &$text: string containing partially parsed text
1024 &$stripState: Parser's internal StripState object
1025
1026 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1027 $user: user (object) whose email is being invalidated
1028
1029 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1030 $article: article (object) being checked
1031
1032 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1033 $ip: IP being check
1034 $result: Change this value to override the result of wfIsTrustedProxy()
1035
1036 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1037 tance to return false if the domain name doesn't match your organization
1038 $addr: The e-mail address entered by the user
1039 &$result: Set this and return false to override the internal checks
1040
1041 'isValidPassword': Override the result of User::isValidPassword()
1042 $password: The password entered by the user
1043 &$result: Set this and return false to override the internal checks
1044 $user: User the password is being validated for
1045
1046 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1047 $wgExtensionMessagesFiles instead.
1048 Use this to define synonyms of magic words depending of the language
1049 $magicExtensions: associative array of magic words synonyms
1050 $lang: laguage code (string)
1051
1052 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1053 listed in $wgExtensionMessagesFiles instead.
1054 Use to define aliases of special pages names depending of the language
1055 $specialPageAliases: associative array of magic words synonyms
1056 $lang: laguage code (string)
1057
1058 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1059 &$names: array of language code => language name
1060 $code language of the preferred translations
1061
1062 'LinkBegin': Used when generating internal and interwiki links in
1063 Linker::link(), before processing starts. Return false to skip default proces-
1064 sing and return $ret. See documentation for Linker::link() for details on the
1065 expected meanings of parameters.
1066 $skin: the Skin object
1067 $target: the Title that the link is pointing to
1068 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1069 fault"
1070 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1071 tive array form, with keys and values unescaped. Should be merged with de-
1072 fault values, with a value of false meaning to suppress the attribute.
1073 &$query: the query string to add to the generated URL (the bit after the "?"),
1074 in associative array form, with keys and values unescaped.
1075 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1076 &$ret: the value to return if your hook returns false.
1077
1078 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1079 just before the function returns a value. If you return true, an <a> element
1080 with HTML attributes $attribs and contents $html will be returned. If you re-
1081 turn false, $ret will be returned.
1082 $skin: the Skin object
1083 $target: the Title object that the link is pointing to
1084 $options: the options. Will always include either 'known' or 'broken', and may
1085 include 'noclasses'.
1086 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1087 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1088 ciative array form.
1089 &$ret: the value to return if your hook returns false.
1090
1091 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1092 before the return
1093 &$url: the image url
1094 &$alt: the image's alt text
1095 &$img: the new image HTML (if returning false)
1096
1097 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1098 before the return
1099 &$url: the link url
1100 &$text: the link text
1101 &$link: the new link HTML (if returning false)
1102 &$attribs: the attributes to be applied.
1103 $linkType: The external link type
1104
1105 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1106 actual update
1107 &$linksUpdate: the LinksUpdate object
1108
1109 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1110 completed
1111 &$linksUpdate: the LinksUpdate object
1112
1113 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1114 &$linksUpdate: the LinksUpdate object
1115
1116 'ListDefinedTags': When trying to find all defined tags.
1117 &$tags: The list of tags.
1118
1119 'LoadExtensionSchemaUpdates': called during database installation and updates
1120 &updater: A DatabaseUpdater subclass
1121
1122 'LocalFile::getHistory': called before file history query performed
1123 $file: the file
1124 $tables: tables
1125 $fields: select fields
1126 $conds: conditions
1127 $opts: query options
1128 $join_conds: JOIN conditions
1129
1130 'LocalisationCacheRecache': Called when loading the localisation data into cache
1131 $cache: The LocalisationCache object
1132 $code: language code
1133 &$alldata: The localisation data from core and extensions
1134
1135 'LoginAuthenticateAudit': a login attempt for a valid user account either
1136 succeeded or failed. No return data is accepted; this hook is for auditing only.
1137 $user: the User object being authenticated against
1138 $password: the password being submitted and found wanting
1139 $retval: a LoginForm class constant with authenticateUserData() return
1140 value (SUCCESS, WRONG_PASS, etc)
1141
1142 'LogLine': Processes a single log entry on Special:Log
1143 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1144 logging.log_type database field.
1145 $log_action: string for the type of log action (e.g. 'delete', 'block',
1146 'create2'). Corresponds to logging.log_action database field.
1147 $title: Title object that corresponds to logging.log_namespace and
1148 logging.log_title database fields.
1149 $paramArray: Array of parameters that corresponds to logging.log_params field.
1150 Note that only $paramArray[0] appears to contain anything.
1151 &$comment: string that corresponds to logging.log_comment database field, and
1152 which is displayed in the UI.
1153 &$revert: string that is displayed in the UI, similar to $comment.
1154 $time: timestamp of the log entry (added in 1.12)
1155
1156 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1157 $refreshLinks: RefreshLinks object
1158
1159 'MagicWordMagicWords': When defining new magic word.
1160 DEPRECATED: use $magicWords in a file listed in
1161 $wgExtensionMessagesFiles instead.
1162 $magicWords: array of strings
1163
1164 'MagicWordwgVariableIDs': When definig new magic words IDs.
1165 $variableIDs: array of strings
1166
1167 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1168 is executed. Ideally, this hook should only be used to add variables that
1169 depend on the current page/request; static configuration should be added
1170 through ResourceLoaderGetConfigVars instead.
1171 &$vars: variable (or multiple variables) to be added into the output
1172 of Skin::makeVariablesScript
1173
1174 'MarkPatrolled': before an edit is marked patrolled
1175 $rcid: ID of the revision to be marked patrolled
1176 $user: the user (object) marking the revision as patrolled
1177 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1178 needs to be a sysop in order to mark an edit patrolled
1179
1180 'MarkPatrolledComplete': after an edit is marked patrolled
1181 $rcid: ID of the revision marked as patrolled
1182 $user: user (object) who marked the edit patrolled
1183 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1184 must be a sysop to patrol the edit
1185
1186 'MediaWikiPerformAction': Override MediaWiki::performAction().
1187 Use this to do something completely different, after the basic
1188 globals have been set up, but before ordinary actions take place.
1189 $output: $wgOut
1190 $article: $wgArticle
1191 $title: $wgTitle
1192 $user: $wgUser
1193 $request: $wgRequest
1194 $mediaWiki: The $mediawiki object
1195
1196 'MessagesPreLoad': When loading a message from the database
1197 $title: title of the message (string)
1198 $message: value (string), change it to the message you want to define
1199
1200 'MessageCacheReplace': When a message page is changed.
1201 Useful for updating caches.
1202 $title: name of the page changed.
1203 $text: new contents of the page.
1204
1205 'ModifyExportQuery': Modify the query used by the exporter.
1206 $db: The database object to be queried.
1207 &$tables: Tables in the query.
1208 &$conds: Conditions in the query.
1209 &$opts: Options for the query.
1210 &$join_conds: Join conditions for the query.
1211
1212 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1213 been rendered (useful for adding more)
1214 Note: this is only run for the Monobook skin. This hook is deprecated and
1215 may be removed in the future. To add items to the toolbox you should use
1216 the SkinTemplateToolboxEnd hook instead, which works for all
1217 "SkinTemplate"-type skins.
1218 $tools: array of tools
1219
1220 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1221 and returning it for the skin to output. You can add items to the toolbox while
1222 still letting the skin make final decisions on skin-specific markup conventions
1223 using this hook.
1224 &$sk: The BaseTemplate base skin template
1225 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1226 BaseTemplate::makeListItem for details on the format of individual
1227 items inside of this array
1228
1229 'NewRevisionFromEditComplete': called when a revision was inserted
1230 due to an edit
1231 $article: the WikiPage edited
1232 $rev: the new revision
1233 $baseID: the revision ID this was based off, if any
1234 $user: the editing user
1235
1236 'NormalizeMessageKey': Called before the software gets the text of a message
1237 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1238 displayed
1239 &$key: the message being looked up. Change this to something else to change
1240 what message gets displayed (string)
1241 &$useDB: whether or not to look up the message in the database (bool)
1242 &$langCode: the language code to get the message for (string) - or -
1243 whether to use the content language (true) or site language (false) (bool)
1244 &$transform: whether or not to expand variables and templates
1245 in the message (bool)
1246
1247 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1248 &$changeslist: The OldChangesList instance.
1249 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1250 &$rc: The RecentChange object.
1251
1252 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1253 Hooks can alter or append to the array of URLs for search & suggestion formats.
1254 &$urls: array of associative arrays with Url element attributes
1255
1256 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1257 users and/or IP addresses too
1258 $otherBlockLink: An array with links to other block logs
1259 $ip: The requested IP address or username
1260
1261 'OutputPageBeforeHTML': a page has been processed by the parser and
1262 the resulting HTML is about to be displayed.
1263 $parserOutput: the parserOutput (object) that corresponds to the page
1264 $text: the text that will be displayed, in HTML (string)
1265
1266 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1267 tag to allow for extensions to add attributes to the body of the page they might
1268 need. Or to allow building extensions to add body classes that aren't of high
1269 enough demand to be included in core.
1270 $out: The OutputPage which called the hook, can be used to get the real title
1271 $sk: The Skin that called OutputPage::headElement
1272 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1273
1274 'OutputPageCheckLastModified': when checking if the page has been modified
1275 since the last visit
1276 &$modifiedTimes: array of timestamps.
1277 The following keys are set: page, user, epoch
1278
1279 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1280 $out: OutputPage instance (object)
1281 $parserOutput: parserOutput instance being added in $out
1282
1283 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1284 categories. Implementations should return false if they generate the category
1285 links, so the default link generation is skipped.
1286 $out: OutputPage instance (object)
1287 $categories: associative array, keys are category names, values are category
1288 types ("normal" or "hidden")
1289 $links: array, intended to hold the result. Must be an associative array with
1290 category types as keys and arrays of HTML links as values.
1291
1292 'PageHistoryBeforeList': When a history page list is about to be constructed.
1293 $article: the article that the history is loading for
1294
1295 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1296 $row: the revision row for this line
1297 $s: the string representing this parsed line
1298 $classes: array containing the <li> element classes
1299
1300 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1301 is constructed
1302 $pager: the pager
1303 $queryInfo: the query parameters
1304
1305 'PageRenderingHash': alter the parser cache option hash key
1306 A parser extension which depends on user options should install
1307 this hook and append its values to the key.
1308 $hash: reference to a hash key string which can be modified
1309
1310 'ParserAfterStrip': Same as ParserBeforeStrip
1311
1312 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1313 $parser: Parser object being used
1314 $text: text that'll be returned
1315
1316 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1317 $parser: Parser object
1318 $text: text to parse
1319 $stripState: StripState instance being used
1320
1321 'ParserBeforeStrip': Called at start of parsing time
1322 (no more strip, deprecated ?)
1323 $parser: parser object
1324 $text: text being parsed
1325 $stripState: stripState used (object)
1326
1327 'ParserBeforeTidy': called before tidy and custom tags replacements
1328 $parser: Parser object being used
1329 $text: actual text
1330
1331 'ParserClearState': called at the end of Parser::clearState()
1332 $parser: Parser object being cleared
1333
1334 'ParserFirstCallInit': called when the parser initialises for the first time
1335 &$parser: Parser object being cleared
1336
1337 'ParserGetVariableValueSwitch': called when the parser need the value of a
1338 custom magic word
1339 $parser: Parser object
1340 $varCache: array to store the value in case of multiples calls of the
1341 same magic word
1342 $index: index (string) of the magic
1343 $ret: value of the magic word (the hook should set it)
1344 $frame: PPFrame object to use for expanding any template variables
1345
1346 'ParserGetVariableValueTs': use this to change the value of the time for the
1347 {{LOCAL...}} magic word
1348 $parser: Parser object
1349 $time: actual time (timestamp)
1350
1351 'ParserGetVariableValueVarCache': use this to change the value of the
1352 variable cache or return false to not use it
1353 $parser: Parser object
1354 $varCache: varaiable cache (array)
1355
1356 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1357 include comments about size of the text parsed
1358 $parser: Parser object
1359 $limitReport: text that will be included (without comment tags)
1360
1361 'ParserMakeImageParams': Called before the parser make an image link, use this
1362 to modify the parameters of the image.
1363 $title: title object representing the file
1364 $file: file object that will be used to create the image
1365 &$params: 2-D array of parameters
1366
1367 'ParserSectionCreate': Called each time the parser creates a document section
1368 from wikitext. Use this to apply per-section modifications to HTML (like
1369 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1370 can begin in one section and end in another. Make sure your code can handle
1371 that case gracefully. See the EditSectionClearerLink extension for an
1372 example.
1373 $this: the calling Parser instance
1374 $section: the section number, zero-based, but section 0 is usually empty
1375 &$sectionContent: ref to the content of the section. modify this.
1376 $showEditLinks: boolean describing whether this section has an edit link
1377
1378 'ParserTestParser': called when creating a new instance of Parser in
1379 maintenance/parserTests.inc
1380 $parser: Parser object created
1381
1382 'ParserTestTables': alter the list of tables to duplicate when parser tests
1383 are run. Use when page save hooks require the presence of custom tables
1384 to ensure that tests continue to run properly.
1385 &$tables: array of table names
1386
1387 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1388 my talk page, my contributions" etc).
1389
1390 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1391 &$title: Title object representing the current page
1392
1393 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1394 &$user : User performing the action
1395 $action : Action being performed
1396 &$result : Whether or not the action should be prevented
1397 Change $result and return false to give a definitive answer, otherwise
1398 the built-in rate limiting checks are used, if enabled.
1399
1400 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1401 AJAX search suggestions. Put results into &$results outparam and return false.
1402 $ns : array of int namespace keys to search in
1403 $search : search term (not guaranteed to be conveniently normalized)
1404 $limit : maximum number of results to return
1405 &$results : out param: array of page names (strings)
1406
1407 'PrefsEmailAudit': called when user changes his email address
1408 $user: User (object) changing his email address
1409 $oldaddr: old email address (string)
1410 $newaddr: new email address (string)
1411
1412 'PrefsPasswordAudit': called when user changes his password
1413 $user: User (object) changing his passoword
1414 $newPass: new password
1415 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1416
1417 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1418 $article: the title being (un)protected
1419 $output: a string of the form HTML so far
1420
1421 'ProtectionForm::save': called when a protection form is submitted
1422 $article: the title being (un)protected
1423 $errorMsg: an html message string of an error
1424
1425 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1426 $article: the page the form is shown for
1427 $out: OutputPage object
1428
1429 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1430 loader request or generating HTML output.
1431 &$resourceLoader: ResourceLoader object
1432
1433 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1434 to add modules to the startup module. This hook should be used sparingly since any module added here
1435 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1436 scripts.
1437
1438 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1439 &$obj: RawPage object
1440 &$text: The text that's going to be the output
1441
1442 'RecentChange_save': called at the end of RecentChange::save()
1443 $recentChange: RecentChange object
1444
1445 'ResourceLoaderGetConfigVars': called at the end of
1446 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1447 configuration variables to JavaScript. Things that depend on the current
1448 page/request state must be added through MakeGlobalVariablesScript instead.
1449 &$vars: array( variable name => value )
1450
1451 'RevisionInsertComplete': called after a revision is inserted into the DB
1452 &$revision: the Revision
1453 $data: the data stored in old_text. The meaning depends on $flags: if external
1454 is set, it's the URL of the revision text in external storage; otherwise,
1455 it's the revision text itself. In either case, if gzip is set, the revision
1456 text is gzipped.
1457 $flags: a comma-delimited list of strings representing the options used. May
1458 include: utf8 (this will always be set for new revisions); gzip; external.
1459
1460 'SearchUpdate': Prior to search update completion
1461 $id : Page id
1462 $namespace : Page namespace
1463 $title : Page title
1464 $text : Current text being indexed
1465
1466 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1467 $allSearchTerms : Array of the search terms in all content languages
1468 &$titleResult : Outparam; the value to return. A Title object or null.
1469
1470 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1471 $term : Search term string
1472 &$title : Outparam; set to $title object and return false for a match
1473
1474 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1475 $term : Search term string
1476 &$title : Current Title object that is being returned (null if none found).
1477
1478 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1479 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1480 in the $searchEngine->namespaces array.
1481 $query : Original query.
1482 &$parsed : Resultant query with the prefixes stripped.
1483
1484 'SearchableNamespaces': An option to modify which namespaces are searchable.
1485 &$arr : Array of namespaces ($nsId => $name) which will be used.
1486
1487 'SetupAfterCache': Called in Setup.php, after cache objects are set
1488
1489 'ShowMissingArticle': Called when generating the output for a non-existent page
1490 $article: The article object corresponding to the page
1491
1492 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1493 $text: Text being shown
1494 $title: Title of the custom script/stylesheet page
1495 $output: Current OutputPage object
1496
1497 'ShowSearchHitTitle': Customise display of search hit title/link.
1498 &$title: Title to link to
1499 &$text: Text to use for the link
1500 $result: The search result
1501 $terms: The search terms entered
1502 $page: The SpecialSearch object.
1503
1504 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1505 &$siteNotice: HTML returned as the sitenotice
1506 $skin: Skin object
1507 Return true to allow the normal method of notice selection/rendering to work,
1508 or change the value of $siteNotice and return false to alter it.
1509
1510 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1511 &$siteNotice: HTML sitenotice
1512 $skin: Skin object
1513 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1514
1515 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1516 $skin: Skin object
1517 &$text: bottomScripts Text
1518 Append to $text to add additional text/scripts after the stock bottom scripts.
1519
1520 'SkinAfterContent': Allows extensions to add text after the page content and
1521 article metadata.
1522 &$data: (string) Text to be printed out directly (without parsing)
1523 $skin: Skin object
1524 This hook should work in all skins. Just set the &$data variable to the text
1525 you're going to add.
1526
1527 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1528 $skin: Skin object
1529 &$bar: Sidebar contents
1530 Modify $bar to add or modify sidebar portlets.
1531
1532 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1533 $title: displayed page title
1534 $type: 'normal' or 'history' for old/diff views
1535 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1536 &$link: overridable HTML link to be passed into the message as $1
1537 &$forContent: overridable flag if copyright footer is shown in content language.
1538
1539 'SkinGetPoweredBy'
1540 &$text: additional 'powered by' icons in HTML.
1541 Note: Modern skin does not use the MediaWiki icon but plain text instead
1542 $skin: Skin object
1543
1544 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1545 &$subpages: Subpage links HTML
1546 $skin: Skin object
1547 $out: OutputPage object
1548 If false is returned $subpages will be used instead of the HTML
1549 subPageSubtitle() generates.
1550 If true is returned, $subpages will be ignored and the rest of
1551 subPageSubtitle() will run.
1552
1553 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1554 "permanent link" tab
1555 $sktemplate: SkinTemplate object
1556 $nav_urls: array of tabs
1557
1558 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1559 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1560 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1561 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1562 &$sktemplate: SkinTemplate object
1563 &$links: Structured navigation links
1564 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1565
1566 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1567 starts page output
1568 &$sktemplate: SkinTemplate object
1569 &$tpl: Template engine object
1570
1571 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1572 $sktemplate: SkinTemplate object
1573 $res: set to true to prevent active tabs
1574
1575 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1576 You can either create your own array, or alter the parameters for
1577 the normal one.
1578 &$sktemplate: The SkinTemplate instance.
1579 $title: Title instance for the page.
1580 $message: Visible label of tab.
1581 $selected: Whether this is a selected tab.
1582 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1583 &$classes: Array of CSS classes to apply.
1584 &$query: Query string to add to link.
1585 &$text: Link text.
1586 &$result: Complete assoc. array if you want to return true.
1587
1588 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1589 been rendered (useful for adding more)
1590 $sk: The QuickTemplate based skin template running the hook.
1591
1592 'SoftwareInfo': Called by Special:Version for returning information about
1593 the software
1594 $software: The array of software in format 'name' => 'version'.
1595 See SpecialVersion::softwareInformation()
1596
1597 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1598 $id: User identifier
1599
1600 'SpecialListusersDefaultQuery': called right before the end of
1601 UsersPager::getDefaultQuery()
1602 $pager: The UsersPager instance
1603 $query: The query array to be returned
1604
1605 'SpecialListusersFormatRow': called right before the end of
1606 UsersPager::formatRow()
1607 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1608 $row: Database row object
1609
1610 'SpecialListusersHeader': called before closing the <fieldset> in
1611 UsersPager::getPageHeader()
1612 $pager: The UsersPager instance
1613 $out: The header HTML
1614
1615 'SpecialListusersHeaderForm': called before adding the submit button in
1616 UsersPager::getPageHeader()
1617 $pager: The UsersPager instance
1618 $out: The header HTML
1619
1620 'SpecialListusersQueryInfo': called right before the end of
1621 UsersPager::getQueryInfo()
1622 $pager: The UsersPager instance
1623 $query: The query array to be returned
1624
1625 'SpecialMovepageAfterMove': called after moving a page
1626 $movePage: MovePageForm object
1627 $oldTitle: old title (object)
1628 $newTitle: new title (object)
1629
1630 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1631 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1632 $opts: FormOptions object containing special page options
1633 &$conds: array of WHERE conditionals for query
1634 &tables: array of tables to be queried
1635 &$fields: array of columns to select
1636 &$join_conds: join conditions for the tables
1637
1638 'SpecialNewPagesFilters': called after building form options at NewPages
1639 $special: the special page object
1640 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1641 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1642
1643 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1644 hook to remove a core special page
1645 $list: list (array) of core special pages
1646
1647 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1648 $users: array of User objects
1649 $data: array of data submitted by the user
1650 &$error: string, error code (message name) used to describe to error (out paramater).
1651 The hook needs to return false when setting this, otherwise it will have no effect.
1652
1653 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1654 use this to change some selection criteria or substitute a different title
1655 &$randstr: The random number from wfRandom()
1656 &$isRedir: Boolean, whether to select a redirect or non-redirect
1657 &$namespaces: An array of namespace indexes to get the title from
1658 &$extra: An array of extra SQL statements
1659 &$title: If the hook returns false, a Title object to use instead of the
1660 result from the normal query
1661
1662 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1663 $special: the special page object
1664 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1665 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1666
1667 'SpecialRecentChangesPanel': called when building form options in
1668 SpecialRecentChanges
1669 &$extraOpts: array of added items, to which can be added
1670 $opts: FormOptions for this request
1671
1672 'SpecialRecentChangesQuery': called when building sql query for
1673 SpecialRecentChanges and SpecialRecentChangesLinked
1674 &$conds: array of WHERE conditionals for query
1675 &$tables: array of tables to be queried
1676 &$join_conds: join conditions for the tables
1677 $opts: FormOptions for this request
1678 &$query_options: array of options for the database request
1679 &$select: Array of columns to select
1680
1681 'SpecialSearchGo': called when user clicked the "Go"
1682 &$title: title object generated from the text entered by the user
1683 &$term: the search term entered by the user
1684
1685 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1686 target doesn't exist
1687 &$title: title object generated from the text entered by the user
1688
1689 'SpecialSearchProfiles': allows modification of search profiles
1690 &$profiles: profiles, which can be modified.
1691
1692 'SpecialSearchProfileForm': allows modification of search profile forms
1693 $search: special page object
1694 &$form: String: form html
1695 $profile: String: current search profile
1696 $term: String: search term
1697 $opts: Array: key => value of hidden options for inclusion in custom forms
1698
1699 'SpecialSearchSetupEngine': allows passing custom data to search engine
1700 $search: special page object
1701 $profile: String: current search profile
1702 $engine: the search engine
1703
1704 'SpecialSearchResults': called before search result display when there
1705 are matches
1706 $term: string of search term
1707 &$titleMatches: empty or SearchResultSet object
1708 &$textMatches: empty or SearchResultSet object
1709
1710 'SpecialSearchNoResults': called before search result display when there are
1711 no matches
1712 $term: string of search term
1713
1714 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1715 &$extraStats: Array to save the new stats
1716 ( $extraStats['<name of statistic>'] => <value>; )
1717
1718 'SpecialUploadComplete': Called after successfully uploading a file from
1719 Special:Upload
1720 $form: The SpecialUpload object
1721
1722 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1723 use this to change the tables headers
1724 $extTypes: associative array of extensions types
1725
1726 'SpecialWatchlistFilters': called after building form options at Watchlist
1727 $special: the special page object
1728 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1729 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1730
1731 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1732 &$conds: array of WHERE conditionals for query
1733 &$tables: array of tables to be queried
1734 &$join_conds: join conditions for the tables
1735 &$fields: array of query fields
1736
1737 'TitleArrayFromResult': called when creating an TitleArray object from a
1738 database result
1739 &$titleArray: set this to an object to override the default object returned
1740 $res: database result used to create the object
1741
1742 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1743 that can be applied.
1744 $title: The title in question.
1745 &$types: The types of protection available.
1746
1747 'TitleMoveComplete': after moving an article (title)
1748 $old: old title
1749 $nt: new title
1750 $user: user who did the move
1751 $pageid: database ID of the page that's been moved
1752 $redirid: database ID of the created redirect
1753
1754 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
1755 PageArchive object has been created but before any further processing is done.
1756 &$archive: PageArchive object
1757 $title: Title object of the page that we're viewing
1758
1759 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
1760 PageArchive object has been created but before any further processing is done.
1761 &$archive: PageArchive object
1762 $title: Title object of the page that we're viewing
1763
1764 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
1765 the site is not in read-only mode, that the Title object is not null and after
1766 a PageArchive object has been constructed but before performing any further
1767 processing.
1768 &$archive: PageArchive object
1769 $title: Title object of the page that we're about to undelete
1770
1771 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1772 $title: title object related to the revision
1773 $rev: revision (object) that will be viewed
1774
1775 'UnknownAction': An unknown "action" has occured (useful for defining
1776 your own actions)
1777 $action: action name
1778 $article: article "acted on"
1779
1780 'UnitTestsList': Called when building a list of files with PHPUnit tests
1781 &$files: list of files
1782
1783 'UnwatchArticle': before a watch is removed from an article
1784 $user: user watching
1785 $article: article object to be removed
1786
1787 'UnwatchArticle': after a watch is removed from an article
1788 $user: user that was watching
1789 $article: article object removed
1790
1791 'UnwatchArticleComplete': after a watch is removed from an article
1792 $user: user that watched
1793 $article: article object that was watched
1794
1795 'UploadForm:initial': before the upload form is generated
1796 $form: UploadForm object
1797 You might set the member-variables $uploadFormTextTop and
1798 $uploadFormTextAfterSummary to inject text (HTML) either before
1799 or after the editform.
1800
1801 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1802 $form: UploadForm object
1803 Lets you poke at member variables like $mUploadDescription before the
1804 file is saved.
1805 Do not use this hook to break upload processing. This will return the user to
1806 a blank form with no error message; use UploadVerification and
1807 UploadVerifyFile instead
1808
1809 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1810 $type: (string) the requested upload type
1811 &$className: the class name of the Upload instance to be created
1812
1813 'UploadComplete': when Upload completes an upload
1814 &$upload: an UploadBase child instance
1815
1816 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1817 assembled
1818 $descriptor: (array) the HTMLForm descriptor
1819
1820 'UploadFormSourceDescriptors': after the standard source inputs have been
1821 added to the descriptor
1822 $descriptor: (array) the HTMLForm descriptor
1823
1824 'UploadVerification': additional chances to reject an uploaded file. Consider
1825 using UploadVerifyFile instead.
1826 string $saveName: destination file name
1827 string $tempName: filesystem path to the temporary file for checks
1828 string &$error: output: message key for message to show if upload canceled
1829 by returning false. May also be an array, where the first element
1830 is the message key and the remaining elements are used as parameters to
1831 the message.
1832
1833 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1834 in most cases over UploadVerification.
1835 object $upload: an instance of UploadBase, with all info about the upload
1836 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1837 will typically only apply for specific mime types.
1838 object &$error: output: true if the file is valid. Otherwise, an indexed array
1839 representing the problem with the file, where the first element
1840 is the message key and the remaining elements are used as parameters to
1841 the message.
1842
1843 'UploadComplete': Upon completion of a file upload
1844 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1845 $uploadBase->getLocalFile().
1846
1847 'User::mailPasswordInternal': before creation and mailing of a user's new
1848 temporary password
1849 $user: the user who sent the message out
1850 $ip: IP of the user who sent the message out
1851 $u: the account whose new password will be set
1852
1853 'UserAddGroup': called when adding a group; return false to override
1854 stock group addition.
1855 $user: the user object that is to have a group added
1856 &$group: the group to add, can be modified
1857
1858 'UserArrayFromResult': called when creating an UserArray object from a
1859 database result
1860 &$userArray: set this to an object to override the default object returned
1861 $res: database result used to create the object
1862
1863 'userCan': To interrupt/advise the "user can do X to Y article" check.
1864 If you want to display an error message, try getUserPermissionsErrors.
1865 $title: Title object being checked against
1866 $user : Current user object
1867 $action: Action being checked
1868 $result: Pointer to result returned if hook returns false. If null is returned,
1869 userCan checks are continued by internal code.
1870
1871 'UserCanSendEmail': To override User::canSendEmail() permission check
1872 $user: User (object) whose permission is being checked
1873 &$canSend: bool set on input, can override on output
1874
1875 'UserClearNewTalkNotification': called when clearing the
1876 "You have new messages!" message, return false to not delete it
1877 $user: User (object) that'll clear the message
1878
1879 'UserComparePasswords': called when checking passwords, return false to
1880 override the default password checks
1881 &$hash: String of the password hash (from the database)
1882 &$password: String of the plaintext password the user entered
1883 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1884 supplied
1885 &$result: If the hook returns false, this Boolean value will be checked to
1886 determine if the password was valid
1887
1888 'UserCreateForm': change to manipulate the login form
1889 $template: SimpleTemplate instance for the form
1890
1891 'UserCryptPassword': called when hashing a password, return false to implement
1892 your own hashing method
1893 &$password: String of the plaintext password to encrypt
1894 &$salt: String of the password salt or Boolean false if no salt is provided
1895 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1896 hashing method
1897 &$hash: If the hook returns false, this String will be used as the hash
1898
1899 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1900 $user: User to get groups for
1901 &$groups: Current effective groups
1902
1903 'UserGetAllRights': after calculating a list of all available rights
1904 &$rights: Array of rights, which may be added to.
1905
1906 'UserGetEmail': called when getting an user email address
1907 $user: User object
1908 &$email: email, change this to override local email
1909
1910 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1911 email authentification
1912 $user: User object
1913 &$timestamp: timestamp, change this to override local email authentification
1914 timestamp
1915
1916 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1917 &$groups: List of implicit (automatically-assigned) groups
1918
1919 'UserGetLanguageObject': Called when getting user's interface language object
1920 $user: User object
1921 &$code: Langauge code that will be used to create the object
1922
1923 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1924 &$reservedUsernames: $wgReservedUsernames
1925
1926 'UserGetRights': Called in User::getRights()
1927 $user: User to get rights for
1928 &$rights: Current rights
1929
1930 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1931 exemptions).
1932 $user: User in question
1933 $title: Title of the page in question
1934 &$blocked: Out-param, whether or not the user is blocked from that page.
1935 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1936 own user talk pages.
1937
1938 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1939 &$user: User object
1940 $ip: User's IP address
1941 &$blocked: Whether the user is blocked, to be modified by the hook
1942
1943 'UserLoadAfterLoadFromSession': called to authenticate users on
1944 external/environmental means; occurs after session is loaded
1945 $user: user object being loaded
1946
1947 'UserLoadDefaults': called when loading a default user
1948 $user: user object
1949 $name: user name
1950
1951 'UserLoadFromDatabase': called when loading a user from the database
1952 $user: user object
1953 &$s: database query object
1954
1955 'UserLoadFromSession': called to authenticate users on external/environmental
1956 means; occurs before session is loaded
1957 $user: user object being loaded
1958 &$result: set this to a boolean value to abort the normal authentification
1959 process
1960
1961 'UserLoadOptions': when user options/preferences are being loaded from
1962 the database.
1963 $user: User object
1964 &$options: Options, can be modified.
1965
1966 'UserLoginComplete': after a user has logged in
1967 $user: the user object that was created on login
1968 $inject_html: Any HTML to inject after the "logged in" message.
1969
1970 'UserLoginForm': change to manipulate the login form
1971 $template: SimpleTemplate instance for the form
1972
1973 'UserLogout': before a user logs out
1974 $user: the user object that is about to be logged out
1975
1976 'UserLogoutComplete': after a user has logged out
1977 $user: the user object _after_ logout (won't have name, ID, etc.)
1978 $inject_html: Any HTML to inject after the "logged out" message.
1979 $oldName: name of the user before logout (string)
1980
1981 'UserRemoveGroup': called when removing a group; return false to override
1982 stock group removal.
1983 $user: the user object that is to have a group removed
1984 &$group: the group to be removed, can be modified
1985
1986 'UserRights': After a user's group memberships are changed
1987 $user : User object that was changed
1988 $add : Array of strings corresponding to groups added
1989 $remove: Array of strings corresponding to groups removed
1990
1991 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1992 message(s)
1993 $user: user retrieving new talks messages
1994 $talks: array of new talks page(s)
1995
1996 'UserSaveSettings': called when saving user settings
1997 $user: User object
1998
1999 'UserSaveOptions': Called just before saving user preferences/options.
2000 $user: User object
2001 &$options: Options, modifiable
2002
2003 'UserSetCookies': called when setting user cookies
2004 $user: User object
2005 &$session: session array, will be added to $_SESSION
2006 &$cookies: cookies array mapping cookie name to its value
2007
2008 'UserSetEmail': called when changing user email address
2009 $user: User object
2010 &$email: new email, change this to override new email address
2011
2012 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2013 of email authentification
2014 $user: User object
2015 &$timestamp: new timestamp, change this to override local email
2016 authentification timestamp
2017
2018 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2019 used to alter the SQL query which gets the list of wanted pages
2020 &$wantedPages: WantedPagesPage object
2021 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2022
2023 'WatchArticle': before a watch is added to an article
2024 $user: user that will watch
2025 $article: article object to be watched
2026
2027 'WatchArticleComplete': after a watch is added to an article
2028 $user: user that watched
2029 $article: article object watched
2030
2031 'WatchlistEditorBuildRemoveLine': when building remove lines in
2032 Special:Watchlist/edit
2033 &$tools: array of extra links
2034 $title: Title object
2035 $redirect: whether the page is a redirect
2036 $skin: Skin object
2037
2038 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2039 dumps
2040 One, and only one hook should set this, and return false.
2041 &$tables: Database tables to use in the SELECT query
2042 &$opts: Options to use for the query
2043 &$join: Join conditions
2044
2045 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2046 query pages to be updated with maintenance/updateSpecialPages.php
2047 $query: $wgQueryPages itself
2048
2049 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2050 metadata to be added.
2051 $obj: The XmlDumpWriter object.
2052 &$out: The output string.
2053 $row: The database row for the page.
2054 $title: The title of the page.
2055
2056 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2057 metadata.
2058 $obj: The XmlDumpWriter object.
2059 &$out: The text being output.
2060 $row: The database row for the revision.
2061 $text: The revision text.
2062
2063 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2064 additional tags to extract.
2065 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2066
2067 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2068 used to post-process the results.
2069 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2070 metadata tags returned (each tag is either a value, or an array of values).
2071
2072 More hooks might be available but undocumented, you can execute
2073 ./maintenance/findhooks.php to find hidden one.