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