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