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