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