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