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