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