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