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