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