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