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