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