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