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