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