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