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