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