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