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