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