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