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