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