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