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