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