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