Fixes Bug #6793 — “New Variable __NEWSECTIONS__ like __TOC__” by
[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, where normally authentication against an external auth plugin would be creating a local account.
238 $user: the User object about to be created (read-only, incomplete)
239 &$abortMsg: out parameter: name of error message to be displayed to user
240
241 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
244
245 'AbortDiffCache': Can be used to cancel the caching of a diff
246 &$diffEngine: DifferenceEngine object
247
248 'AbortLogin': Return false to cancel account login.
249 $user: the User object being authenticated against
250 $password: the password being submitted, not yet checked for validity
251 &$retval: a LoginForm class constant to return from authenticateUserData();
252 default is LoginForm::ABORTED. Note that the client may be using
253 a machine API rather than the HTML user interface.
254 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
255
256 'AbortMove': allows to abort moving an article (title)
257 $old: old title
258 $nt: new title
259 $user: user who is doing the move
260 $err: error message
261 $reason: the reason for the move (added in 1.13)
262
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: name of error message to display on abort
266
267 'ActionBeforeFormDisplay': before executing the HTMLForm object
268 $name: name of the action
269 &$form: HTMLForm object
270 $article: Article object
271
272 'ActionModifyFormFields': before creating an HTMLForm object for a page action;
273 allows to change the fields on the form that will be generated
274 $name: name of the action
275 &$fields: HTMLForm descriptor array
276 $article: Article object
277
278 'AddNewAccount': after a user account is created
279 $user: the User object that was created. (Parameter added in 1.7)
280 $byEmail: true when account was created "by email" (added in 1.12)
281
282 'AfterImportPage': When a page import is completed
283 $title: Title under which the revisions were imported
284 $origTitle: Title provided by the XML file
285 $revCount: Number of revisions in the XML file
286 $sRevCount: Number of sucessfully imported revisions
287 $pageInfo: associative array of page information
288
289 'AjaxAddScript': Called in output page just before the initialisation
290 of the javascript ajax engine. The hook is only called when ajax
291 is enabled ( $wgUseAjax = true; ).
292
293 'AlternateEdit': before checking if an user can edit a page and
294 before showing the edit form ( EditPage::edit() ). This is triggered
295 on &action=edit.
296 $EditPage: the EditPage object
297
298 'AlternateUserMailer': Called before mail is sent so that mail could
299 be logged (or something else) instead of using PEAR or PHP's mail().
300 Return false to skip the regular method of sending mail. Return a
301 string to return a php-mail-error message containing the error.
302 Returning true will continue with sending email in the regular way.
303 $headers: Associative array of headers for the email
304 $to: MailAddress object or array
305 $from: From address
306 $subject: Subject of the email
307 $body: Body of the message
308
309 'APIAfterExecute': after calling the execute() method of an API module.
310 Use this to extend core API modules.
311 &$module: Module object
312
313 'APIEditBeforeSave': before saving a page with api.php?action=edit,
314 after processing request parameters. Return false to let the request
315 fail, returning an error message or an <edit result="Failure"> tag
316 if $resultArr was filled.
317 $EditPage : the EditPage object
318 $text : the new text of the article (has yet to be saved)
319 &$resultArr : data in this array will be added to the API result
320
321 'APIGetAllowedParams': use this hook to modify a module's parameters.
322 &$module: Module object
323 &$params: Array of parameters
324
325 'APIGetParamDescription': use this hook to modify a module's parameter
326 descriptions.
327 &$module: Module object
328 &$desc: Array of parameter descriptions
329
330 'APIQueryAfterExecute': after calling the execute() method of an
331 action=query submodule. Use this to extend core API modules.
332 &$module: Module object
333
334 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
335 method of an action=query submodule. Use this to extend core API modules.
336 &$module: Module object
337 &$resultPageSet: ApiPageSet object
338
339 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
340 Every token has an action, which will be used in the intoken parameter
341 and in the output (actiontoken="..."), and a callback function which
342 should return the token, or false if the user isn't allowed to obtain
343 it. The prototype of the callback function is func($pageid, $title)
344 where $pageid is the page ID of the page the token is requested for
345 and $title is the associated Title object. In the hook, just add
346 your callback to the $tokenFunctions array and return true (returning
347 false makes no sense)
348 $tokenFunctions: array(action => callback)
349
350 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
351 Every token has an action, which will be used in the rvtoken parameter
352 and in the output (actiontoken="..."), and a callback function which
353 should return the token, or false if the user isn't allowed to obtain
354 it. The prototype of the callback function is func($pageid, $title, $rev)
355 where $pageid is the page ID of the page associated to the revision the
356 token is requested for, $title the associated Title object and $rev the
357 associated Revision object. In the hook, just add your callback to the
358 $tokenFunctions array and return true (returning false makes no sense)
359 $tokenFunctions: array(action => callback)
360
361 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
362 list=recentchanges.
363 Every token has an action, which will be used in the rctoken parameter
364 and in the output (actiontoken="..."), and a callback function which
365 should return the token, or false if the user isn't allowed to obtain
366 it. The prototype of the callback function is func($pageid, $title, $rc)
367 where $pageid is the page ID of the page associated to the revision the
368 token is requested for, $title the associated Title object and $rc the
369 associated RecentChange object. In the hook, just add your callback to the
370 $tokenFunctions array and return true (returning false makes no sense)
371 $tokenFunctions: array(action => callback)
372
373 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
374 the sites general information.
375 $module: the current ApiQuerySiteInfo module
376 &$results: array of results, add things here
377
378 'APIQueryUsersTokens': use this hook to add custom token to list=users.
379 Every token has an action, which will be used in the ustoken parameter
380 and in the output (actiontoken="..."), and a callback function which
381 should return the token, or false if the user isn't allowed to obtain
382 it. The prototype of the callback function is func($user) where $user
383 is the User object. In the hook, just add your callback to the
384 $tokenFunctions array and return true (returning false makes no sense)
385 $tokenFunctions: array(action => callback)
386
387 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
388 Each service should have its own entry in the $apis array and have a
389 unique name, passed as key for the array that represents the service data.
390 In this data array, the key-value-pair identified by the apiLink key is
391 required.
392 &$apis: array of services
393
394 'ArticleAfterFetchContent': after fetching content of an article from
395 the database
396 $article: the article (object) being loaded from the database
397 $content: the content (string) of the article
398
399 'ArticleConfirmDelete': before writing the confirmation form for article
400 deletion
401 $article: the article (object) being deleted
402 $output: the OutputPage object ($wgOut)
403 &$reason: the reason (string) the article is being deleted
404
405 'ArticleContentOnDiff': before showing the article content below a diff.
406 Use this to change the content in this area or how it is loaded.
407 $diffEngine: the DifferenceEngine
408 $output: the OutputPage object ($wgOut)
409
410 'ArticleDelete': before an article is deleted
411 $article: the WikiPage (object) being deleted
412 $user: the user (object) deleting the article
413 $reason: the reason (string) the article is being deleted
414 $error: if the deletion was prohibited, the (raw HTML) error message to display
415 (added in 1.13)
416
417 'ArticleDeleteComplete': after an article is deleted
418 $article: the WikiPage that was deleted
419 $user: the user that deleted the article
420 $reason: the reason the article was deleted
421 $id: id of the article that was deleted
422
423 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
424 was changed
425 $article: WikiPage (object) of the user talk page
426
427 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
428 article has been changed
429 $article: the WikiPage (object)
430 $editInfo: data holder that includes the parser output ($editInfo->output) for
431 that page after the change
432 $changed: bool for if the page was changed
433
434 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
435 recentchanges table, return false to not delete old entries
436 $article: WikiPage (object) being modified
437
438 'ArticleFromTitle': when creating an article object from a title object using
439 Wiki::articleFromTitle()
440 $title: title (object) used to create the article object
441 $article: article (object) that will be returned
442
443 'ArticleInsertComplete': After a new article is created
444 $article: WikiPage created
445 $user: User creating the article
446 $text: New content
447 $summary: Edit summary/comment
448 $isMinor: Whether or not the edit was marked as minor
449 $isWatch: (No longer used)
450 $section: (No longer used)
451 $flags: Flags passed to Article::doEdit()
452 $revision: New Revision of the article
453
454 'ArticleMergeComplete': after merging to article using Special:Mergehistory
455 $targetTitle: target title (object)
456 $destTitle: destination title (object)
457
458 'ArticlePageDataAfter': after loading data of an article from the database
459 $article: WikiPage (object) whose data were loaded
460 $row: row (object) returned from the database server
461
462 'ArticlePageDataBefore': before loading data of an article from the database
463 $article: WikiPage (object) that data will be loaded
464 $fields: fileds (array) to load from the database
465
466 'ArticlePrepareTextForEdit': called when preparing text to be saved
467 $article: the WikiPage being saved
468 $popts: parser options to be used for pre-save transformation
469
470 'ArticleProtect': before an article is protected
471 $article: the WikiPage being protected
472 $user: the user doing the protection
473 $protect: boolean whether this is a protect or an unprotect
474 $reason: Reason for protect
475 $moveonly: boolean whether this is for move only or not
476
477 'ArticleProtectComplete': after an article is protected
478 $article: the WikiPage that was protected
479 $user: the user who did the protection
480 $protect: boolean whether it was a protect or an unprotect
481 $reason: Reason for protect
482 $moveonly: boolean whether it was for move only or not
483
484 'ArticlePurge': before executing "&action=purge"
485 $article: WikiPage (object) to purge
486
487 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
488 revision of an article
489 &$title: title object of the article
490
491 'ArticleRevisionUndeleted': after an article revision is restored
492 $title: the article title
493 $revision: the revision
494 $oldPageID: the page ID of the revision when archived (may be null)
495
496 'ArticleRollbackComplete': after an article rollback is completed
497 $article: the WikiPage that was edited
498 $user: the user who did the rollback
499 $revision: the revision the page was reverted back to
500 $current: the reverted revision
501
502 'ArticleSave': before an article is saved
503 $article: the WikiPage (object) being saved
504 $user: the user (object) saving the article
505 $text: the new article text
506 $summary: the article summary (comment)
507 $isminor: minor flag
508 $iswatch: watch flag
509 $section: section #
510
511 'ArticleSaveComplete': After an article has been updated
512 $article: WikiPage modified
513 $user: User performing the modification
514 $text: New content
515 $summary: Edit summary/comment
516 $isMinor: Whether or not the edit was marked as minor
517 $isWatch: (No longer used)
518 $section: (No longer used)
519 $flags: Flags passed to Article::doEdit()
520 $revision: New Revision of the article
521 $status: Status object about to be returned by doEdit()
522 $baseRevId: the rev ID (or false) this edit was based on
523
524 'ArticleUndelete': When one or more revisions of an article are restored
525 $title: Title corresponding to the article restored
526 $create: Whether or not the restoration caused the page to be created
527 (i.e. it didn't exist before)
528 $comment: The comment associated with the undeletion.
529
530 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
531 before the user is redirected back to the page
532 &$article: the article
533 &$sectionanchor: The section anchor link (e.g. "#overview" )
534 &$extraq: Extra query parameters which can be added via hooked functions
535
536 'ArticleViewFooter': After showing the footer section of an ordinary page view
537 $article: Article object
538
539 'ArticleViewHeader': Before the parser cache is about to be tried for article
540 viewing.
541 &$article: the article
542 &$pcache: whether to try the parser cache or not
543 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
544 object to both indicate that the output is done and what parser output was used.
545
546 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
547 follwed an redirect
548 $article: target article (object)
549
550 'ArticleViewCustom': allows to output the text of the article in a different format than wikitext
551 $text: text of the page
552 $title: title of the page
553 $output: reference to $wgOut
554
555 'AuthPluginAutoCreate': Called when creating a local account for an user logged
556 in from an external authentication method
557 $user: User object created locally
558
559 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
560 Gives a chance for an extension to set it programattically to a variable class.
561 &$auth: the $wgAuth object, probably a stub
562
563 'AutopromoteCondition': check autopromote condition for user.
564 $type: condition type
565 $args: arguments
566 $user: user
567 $result: result of checking autopromote condition
568
569 'BacklinkCacheGetPrefix': allows to set prefix for a spefific link table
570 $table: table name
571 &$prefix: prefix
572
573 'BacklinkCacheGetConditions': allows to set conditions for query when links to certain title
574 are fetched
575 $table: table name
576 $title: title of the page to which backlinks are sought
577 &$conds: query conditions
578
579 'BadImage': When checking against the bad image list
580 $name: Image name being checked
581 &$bad: Whether or not the image is "bad"
582
583 Change $bad and return false to override. If an image is "bad", it is not
584 rendered inline in wiki pages or galleries in category pages.
585
586 'BeforeInitialize': before anything is initialized in performRequestForTitle()
587 &$title: Title being used for request
588 &$article: The associated Article object
589 &$output: OutputPage object
590 &$user: User
591 $request: WebRequest object
592 $mediaWiki: Mediawiki object
593
594 'BeforePageDisplay': Prior to outputting a page
595 &$out: OutputPage object
596 &$skin: Skin object
597
598 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
599 $parser: Parser object
600 $nt: the image title
601 &$options: array of options to RepoGroup::findFile
602 &$descQuery: query string to add to thumbnail URL
603
604 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
605
606 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
607 $parser: Parser object
608 $title: title of the template
609 &$skip: skip this template and link it?
610 &$id: the id of the revision being parsed
611
612 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
613 &$parser: Parser object
614 &$ig: ImageGallery object
615
616 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
617 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
618 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
619
620 'BitmapHandlerTransform': before a file is transformed, gives extension the
621 possibility to transform it themselves
622 $handler: BitmapHandler
623 $image: File
624 &$scalerParams: Array with scaler parameters
625 &$mto: null, set to a MediaTransformOutput
626
627 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
628 $block: Block object (which is set to be autoblocking)
629 &$blockIds: Array of block IDs of the autoblock
630
631 'BlockIp': before an IP address or user is blocked
632 $block: the Block object about to be saved
633 $user: the user _doing_ the block (not the one being blocked)
634
635 'BlockIpComplete': after an IP address or user is blocked
636 $block: the Block object that was saved
637 $user: the user who did the block (not the one being blocked)
638
639 'BookInformation': Before information output on Special:Booksources
640 $isbn: ISBN to show information for
641 $output: OutputPage object in use
642
643 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
644 &$namespaces: Array of namespace numbers with corresponding canonical names
645
646 'CategoryPageView': before viewing a categorypage in CategoryPage::view
647 $catpage: CategoryPage instance
648
649 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
650 &$changesList: ChangesList instance.
651 &$articlelink: HTML of link to article (already filled-in).
652 &$s: HTML of row that is being constructed.
653 &$rc: RecentChange instance.
654 $unpatrolled: Whether or not we are showing unpatrolled changes.
655 $watched: Whether or not the change is watched by the user.
656
657 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
658 $collationName: Name of the collation in question
659 &$collationObject: Null. Replace with a subclass of the Collation class that implements
660 the collation given in $collationName.
661
662 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
663 $user: user (object) whose email is being confirmed
664
665 'ContribsPager::getQueryInfo': Before the contributions query is about to run
666 &$pager: Pager object for contributions
667 &$queryInfo: The query for the contribs Pager
668
669 'ContributionsLineEnding': Called before a contributions HTML line is finished
670 $page: SpecialPage object for contributions
671 $ret: the HTML line
672 $row: the DB row for this line
673
674 'ContributionsToolLinks': Change tool links above Special:Contributions
675 $id: User identifier
676 $title: User page title
677 &$tools: Array of tool links
678
679 'CustomEditor': When invoking the page editor
680 $article: Article being edited
681 $user: User performing the edit
682
683 Return true to allow the normal editor to be used, or false
684 if implementing a custom editor, e.g. for a special namespace,
685 etc.
686
687 'DatabaseOraclePostInit': Called after initialising an Oracle database
688 &$db: the DatabaseOracle object
689
690 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
691 $text: plaintext string to be output
692 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
693
694 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
695 $title: the diff page title (nullable)
696 &$oldId: the actual old Id to use in the diff
697 &$newId: the actual new Id to use in the diff (0 means current)
698 $old: the ?old= param value from the url
699 $new: the ?new= param value from the url
700
701 'DiffViewHeader': called before diff display
702 $diff: DifferenceEngine object that's calling
703 $oldRev: Revision object of the "old" revision (may be null/invalid)
704 $newRev: Revision object of the "new" revision
705
706 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
707 an article
708 $article: article (object) being viewed
709 $oldid: oldid (int) being viewed
710
711 'DoEditSectionLink': Override the HTML generated for section edit links
712 $skin: Skin object rendering the UI
713 $title: Title object for the title being linked to (may not be the same as
714 $wgTitle, if the section is included from a template)
715 $section: The designation of the section being pointed to, to be included in
716 the link, like "&section=$section"
717 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
718 By default, this is wrapped in the 'editsectionhint' message.
719 &$result: The HTML to return, prefilled with the default plus whatever other
720 changes earlier hooks have made
721 $lang: The language code to use for the link in the wfMsg* functions
722
723 'EditFilter': Perform checks on an edit
724 $editor: Edit form (see includes/EditPage.php)
725 $text: Contents of the edit box
726 $section: Section being edited
727 &$error: Error message to return
728 $summary: Edit summary for page
729
730 'EditFilterMerged': Post-section-merge edit filter
731 $editor: EditPage instance (object)
732 $text: content of the edit box
733 &$error: error message to return
734 $summary: Edit summary for page
735
736 'EditFormPreloadText': Allows population of the edit form when creating
737 new pages
738 &$text: Text to preload with
739 &$title: Title object representing the page being created
740
741 'EditFormInitialText': Allows modifying the edit form when editing existing
742 pages
743 $editPage: EditPage object
744
745 'EditPage::attemptSave': called before an article is
746 saved, that is before Article::doEdit() is called
747 $editpage_Obj: the current EditPage object
748
749 'EditPage::importFormData': allow extensions to read additional data
750 posted in the form
751 $editpage: EditPage instance
752 $request: Webrequest
753 return value is ignored (should always return true)
754
755 'EditPage::showEditForm:fields': allows injection of form field into edit form
756 &$editor: the EditPage instance for reference
757 &$out: an OutputPage instance to write to
758 return value is ignored (should always return true)
759
760 'EditPage::showEditForm:initial': before showing the edit form
761 $editor: EditPage instance (object)
762
763 Return false to halt editing; you'll need to handle error messages, etc.
764 yourself. Alternatively, modifying $error and returning true will cause the
765 contents of $error to be echoed at the top of the edit form as wikitext.
766 Return true without altering $error to allow the edit to proceed.
767
768 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
769 when there's an edit conflict. Return false to halt normal diff output; in
770 this case you're responsible for computing and outputting the entire "conflict"
771 part, i.e., the "difference between revisions" and "your text" headers and
772 sections.
773 &$editor: EditPage instance
774 &$out: OutputPage instance
775
776 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
777 textarea in the edit form
778 &$editpage: The current EditPage object
779 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
780 &$tabindex: HTML tabindex of the last edit check/button
781
782 'EditPageBeforeEditChecks': allows modifying the edit checks below the
783 textarea in the edit form
784 &$editpage: The current EditPage object
785 &$checks: Array of edit checks like "watch this page"/"minor edit"
786 &$tabindex: HTML tabindex of the last edit check/button
787
788 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
789 textarea in the edit form
790 &$toolbar: The toolbar HTMl
791
792 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
793 $title: title of page being edited
794 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
795
796 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
797 "Show changes"
798 $editPage: EditPage object
799 &$newtext: wikitext that will be used as "your version"
800
801 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
802 $editPage: EditPage object
803 &$toparse: wikitext that will be parsed
804
805 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
806 &$editpage: The current EditPage object
807 &$res: the HTML of the error text
808
809 'EditPageTosSummary': Give a chance for site and per-namespace customizations
810 of terms of service summary link that might exist separately from the copyright
811 notice.
812 $title: title of page being edited
813 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
814
815 'EditSectionLink': Do not use, use DoEditSectionLink instead.
816 $skin: Skin rendering the UI
817 $title: Title being linked to
818 $section: Section to link to
819 $link: Default link
820 &$result: Result (alter this to override the generated links)
821 $lang: The language code to use for the link in the wfMsg* functions
822
823 'EmailConfirmed': When checking that the user's email address is "confirmed"
824 $user: User being checked
825 $confirmed: Whether or not the email address is confirmed
826 This runs before the other checks, such as anonymity and the real check; return
827 true to allow those checks to occur, and false if checking is done.
828
829 'EmailUser': before sending email from one user to another
830 $to: address of receiving user
831 $from: address of sending user
832 $subject: subject of the mail
833 $text: text of the mail
834
835 'EmailUserCC': before sending the copy of the email to the author
836 $to: address of receiving user
837 $from: address of sending user
838 $subject: subject of the mail
839 $text: text of the mail
840
841 'EmailUserComplete': after sending email from one user to another
842 $to: address of receiving user
843 $from: address of sending user
844 $subject: subject of the mail
845 $text: text of the mail
846
847 'EmailUserForm': after building the email user form object
848 $form: HTMLForm object
849
850 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
851 $user: The user who is trying to email another user.
852 $editToken: The user's edit token.
853 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
854
855 'ExemptFromAccountCreationThrottle': Exemption from the account creation throttle
856 $ip: The ip address of the user
857
858 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
859 &$extTypes: associative array of extensions types
860
861 'FetchChangesList': When fetching the ChangesList derivative for
862 a particular user
863 $user: User the list is being fetched for
864 &$skin: Skin object to be used with the list
865 &$list: List object (defaults to NULL, change it to an object
866 instance and return false override the list derivative used)
867
868 'FileDeleteComplete': When a file is deleted
869 $file: reference to the deleted file
870 $oldimage: in case of the deletion of an old image, the name of the old file
871 $article: in case all revisions of the file are deleted a reference to the
872 article associated with the file.
873 $user: user who performed the deletion
874 $reason: reason
875
876 'FileUpload': When a file upload occurs
877 $file : Image object representing the file that was uploaded
878 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
879 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
880
881 'FileUndeleteComplete': When a file is undeleted
882 $title: title object to the file
883 $fileVersions: array of undeleted versions. Empty if all versions were restored
884 $user: user who performed the undeletion
885 $reason: reason
886
887 'GetAutoPromoteGroups': When determining which autopromote groups a user
888 is entitled to be in.
889 &$user: user to promote.
890 &$promote: groups that will be added.
891
892 'GetBlockedStatus': after loading blocking status of an user from the database
893 $user: user (object) being checked
894
895 'GetCacheVaryCookies': get cookies that should vary cache options
896 $out: OutputPage object
897 &$cookies: array of cookies name, add a value to it if you want to add a cookie
898 that have to vary cache options
899
900 'GetCanonicalURL': modify fully-qualified URLs used for IRC and e-mail notifications
901 $title: Title object of page
902 $url: string value as output (out parameter, can modify)
903 $query: query options passed to Title::getCanonicalURL()
904 $variant: variant passed to Title::getCanonicalURL()
905
906 'GetDefaultSortkey': Override the default sortkey for a page.
907 $title: Title object that we need to get a sortkey for
908 &$sortkey: Sortkey to use.
909
910 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
911 $title: Title object of page
912 $url: string value as output (out parameter, can modify)
913 $query: query options passed to Title::getFullURL()
914 $variant: variant passed to Title::getFullURL()
915
916 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
917 $title: Title object of page
918 $url: string value as output (out parameter, can modify)
919 $query: query options passed to Title::getInternalURL()
920 $variant: variant passed to Title::getFullURL()
921
922 'GetIP': modify the ip of the current user (called only once)
923 &$ip: string holding the ip as determined so far
924
925 'GetLinkColours': modify the CSS class of an array of page links
926 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
927 indexed by page_id.
928 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
929
930 'GetLocalURL': modify local URLs as output into page links. Note that if you
931 are working with internal urls (non-interwiki) then it may be preferable
932 to work with the GetLocalURL::Internal or GetLocalURL::Article hooks as
933 GetLocalURL can be buggy for internal urls on render if you do not
934 re-implement the horrible hack that Title::getLocalURL uses
935 in your own extension.
936 $title: Title object of page
937 &$url: string value as output (out parameter, can modify)
938 $query: query options passed to Title::getLocalURL()
939 $variant: variant passed to Title::getLocalURL()
940
941 'GetLocalURL::Internal': modify local URLs to internal pages.
942 $title: Title object of page
943 &$url: string value as output (out parameter, can modify)
944 $query: query options passed to Title::getLocalURL()
945 $variant: variant passed to Title::getLocalURL()
946
947 'GetLocalURL::Article': modify local URLs specifically pointing to article paths
948 without any fancy queries or variants.
949 $title: Title object of page
950 &$url: string value as output (out parameter, can modify)
951
952 'GetMetadataVersion': modify the image metadata version currently in use. This is
953 used when requesting image metadata from a ForiegnApiRepo. Media handlers
954 that need to have versioned metadata should add an element to the end of
955 the version array of the form 'handler_name=version'. Most media handlers
956 won't need to do this unless they broke backwards compatibility with a
957 previous version of the media handler metadata output.
958 &$version: Array of version strings
959
960 'GetPreferences': modify user preferences
961 $user: User whose preferences are being modified.
962 &$preferences: Preferences description array, to be fed to an HTMLForm object
963
964 'getUserPermissionsErrors': Add a permissions error when permissions errors are
965 checked for. Use instead of userCan for most cases. Return false if the
966 user can't do it, and populate $result with the reason in the form of
967 array( messagename, param1, param2, ... ). For consistency, error messages
968 should be plain text with no special coloring, bolding, etc. to show that
969 they're errors; presenting them properly to the user as errors is done by
970 the caller.
971 $title: Title object being checked against
972 $user : Current user object
973 $action: Action being checked
974 $result: User permissions error to add. If none, return true.
975
976 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
977 if expensive checks are enabled.
978
979 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
980 image insertion. You can skip the default logic entirely by returning
981 false, or just modify a few things using call-by-reference.
982 &$skin: Skin object
983 &$title: Title object of the image
984 &$file: File object, or false if it doesn't exist
985 &$frameParams: Various parameters with special meanings; see documentation in
986 includes/Linker.php for Linker::makeImageLink2
987 &$handlerParams: Various parameters with special meanings; see documentation in
988 includes/Linker.php for Linker::makeImageLink2
989 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
990 &$res: Final HTML output, used if you return false
991
992
993 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
994 the image on an image page
995 $imagePage: ImagePage object ($this)
996 $output: $wgOut
997
998 'ImagePageAfterImageLinks': called after the image links section on an image
999 page is built
1000 $imagePage: ImagePage object ($this)
1001 &$html: HTML for the hook to add
1002
1003 'ImagePageFileHistoryLine': called when a file history line is contructed
1004 $file: the file
1005 $line: the HTML of the history line
1006 $css: the line CSS class
1007
1008 'ImagePageFindFile': called when fetching the file associated with an image page
1009 $page: ImagePage object
1010 &$file: File object
1011 &$displayFile: displayed File object
1012
1013 'ImagePageShowTOC': called when the file toc on an image page is generated
1014 $page: ImagePage object
1015 &$toc: Array of <li> strings
1016
1017 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1018 using img_auth.php
1019 &$title: the Title object of the file as it would appear for the upload page
1020 &$path: the original file and path name when img_auth was invoked by the the web
1021 server
1022 &$name: the name only component of the file
1023 &$result: The location to pass back results of the hook routine (only used if
1024 failed)
1025 $result[0]=The index of the header message
1026 $result[1]=The index of the body text message
1027 $result[2 through n]=Parameters passed to body text message. Please note the
1028 header message cannot receive/use parameters.
1029
1030 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
1031 $reader: XMLReader object
1032 $logInfo: Array of information
1033 Return false to stop further processing of the tag
1034
1035 'ImportHandlePageXMLTag': When parsing a XML tag in a page
1036 $reader: XMLReader object
1037 $pageInfo: Array of information
1038 Return false to stop further processing of the tag
1039
1040 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
1041 $reader: XMLReader object
1042 $revInfo: Array of information
1043 Return false to stop further processing of the tag
1044
1045 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
1046 $reader: XMLReader object
1047 Return false to stop further processing of the tag
1048
1049 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
1050 $reader: XMLReader object
1051 $revisionInfo: Array of information
1052 Return false to stop further processing of the tag
1053
1054 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
1055 $title: Title object ($wgTitle)
1056 $request: WebRequest
1057 $ignoreRedirect: boolean to skip redirect check
1058 $target: Title/string of redirect target
1059 $article: Article object
1060
1061 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1062 Return true without providing an interwiki to continue interwiki search.
1063 $prefix: interwiki prefix we are looking for.
1064 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1065 iw_trans and optionally iw_api and iw_wikiid.
1066
1067 'InternalParseBeforeLinks': during Parser's internalParse method before links
1068 but after noinclude/includeonly/onlyinclude and other processing.
1069 &$parser: Parser object
1070 &$text: string containing partially parsed text
1071 &$stripState: Parser's internal StripState object
1072
1073 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1074 $user: user (object) whose email is being invalidated
1075
1076 'IRCLineURL': When constructing the URL to use in an IRC notification.
1077 Callee may modify $url and $query, URL will be constructed as $url . $query
1078 &$url: URL to index.php
1079 &$query: Query string
1080
1081 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1082 $article: article (object) being checked
1083
1084 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1085 $ip: IP being check
1086 $result: Change this value to override the result of wfIsTrustedProxy()
1087
1088 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1089 tance to return false if the domain name doesn't match your organization
1090 $addr: The e-mail address entered by the user
1091 &$result: Set this and return false to override the internal checks
1092
1093 'isValidPassword': Override the result of User::isValidPassword()
1094 $password: The password entered by the user
1095 &$result: Set this and return false to override the internal checks
1096 $user: User the password is being validated for
1097
1098 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1099 remove namespaces. Do not use this hook to add namespaces. Use
1100 CanonicalNamespaces for that.
1101 &$namespaces: Array of namespaces indexed by their numbers
1102
1103 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1104 $wgExtensionMessagesFiles instead.
1105 Use this to define synonyms of magic words depending of the language
1106 $magicExtensions: associative array of magic words synonyms
1107 $lang: laguage code (string)
1108
1109 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1110 listed in $wgExtensionMessagesFiles instead.
1111 Use to define aliases of special pages names depending of the language
1112 $specialPageAliases: associative array of magic words synonyms
1113 $lang: laguage code (string)
1114
1115 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1116 &$names: array of language code => language name
1117 $code language of the preferred translations
1118
1119 'LinkBegin': Used when generating internal and interwiki links in
1120 Linker::link(), before processing starts. Return false to skip default proces-
1121 sing and return $ret. See documentation for Linker::link() for details on the
1122 expected meanings of parameters.
1123 $skin: the Skin object
1124 $target: the Title that the link is pointing to
1125 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1126 fault"
1127 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1128 tive array form, with keys and values unescaped. Should be merged with de-
1129 fault values, with a value of false meaning to suppress the attribute.
1130 &$query: the query string to add to the generated URL (the bit after the "?"),
1131 in associative array form, with keys and values unescaped.
1132 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1133 &$ret: the value to return if your hook returns false.
1134
1135 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1136 just before the function returns a value. If you return true, an <a> element
1137 with HTML attributes $attribs and contents $html will be returned. If you re-
1138 turn false, $ret will be returned.
1139 $skin: the Skin object
1140 $target: the Title object that the link is pointing to
1141 $options: the options. Will always include either 'known' or 'broken', and may
1142 include 'noclasses'.
1143 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1144 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1145 ciative array form.
1146 &$ret: the value to return if your hook returns false.
1147
1148 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1149 before the return
1150 &$url: the image url
1151 &$alt: the image's alt text
1152 &$img: the new image HTML (if returning false)
1153
1154 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1155 before the return
1156 &$url: the link url
1157 &$text: the link text
1158 &$link: the new link HTML (if returning false)
1159 &$attribs: the attributes to be applied.
1160 $linkType: The external link type
1161
1162 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1163 actual update
1164 &$linksUpdate: the LinksUpdate object
1165
1166 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1167 completed
1168 &$linksUpdate: the LinksUpdate object
1169
1170 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1171 &$linksUpdate: the LinksUpdate object
1172
1173 'ListDefinedTags': When trying to find all defined tags.
1174 &$tags: The list of tags.
1175
1176 'LoadExtensionSchemaUpdates': called during database installation and updates
1177 &updater: A DatabaseUpdater subclass
1178
1179 'LocalFile::getHistory': called before file history query performed
1180 $file: the file
1181 $tables: tables
1182 $fields: select fields
1183 $conds: conditions
1184 $opts: query options
1185 $join_conds: JOIN conditions
1186
1187 'LocalisationCacheRecache': Called when loading the localisation data into cache
1188 $cache: The LocalisationCache object
1189 $code: language code
1190 &$alldata: The localisation data from core and extensions
1191
1192 'LogEventsListShowLogExtract': called before the string is added to OutputPage. Returning false will prevent the string from being added to the OutputPage
1193 &$s: html string to show for the log extract
1194 $types: String or Array Log types to show
1195 $page: String or Title The page title to show log entries for
1196 $user: String The user who made the log entries
1197 $param: Associative Array with the following additional options:
1198 - lim Integer Limit of items to show, default is 50
1199 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1200 - showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty if set to true (default), "No matching items in log" is displayed if loglist is empty
1201 - msgKey Array If you want a nice box with a message, set this to the key of the message. First element is the message key, additional optional elements are parameters for the key that are processed with wgMsgExt and option 'parse'
1202 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset
1203 - wrap String Wrap the message in html (usually something like "&lt;div ...>$1&lt;/div>").
1204 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1205
1206 'LoginAuthenticateAudit': a login attempt for a valid user account either
1207 succeeded or failed. No return data is accepted; this hook is for auditing only.
1208 $user: the User object being authenticated against
1209 $password: the password being submitted and found wanting
1210 $retval: a LoginForm class constant with authenticateUserData() return
1211 value (SUCCESS, WRONG_PASS, etc)
1212
1213 'LogLine': Processes a single log entry on Special:Log
1214 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1215 logging.log_type database field.
1216 $log_action: string for the type of log action (e.g. 'delete', 'block',
1217 'create2'). Corresponds to logging.log_action database field.
1218 $title: Title object that corresponds to logging.log_namespace and
1219 logging.log_title database fields.
1220 $paramArray: Array of parameters that corresponds to logging.log_params field.
1221 Note that only $paramArray[0] appears to contain anything.
1222 &$comment: string that corresponds to logging.log_comment database field, and
1223 which is displayed in the UI.
1224 &$revert: string that is displayed in the UI, similar to $comment.
1225 $time: timestamp of the log entry (added in 1.12)
1226
1227 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1228 $refreshLinks: RefreshLinks object
1229
1230 'MagicWordMagicWords': When defining new magic word.
1231 DEPRECATED: use $magicWords in a file listed in
1232 $wgExtensionMessagesFiles instead.
1233 $magicWords: array of strings
1234
1235 'MagicWordwgVariableIDs': When definig new magic words IDs.
1236 $variableIDs: array of strings
1237
1238 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1239 is executed. Ideally, this hook should only be used to add variables that
1240 depend on the current page/request; static configuration should be added
1241 through ResourceLoaderGetConfigVars instead.
1242 &$vars: variable (or multiple variables) to be added into the output
1243 of Skin::makeVariablesScript
1244 &$out: The OutputPage which called the hook,
1245 can be used to get the real title
1246
1247 'MarkPatrolled': before an edit is marked patrolled
1248 $rcid: ID of the revision to be marked patrolled
1249 $user: the user (object) marking the revision as patrolled
1250 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1251 needs to be a sysop in order to mark an edit patrolled
1252
1253 'MarkPatrolledComplete': after an edit is marked patrolled
1254 $rcid: ID of the revision marked as patrolled
1255 $user: user (object) who marked the edit patrolled
1256 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1257 must be a sysop to patrol the edit
1258
1259 'MediaWikiPerformAction': Override MediaWiki::performAction().
1260 Use this to do something completely different, after the basic
1261 globals have been set up, but before ordinary actions take place.
1262 $output: $wgOut
1263 $article: $wgArticle
1264 $title: $wgTitle
1265 $user: $wgUser
1266 $request: $wgRequest
1267 $mediaWiki: The $mediawiki object
1268
1269 'MessagesPreLoad': When loading a message from the database
1270 $title: title of the message (string)
1271 $message: value (string), change it to the message you want to define
1272
1273 'MessageCacheReplace': When a message page is changed.
1274 Useful for updating caches.
1275 $title: name of the page changed.
1276 $text: new contents of the page.
1277
1278 'ModifyExportQuery': Modify the query used by the exporter.
1279 $db: The database object to be queried.
1280 &$tables: Tables in the query.
1281 &$conds: Conditions in the query.
1282 &$opts: Options for the query.
1283 &$join_conds: Join conditions for the query.
1284
1285 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1286 been rendered (useful for adding more)
1287 Note: this is only run for the Monobook skin. This hook is deprecated and
1288 may be removed in the future. To add items to the toolbox you should use
1289 the SkinTemplateToolboxEnd hook instead, which works for all
1290 "SkinTemplate"-type skins.
1291 $tools: array of tools
1292
1293 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1294 and returning it for the skin to output. You can add items to the toolbox while
1295 still letting the skin make final decisions on skin-specific markup conventions
1296 using this hook.
1297 &$sk: The BaseTemplate base skin template
1298 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1299 BaseTemplate::makeListItem for details on the format of individual
1300 items inside of this array
1301
1302 'NewRevisionFromEditComplete': called when a revision was inserted
1303 due to an edit
1304 $article: the WikiPage edited
1305 $rev: the new revision
1306 $baseID: the revision ID this was based off, if any
1307 $user: the editing user
1308
1309 'NormalizeMessageKey': Called before the software gets the text of a message
1310 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1311 displayed
1312 &$key: the message being looked up. Change this to something else to change
1313 what message gets displayed (string)
1314 &$useDB: whether or not to look up the message in the database (bool)
1315 &$langCode: the language code to get the message for (string) - or -
1316 whether to use the content language (true) or site language (false) (bool)
1317 &$transform: whether or not to expand variables and templates
1318 in the message (bool)
1319
1320 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1321 &$changeslist: The OldChangesList instance.
1322 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1323 &$rc: The RecentChange object.
1324
1325 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1326 Hooks can alter or append to the array of URLs for search & suggestion formats.
1327 &$urls: array of associative arrays with Url element attributes
1328
1329 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1330 users and/or IP addresses too
1331 $otherBlockLink: An array with links to other block logs
1332 $ip: The requested IP address or username
1333
1334 'OutputPageBeforeHTML': a page has been processed by the parser and
1335 the resulting HTML is about to be displayed.
1336 $parserOutput: the parserOutput (object) that corresponds to the page
1337 $text: the text that will be displayed, in HTML (string)
1338
1339 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1340 tag to allow for extensions to add attributes to the body of the page they might
1341 need. Or to allow building extensions to add body classes that aren't of high
1342 enough demand to be included in core.
1343 $out: The OutputPage which called the hook, can be used to get the real title
1344 $sk: The Skin that called OutputPage::headElement
1345 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1346
1347 'OutputPageCheckLastModified': when checking if the page has been modified
1348 since the last visit
1349 &$modifiedTimes: array of timestamps.
1350 The following keys are set: page, user, epoch
1351
1352 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1353 $out: OutputPage instance (object)
1354 $parserOutput: parserOutput instance being added in $out
1355
1356 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1357 categories. Implementations should return false if they generate the category
1358 links, so the default link generation is skipped.
1359 $out: OutputPage instance (object)
1360 $categories: associative array, keys are category names, values are category
1361 types ("normal" or "hidden")
1362 $links: array, intended to hold the result. Must be an associative array with
1363 category types as keys and arrays of HTML links as values.
1364
1365 'PageContentLanguage': allows changing the language in which the content of
1366 a page is written. Defaults to the wiki content language ($wgContLang).
1367 $title: Title object
1368 &$pageLang: the page content language (either an object or a language code)
1369 $wgLang: the user language
1370
1371 'PageHistoryBeforeList': When a history page list is about to be constructed.
1372 $article: the article that the history is loading for
1373
1374 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1375 $row: the revision row for this line
1376 $s: the string representing this parsed line
1377 $classes: array containing the <li> element classes
1378
1379 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1380 is constructed
1381 $pager: the pager
1382 $queryInfo: the query parameters
1383
1384 'PageRenderingHash': alter the parser cache option hash key
1385 A parser extension which depends on user options should install
1386 this hook and append its values to the key.
1387 $hash: reference to a hash key string which can be modified
1388
1389 'ParserAfterStrip': Same as ParserBeforeStrip
1390
1391 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1392 $parser: Parser object being used
1393 $text: text that'll be returned
1394
1395 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1396 $parser: Parser object
1397 $text: text to parse
1398 $stripState: StripState instance being used
1399
1400 'ParserBeforeStrip': Called at start of parsing time
1401 (no more strip, deprecated ?)
1402 $parser: parser object
1403 $text: text being parsed
1404 $stripState: stripState used (object)
1405
1406 'ParserBeforeTidy': called before tidy and custom tags replacements
1407 $parser: Parser object being used
1408 $text: actual text
1409
1410 'ParserClearState': called at the end of Parser::clearState()
1411 $parser: Parser object being cleared
1412
1413 'ParserFirstCallInit': called when the parser initialises for the first time
1414 &$parser: Parser object being cleared
1415
1416 'ParserGetVariableValueSwitch': called when the parser need the value of a
1417 custom magic word
1418 $parser: Parser object
1419 $varCache: array to store the value in case of multiples calls of the
1420 same magic word
1421 $index: index (string) of the magic
1422 $ret: value of the magic word (the hook should set it)
1423 $frame: PPFrame object to use for expanding any template variables
1424
1425 'ParserGetVariableValueTs': use this to change the value of the time for the
1426 {{LOCAL...}} magic word
1427 $parser: Parser object
1428 $time: actual time (timestamp)
1429
1430 'ParserGetVariableValueVarCache': use this to change the value of the
1431 variable cache or return false to not use it
1432 $parser: Parser object
1433 $varCache: varaiable cache (array)
1434
1435 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1436 include comments about size of the text parsed
1437 $parser: Parser object
1438 $limitReport: text that will be included (without comment tags)
1439
1440 'ParserMakeImageParams': Called before the parser make an image link, use this
1441 to modify the parameters of the image.
1442 $title: title object representing the file
1443 $file: file object that will be used to create the image
1444 &$params: 2-D array of parameters
1445
1446 'ParserSectionCreate': Called each time the parser creates a document section
1447 from wikitext. Use this to apply per-section modifications to HTML (like
1448 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1449 can begin in one section and end in another. Make sure your code can handle
1450 that case gracefully. See the EditSectionClearerLink extension for an
1451 example.
1452 $parser: the calling Parser instance
1453 $section: the section number, zero-based, but section 0 is usually empty
1454 &$sectionContent: ref to the content of the section. modify this.
1455 $showEditLinks: boolean describing whether this section has an edit link
1456
1457 'ParserTestParser': called when creating a new instance of Parser in
1458 maintenance/parserTests.inc
1459 $parser: Parser object created
1460
1461 'ParserTestTables': alter the list of tables to duplicate when parser tests
1462 are run. Use when page save hooks require the presence of custom tables
1463 to ensure that tests continue to run properly.
1464 &$tables: array of table names
1465
1466 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1467 my talk page, my contributions" etc).
1468 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1469 &$title: Title object representing the current page
1470
1471 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1472 &$user : User performing the action
1473 $action : Action being performed
1474 &$result : Whether or not the action should be prevented
1475 Change $result and return false to give a definitive answer, otherwise
1476 the built-in rate limiting checks are used, if enabled.
1477
1478 'PlaceNewSection': Override placement of new sections.
1479 $wikipage : WikiPage object
1480 $oldtext : the text of the article before editing
1481 $subject : subject of the new section
1482 &$text : text of the new section
1483 Return false and put the merged text into $text to override the default behavior.
1484
1485 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1486 AJAX search suggestions. Put results into &$results outparam and return false.
1487 $ns : array of int namespace keys to search in
1488 $search : search term (not guaranteed to be conveniently normalized)
1489 $limit : maximum number of results to return
1490 &$results : out param: array of page names (strings)
1491
1492 'PrefsEmailAudit': called when user changes his email address
1493 $user: User (object) changing his email address
1494 $oldaddr: old email address (string)
1495 $newaddr: new email address (string)
1496
1497 'PrefsPasswordAudit': called when user changes his password
1498 $user: User (object) changing his passoword
1499 $newPass: new password
1500 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1501
1502 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1503 $article: the title being (un)protected
1504 $output: a string of the form HTML so far
1505
1506 'ProtectionForm::save': called when a protection form is submitted
1507 $article: the title being (un)protected
1508 $errorMsg: an html message string of an error
1509
1510 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1511 $article: the page the form is shown for
1512 $out: OutputPage object
1513
1514 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1515 &$obj: RawPage object
1516 &$text: The text that's going to be the output
1517
1518 'RecentChange_save': called at the end of RecentChange::save()
1519 $recentChange: RecentChange object
1520
1521 'ResourceLoaderGetConfigVars': called at the end of
1522 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1523 configuration variables to JavaScript. Things that depend on the current
1524 page/request state must be added through MakeGlobalVariablesScript instead.
1525 &$vars: array( variable name => value )
1526
1527 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1528 to add modules to the startup module. This hook should be used sparingly since any module added here
1529 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1530 scripts.
1531
1532 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1533 loader request or generating HTML output.
1534 &$resourceLoader: ResourceLoader object
1535
1536 'RevisionInsertComplete': called after a revision is inserted into the DB
1537 &$revision: the Revision
1538 $data: the data stored in old_text. The meaning depends on $flags: if external
1539 is set, it's the URL of the revision text in external storage; otherwise,
1540 it's the revision text itself. In either case, if gzip is set, the revision
1541 text is gzipped.
1542 $flags: a comma-delimited list of strings representing the options used. May
1543 include: utf8 (this will always be set for new revisions); gzip; external.
1544
1545 'SearchUpdate': Prior to search update completion
1546 $id : Page id
1547 $namespace : Page namespace
1548 $title : Page title
1549 $text : Current text being indexed
1550
1551 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1552 $allSearchTerms : Array of the search terms in all content languages
1553 &$titleResult : Outparam; the value to return. A Title object or null.
1554
1555 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1556 $term : Search term string
1557 &$title : Outparam; set to $title object and return false for a match
1558
1559 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1560 $term : Search term string
1561 &$title : Current Title object that is being returned (null if none found).
1562
1563 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1564 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1565 in the $searchEngine->namespaces array.
1566 $query : Original query.
1567 &$parsed : Resultant query with the prefixes stripped.
1568
1569 'SearchableNamespaces': An option to modify which namespaces are searchable.
1570 &$arr : Array of namespaces ($nsId => $name) which will be used.
1571
1572 'SetupAfterCache': Called in Setup.php, after cache objects are set
1573
1574 'ShowMissingArticle': Called when generating the output for a non-existent page
1575 $article: The article object corresponding to the page
1576
1577 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1578 $text: Text being shown
1579 $title: Title of the custom script/stylesheet page
1580 $output: Current OutputPage object
1581
1582 'ShowSearchHitTitle': Customise display of search hit title/link.
1583 &$title: Title to link to
1584 &$text: Text to use for the link
1585 $result: The search result
1586 $terms: The search terms entered
1587 $page: The SpecialSearch object.
1588
1589 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1590 &$siteNotice: HTML returned as the sitenotice
1591 $skin: Skin object
1592 Return true to allow the normal method of notice selection/rendering to work,
1593 or change the value of $siteNotice and return false to alter it.
1594
1595 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1596 &$siteNotice: HTML sitenotice
1597 $skin: Skin object
1598 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1599
1600 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1601 $skin: Skin object
1602 &$text: bottomScripts Text
1603 Append to $text to add additional text/scripts after the stock bottom scripts.
1604
1605 'SkinAfterContent': Allows extensions to add text after the page content and
1606 article metadata.
1607 &$data: (string) Text to be printed out directly (without parsing)
1608 $skin: Skin object
1609 This hook should work in all skins. Just set the &$data variable to the text
1610 you're going to add.
1611
1612 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1613 $skin: Skin object
1614 &$bar: Sidebar contents
1615 Modify $bar to add or modify sidebar portlets.
1616
1617 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1618 $title: displayed page title
1619 $type: 'normal' or 'history' for old/diff views
1620 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1621 &$link: overridable HTML link to be passed into the message as $1
1622 &$forContent: overridable flag if copyright footer is shown in content language.
1623
1624 'SkinGetPoweredBy'
1625 &$text: additional 'powered by' icons in HTML.
1626 Note: Modern skin does not use the MediaWiki icon but plain text instead
1627 $skin: Skin object
1628
1629 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1630 &$subpages: Subpage links HTML
1631 $skin: Skin object
1632 $out: OutputPage object
1633 If false is returned $subpages will be used instead of the HTML
1634 subPageSubtitle() generates.
1635 If true is returned, $subpages will be ignored and the rest of
1636 subPageSubtitle() will run.
1637
1638 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1639 "permanent link" tab
1640 $sktemplate: SkinTemplate object
1641 $nav_urls: array of tabs
1642
1643 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1644 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1645 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1646 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1647 &$sktemplate: SkinTemplate object
1648 &$links: Structured navigation links
1649 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1650
1651 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1652 starts page output
1653 &$sktemplate: SkinTemplate object
1654 &$tpl: Template engine object
1655
1656 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1657 $sktemplate: SkinTemplate object
1658 $res: set to true to prevent active tabs
1659
1660 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1661 You can either create your own array, or alter the parameters for
1662 the normal one.
1663 &$sktemplate: The SkinTemplate instance.
1664 $title: Title instance for the page.
1665 $message: Visible label of tab.
1666 $selected: Whether this is a selected tab.
1667 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1668 &$classes: Array of CSS classes to apply.
1669 &$query: Query string to add to link.
1670 &$text: Link text.
1671 &$result: Complete assoc. array if you want to return true.
1672
1673 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1674 been rendered (useful for adding more)
1675 $sk: The QuickTemplate based skin template running the hook.
1676 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
1677 extensions that add support for BaseTemplateToolbox should watch for this dummy
1678 parameter with "$dummy=false" in their code and return without echoing any html
1679 to avoid creating duplicate toolbox items.
1680
1681 'SoftwareInfo': Called by Special:Version for returning information about
1682 the software
1683 $software: The array of software in format 'name' => 'version'.
1684 See SpecialVersion::softwareInformation()
1685
1686 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1687 $id: User identifier
1688
1689 'SpecialListusersDefaultQuery': called right before the end of
1690 UsersPager::getDefaultQuery()
1691 $pager: The UsersPager instance
1692 $query: The query array to be returned
1693
1694 'SpecialListusersFormatRow': called right before the end of
1695 UsersPager::formatRow()
1696 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1697 $row: Database row object
1698
1699 'SpecialListusersHeader': called before closing the <fieldset> in
1700 UsersPager::getPageHeader()
1701 $pager: The UsersPager instance
1702 $out: The header HTML
1703
1704 'SpecialListusersHeaderForm': called before adding the submit button in
1705 UsersPager::getPageHeader()
1706 $pager: The UsersPager instance
1707 $out: The header HTML
1708
1709 'SpecialListusersQueryInfo': called right before the end of
1710 UsersPager::getQueryInfo()
1711 $pager: The UsersPager instance
1712 $query: The query array to be returned
1713
1714 'SpecialMovepageAfterMove': called after moving a page
1715 $movePage: MovePageForm object
1716 $oldTitle: old title (object)
1717 $newTitle: new title (object)
1718
1719 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1720 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1721 $opts: FormOptions object containing special page options
1722 &$conds: array of WHERE conditionals for query
1723 &tables: array of tables to be queried
1724 &$fields: array of columns to select
1725 &$join_conds: join conditions for the tables
1726
1727 'SpecialNewPagesFilters': called after building form options at NewPages
1728 $special: the special page object
1729 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1730 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1731
1732 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1733 hook to remove a core special page
1734 $list: list (array) of core special pages
1735
1736 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1737 $users: array of User objects
1738 $data: array of data submitted by the user
1739 &$error: string, error code (message name) used to describe to error (out paramater).
1740 The hook needs to return false when setting this, otherwise it will have no effect.
1741
1742 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1743 use this to change some selection criteria or substitute a different title
1744 &$randstr: The random number from wfRandom()
1745 &$isRedir: Boolean, whether to select a redirect or non-redirect
1746 &$namespaces: An array of namespace indexes to get the title from
1747 &$extra: An array of extra SQL statements
1748 &$title: If the hook returns false, a Title object to use instead of the
1749 result from the normal query
1750
1751 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1752 $special: the special page object
1753 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1754 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1755
1756 'SpecialRecentChangesPanel': called when building form options in
1757 SpecialRecentChanges
1758 &$extraOpts: array of added items, to which can be added
1759 $opts: FormOptions for this request
1760
1761 'SpecialRecentChangesQuery': called when building sql query for
1762 SpecialRecentChanges and SpecialRecentChangesLinked
1763 &$conds: array of WHERE conditionals for query
1764 &$tables: array of tables to be queried
1765 &$join_conds: join conditions for the tables
1766 $opts: FormOptions for this request
1767 &$query_options: array of options for the database request
1768 &$select: Array of columns to select
1769
1770 'SpecialSearchCreateLink': called when making the message to create a page or
1771 go to the existing page
1772 $t: title object searched for
1773 &$params: an array of the default message name and page title (as parameter)
1774
1775 'SpecialSearchGo': called when user clicked the "Go"
1776 &$title: title object generated from the text entered by the user
1777 &$term: the search term entered by the user
1778
1779 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1780 target doesn't exist
1781 &$title: title object generated from the text entered by the user
1782
1783 'SpecialSearchPowerBox': the equivalent of SpecialSearchProfileForm for
1784 the advanced form, a.k.a. power search box
1785 &$showSections: an array to add values with more options to
1786 $term: the search term (not a title object)
1787 $opts: an array of hidden options (containing 'redirs' and 'profile')
1788
1789 'SpecialSearchProfiles': allows modification of search profiles
1790 &$profiles: profiles, which can be modified.
1791
1792 'SpecialSearchProfileForm': allows modification of search profile forms
1793 $search: special page object
1794 &$form: String: form html
1795 $profile: String: current search profile
1796 $term: String: search term
1797 $opts: Array: key => value of hidden options for inclusion in custom forms
1798
1799 'SpecialSearchSetupEngine': allows passing custom data to search engine
1800 $search: special page object
1801 $profile: String: current search profile
1802 $engine: the search engine
1803
1804 'SpecialSearchResults': called before search result display when there
1805 are matches
1806 $term: string of search term
1807 &$titleMatches: empty or SearchResultSet object
1808 &$textMatches: empty or SearchResultSet object
1809
1810 'SpecialSearchNoResults': called before search result display when there are
1811 no matches
1812 $term: string of search term
1813
1814 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1815 &$extraStats: Array to save the new stats
1816 ( $extraStats['<name of statistic>'] => <value>; )
1817
1818 'SpecialUploadComplete': Called after successfully uploading a file from
1819 Special:Upload
1820 $form: The SpecialUpload object
1821
1822 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1823 use this to change the tables headers
1824 $extTypes: associative array of extensions types
1825
1826 'SpecialWatchlistFilters': called after building form options at Watchlist
1827 $special: the special page object
1828 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1829 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1830
1831 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1832 &$conds: array of WHERE conditionals for query
1833 &$tables: array of tables to be queried
1834 &$join_conds: join conditions for the tables
1835 &$fields: array of query fields
1836
1837 'TestCanonicalRedirect': called when about to force a redirect to a canonical URL for a title when we have no other parameters on the URL. Gives a chance for extensions that alter page view behavior radically to abort that redirect or handle it manually.
1838 $request: WebRequest
1839 $title: Title of the currently found title obj
1840 $output: OutputPage object
1841
1842 'TitleArrayFromResult': called when creating an TitleArray object from a
1843 database result
1844 &$titleArray: set this to an object to override the default object returned
1845 $res: database result used to create the object
1846
1847 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1848 that can be applied.
1849 $title: The title in question.
1850 &$types: The types of protection available.
1851
1852 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
1853 $title: Title object that is being checked
1854 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page. Hooks may change this value to override the return value of Title::isCssOrJsPage()
1855
1856 'TitleIsMovable': Called when determining if it is possible to move a page.
1857 Note that this hook is not called for interwiki pages or pages in immovable namespaces: for these, isMovable() always returns false.
1858 $title: Title object that is being checked
1859 $result: Boolean; whether MediaWiki currently thinks this page is movable. Hooks may change this value to override the return value of Title::isMovable()
1860
1861 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
1862 be handled by seperate handler (via ArticleViewCustom)
1863 $title: Title object that is being checked
1864 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page. Hooks may change this value to override the return value of Title::isWikitextPage()
1865
1866 'TitleMoveComplete': after moving an article (title)
1867 $old: old title
1868 $nt: new title
1869 $user: user who did the move
1870 $pageid: database ID of the page that's been moved
1871 $redirid: database ID of the created redirect
1872
1873 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
1874 PageArchive object has been created but before any further processing is done.
1875 &$archive: PageArchive object
1876 $title: Title object of the page that we're viewing
1877
1878 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
1879 PageArchive object has been created but before any further processing is done.
1880 &$archive: PageArchive object
1881 $title: Title object of the page that we're viewing
1882
1883 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
1884 the site is not in read-only mode, that the Title object is not null and after
1885 a PageArchive object has been constructed but before performing any further
1886 processing.
1887 &$archive: PageArchive object
1888 $title: Title object of the page that we're about to undelete
1889
1890 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1891 $title: title object related to the revision
1892 $rev: revision (object) that will be viewed
1893
1894 'UnknownAction': An unknown "action" has occured (useful for defining
1895 your own actions)
1896 $action: action name
1897 $article: article "acted on"
1898
1899 'UnitTestsList': Called when building a list of files with PHPUnit tests
1900 &$files: list of files
1901
1902 'UnwatchArticle': before a watch is removed from an article
1903 $user: user watching
1904 $article: article object to be removed
1905
1906 'UnwatchArticle': after a watch is removed from an article
1907 $user: user that was watching
1908 $article: article object removed
1909
1910 'UnwatchArticleComplete': after a watch is removed from an article
1911 $user: user that watched
1912 $article: article object that was watched
1913
1914 'UploadForm:initial': before the upload form is generated
1915 $form: UploadForm object
1916 You might set the member-variables $uploadFormTextTop and
1917 $uploadFormTextAfterSummary to inject text (HTML) either before
1918 or after the editform.
1919
1920 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1921 $form: UploadForm object
1922 Lets you poke at member variables like $mUploadDescription before the
1923 file is saved.
1924 Do not use this hook to break upload processing. This will return the user to
1925 a blank form with no error message; use UploadVerification and
1926 UploadVerifyFile instead
1927
1928 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1929 $type: (string) the requested upload type
1930 &$className: the class name of the Upload instance to be created
1931
1932 'UploadComplete': when Upload completes an upload
1933 &$upload: an UploadBase child instance
1934
1935 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1936 assembled
1937 $descriptor: (array) the HTMLForm descriptor
1938
1939 'UploadFormSourceDescriptors': after the standard source inputs have been
1940 added to the descriptor
1941 $descriptor: (array) the HTMLForm descriptor
1942
1943 'UploadVerification': additional chances to reject an uploaded file. Consider
1944 using UploadVerifyFile instead.
1945 string $saveName: destination file name
1946 string $tempName: filesystem path to the temporary file for checks
1947 string &$error: output: message key for message to show if upload canceled
1948 by returning false. May also be an array, where the first element
1949 is the message key and the remaining elements are used as parameters to
1950 the message.
1951
1952 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1953 in most cases over UploadVerification.
1954 object $upload: an instance of UploadBase, with all info about the upload
1955 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1956 will typically only apply for specific mime types.
1957 object &$error: output: true if the file is valid. Otherwise, an indexed array
1958 representing the problem with the file, where the first element
1959 is the message key and the remaining elements are used as parameters to
1960 the message.
1961
1962 'UploadComplete': Upon completion of a file upload
1963 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1964 $uploadBase->getLocalFile().
1965
1966 'User::mailPasswordInternal': before creation and mailing of a user's new
1967 temporary password
1968 $user: the user who sent the message out
1969 $ip: IP of the user who sent the message out
1970 $u: the account whose new password will be set
1971
1972 'UserAddGroup': called when adding a group; return false to override
1973 stock group addition.
1974 $user: the user object that is to have a group added
1975 &$group: the group to add, can be modified
1976
1977 'UserArrayFromResult': called when creating an UserArray object from a
1978 database result
1979 &$userArray: set this to an object to override the default object returned
1980 $res: database result used to create the object
1981
1982 'userCan': To interrupt/advise the "user can do X to Y article" check.
1983 If you want to display an error message, try getUserPermissionsErrors.
1984 $title: Title object being checked against
1985 $user : Current user object
1986 $action: Action being checked
1987 $result: Pointer to result returned if hook returns false. If null is returned,
1988 userCan checks are continued by internal code.
1989
1990 'UserCanSendEmail': To override User::canSendEmail() permission check
1991 $user: User (object) whose permission is being checked
1992 &$canSend: bool set on input, can override on output
1993
1994 'UserClearNewTalkNotification': called when clearing the
1995 "You have new messages!" message, return false to not delete it
1996 $user: User (object) that'll clear the message
1997
1998 'UserComparePasswords': called when checking passwords, return false to
1999 override the default password checks
2000 &$hash: String of the password hash (from the database)
2001 &$password: String of the plaintext password the user entered
2002 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2003 supplied
2004 &$result: If the hook returns false, this Boolean value will be checked to
2005 determine if the password was valid
2006
2007 'UserCreateForm': change to manipulate the login form
2008 $template: SimpleTemplate instance for the form
2009
2010 'UserCryptPassword': called when hashing a password, return false to implement
2011 your own hashing method
2012 &$password: String of the plaintext password to encrypt
2013 &$salt: String of the password salt or Boolean false if no salt is provided
2014 &$wgPasswordSalt: Boolean of whether the salt is used in the default
2015 hashing method
2016 &$hash: If the hook returns false, this String will be used as the hash
2017
2018 'UserEffectiveGroups': Called in User::getEffectiveGroups()
2019 $user: User to get groups for
2020 &$groups: Current effective groups
2021
2022 'UserGetAllRights': after calculating a list of all available rights
2023 &$rights: Array of rights, which may be added to.
2024
2025 'UserGetDefaultOptions': after fetching the core default, this hook is ran
2026 right before returning the options to the caller.
2027 &$defaultOptions: Array of preference keys and their default values.
2028
2029 'UserGetEmail': called when getting an user email address
2030 $user: User object
2031 &$email: email, change this to override local email
2032
2033 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
2034 email authentification
2035 $user: User object
2036 &$timestamp: timestamp, change this to override local email authentification
2037 timestamp
2038
2039 'UserGetImplicitGroups': Called in User::getImplicitGroups()
2040 &$groups: List of implicit (automatically-assigned) groups
2041
2042 'UserGetLanguageObject': Called when getting user's interface language object
2043 $user: User object
2044 &$code: Langauge code that will be used to create the object
2045
2046 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
2047 &$reservedUsernames: $wgReservedUsernames
2048
2049 'UserGetRights': Called in User::getRights()
2050 $user: User to get rights for
2051 &$rights: Current rights
2052
2053 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
2054 exemptions).
2055 $user: User in question
2056 $title: Title of the page in question
2057 &$blocked: Out-param, whether or not the user is blocked from that page.
2058 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
2059 own user talk pages.
2060
2061 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2062 &$user: User object
2063 $ip: User's IP address
2064 &$blocked: Whether the user is blocked, to be modified by the hook
2065
2066 'UserLoadAfterLoadFromSession': called to authenticate users on
2067 external/environmental means; occurs after session is loaded
2068 $user: user object being loaded
2069
2070 'UserLoadDefaults': called when loading a default user
2071 $user: user object
2072 $name: user name
2073
2074 'UserLoadFromDatabase': called when loading a user from the database
2075 $user: user object
2076 &$s: database query object
2077
2078 'UserLoadFromSession': called to authenticate users on external/environmental
2079 means; occurs before session is loaded
2080 $user: user object being loaded
2081 &$result: set this to a boolean value to abort the normal authentification
2082 process
2083
2084 'UserLoadOptions': when user options/preferences are being loaded from
2085 the database.
2086 $user: User object
2087 &$options: Options, can be modified.
2088
2089 'UserLoginComplete': after a user has logged in
2090 $user: the user object that was created on login
2091 $inject_html: Any HTML to inject after the "logged in" message.
2092
2093 'UserLoginForm': change to manipulate the login form
2094 $template: SimpleTemplate instance for the form
2095
2096 'UserLogout': before a user logs out
2097 $user: the user object that is about to be logged out
2098
2099 'UserLogoutComplete': after a user has logged out
2100 $user: the user object _after_ logout (won't have name, ID, etc.)
2101 $inject_html: Any HTML to inject after the "logged out" message.
2102 $oldName: name of the user before logout (string)
2103
2104 'UserRemoveGroup': called when removing a group; return false to override
2105 stock group removal.
2106 $user: the user object that is to have a group removed
2107 &$group: the group to be removed, can be modified
2108
2109 'UserRights': After a user's group memberships are changed
2110 $user : User object that was changed
2111 $add : Array of strings corresponding to groups added
2112 $remove: Array of strings corresponding to groups removed
2113
2114 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
2115 message(s)
2116 $user: user retrieving new talks messages
2117 $talks: array of new talks page(s)
2118
2119 'UserSaveSettings': called when saving user settings
2120 $user: User object
2121
2122 'UserSaveOptions': Called just before saving user preferences/options.
2123 $user: User object
2124 &$options: Options, modifiable
2125
2126 'UserSetCookies': called when setting user cookies
2127 $user: User object
2128 &$session: session array, will be added to $_SESSION
2129 &$cookies: cookies array mapping cookie name to its value
2130
2131 'UserSetEmail': called when changing user email address
2132 $user: User object
2133 &$email: new email, change this to override new email address
2134
2135 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2136 of email authentification
2137 $user: User object
2138 &$timestamp: new timestamp, change this to override local email
2139 authentification timestamp
2140
2141 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2142 used to alter the SQL query which gets the list of wanted pages
2143 &$wantedPages: WantedPagesPage object
2144 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2145
2146 'WatchArticle': before a watch is added to an article
2147 $user: user that will watch
2148 $article: article object to be watched
2149
2150 'WatchArticleComplete': after a watch is added to an article
2151 $user: user that watched
2152 $article: article object watched
2153
2154 'WatchlistEditorBuildRemoveLine': when building remove lines in
2155 Special:Watchlist/edit
2156 &$tools: array of extra links
2157 $title: Title object
2158 $redirect: whether the page is a redirect
2159 $skin: Skin object
2160
2161 'WebRequestGetPathInfoRequestURI': while extracting path info from REQUEST_URI.
2162 Allows an extension to extend the extraction of titles from paths.
2163 Implementing hooks should follow the pattern used in core:
2164 * Use the `$matches = WebRequest::extractTitle` pattern
2165 * Ensure that you test `if ( !$matches ) {` before you try extracting a title
2166 from the path so that you don't override an already found match.
2167 $path: The request path to extract a title from.
2168 &$matches: The array to apply matches to.
2169
2170 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2171 dumps
2172 One, and only one hook should set this, and return false.
2173 &$tables: Database tables to use in the SELECT query
2174 &$opts: Options to use for the query
2175 &$join: Join conditions
2176
2177 'wfShellMaintenanceCmd': Called when generating a shell-escaped command line
2178 string to run a maintenance script.
2179 &$script: MediaWiki maintenance script path
2180 &$parameters: Array of arguments and options to the script
2181 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2182 keys
2183
2184 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2185 query pages to be updated with maintenance/updateSpecialPages.php
2186 $query: $wgQueryPages itself
2187
2188 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2189 metadata to be added.
2190 $obj: The XmlDumpWriter object.
2191 &$out: The output string.
2192 $row: The database row for the page.
2193 $title: The title of the page.
2194
2195 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2196 metadata.
2197 $obj: The XmlDumpWriter object.
2198 &$out: The text being output.
2199 $row: The database row for the revision.
2200 $text: The revision text.
2201
2202 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2203 additional tags to extract.
2204 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2205
2206 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2207 used to post-process the results.
2208 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2209 metadata tags returned (each tag is either a value, or an array of values).
2210
2211 More hooks might be available but undocumented, you can execute
2212 ./maintenance/findhooks.php to find hidden one.