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