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