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