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.
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',
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.
21 The function part of a hook.
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.
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):
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
48 # code to actually show the article goes here
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:
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
66 # code to actually show the article goes here
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
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:
76 function showAnArticle($article) {
78 if (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('ArticleShowComplete', array(&$article));
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.
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
96 function reverseArticleTitle($article) {
100 function reverseForExport($article) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
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.
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:
123 require_once('extensions/ReverseTitle.php');
125 ...to their LocalSettings.php file; those of us who don't want or need it can
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.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
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:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
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
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:
155 someFunction($param1, $param2)
157 someFunction($someData, $param1, $param2)
160 $object->onEventName($param1, $param2)
162 $object->someMethod($param1, $param2)
163 # object with method and data
164 $object->someMethod($someData, $param1, $param2)
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.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
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
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:
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193 function ldapLogin($username, $password) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
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.
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
221 wfRunHooks() 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.
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoAccount': Return false to cancel automated local account creation, where normally authentication against an external auth plugin would be creating a local account.
238 $user: the User object about to be created (read-only, incomplete)
239 &$abortMsg: out parameter: name of error message to be displayed to user
241 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
245 'AbortDiffCache': Can be used to cancel the caching of a diff
246 &$diffEngine: DifferenceEngine object
248 'AbortLogin': Return false to cancel account login.
249 $user: the User object being authenticated against
250 $password: the password being submitted, not yet checked for validity
251 &$retval: a LoginForm class constant to return from authenticateUserData();
252 default is LoginForm::ABORTED. Note that the client may be using
253 a machine API rather than the HTML user interface.
254 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
256 'AbortMove': allows to abort moving an article (title)
259 $user: user who is doing the move
261 $reason: the reason for the move (added in 1.13)
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: name of error message to display on abort
267 'ActionBeforeFormDisplay': before executing the HTMLForm object
268 $name: name of the action
269 &$form: HTMLForm object
270 $article: Article object
272 'ActionModifyFormFields': before creating an HTMLForm object for a page action;
273 allows to change the fields on the form that will be generated
274 $name: name of the action
275 &$fields: HTMLForm descriptor array
276 $article: Article object
278 'AddNewAccount': after a user account is created
279 $user: the User object that was created. (Parameter added in 1.7)
280 $byEmail: true when account was created "by email" (added in 1.12)
282 'AfterImportPage': When a page import is completed
283 $title: Title under which the revisions were imported
284 $origTitle: Title provided by the XML file
285 $revCount: Number of revisions in the XML file
286 $sRevCount: Number of sucessfully imported revisions
287 $pageInfo: associative array of page information
289 'AjaxAddScript': Called in output page just before the initialisation
290 of the javascript ajax engine. The hook is only called when ajax
291 is enabled ( $wgUseAjax = true; ).
293 'AlternateEdit': before checking if an user can edit a page and
294 before showing the edit form ( EditPage::edit() ). This is triggered
296 $EditPage: the EditPage object
298 'AlternateUserMailer': Called before mail is sent so that mail could
299 be logged (or something else) instead of using PEAR or PHP's mail().
300 Return false to skip the regular method of sending mail. Return a
301 string to return a php-mail-error message containing the error.
302 Returning true will continue with sending email in the regular way.
303 $headers: Associative array of headers for the email
304 $to: MailAddress object or array
306 $subject: Subject of the email
307 $body: Body of the message
309 'APIAfterExecute': after calling the execute() method of an API module.
310 Use this to extend core API modules.
311 &$module: Module object
313 'APIEditBeforeSave': before saving a page with api.php?action=edit,
314 after processing request parameters. Return false to let the request
315 fail, returning an error message or an <edit result="Failure"> tag
316 if $resultArr was filled.
317 $EditPage : the EditPage object
318 $text : the new text of the article (has yet to be saved)
319 &$resultArr : data in this array will be added to the API result
321 'APIGetAllowedParams': use this hook to modify a module's parameters.
322 &$module: Module object
323 &$params: Array of parameters
325 'APIGetParamDescription': use this hook to modify a module's parameter
327 &$module: Module object
328 &$desc: Array of parameter descriptions
330 'APIQueryAfterExecute': after calling the execute() method of an
331 action=query submodule. Use this to extend core API modules.
332 &$module: Module object
334 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
335 method of an action=query submodule. Use this to extend core API modules.
336 &$module: Module object
337 &$resultPageSet: ApiPageSet object
339 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
340 Every token has an action, which will be used in the intoken parameter
341 and in the output (actiontoken="..."), and a callback function which
342 should return the token, or false if the user isn't allowed to obtain
343 it. The prototype of the callback function is func($pageid, $title)
344 where $pageid is the page ID of the page the token is requested for
345 and $title is the associated Title object. In the hook, just add
346 your callback to the $tokenFunctions array and return true (returning
347 false makes no sense)
348 $tokenFunctions: array(action => callback)
350 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
351 Every token has an action, which will be used in the rvtoken parameter
352 and in the output (actiontoken="..."), and a callback function which
353 should return the token, or false if the user isn't allowed to obtain
354 it. The prototype of the callback function is func($pageid, $title, $rev)
355 where $pageid is the page ID of the page associated to the revision the
356 token is requested for, $title the associated Title object and $rev the
357 associated Revision object. In the hook, just add your callback to the
358 $tokenFunctions array and return true (returning false makes no sense)
359 $tokenFunctions: array(action => callback)
361 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
363 Every token has an action, which will be used in the rctoken parameter
364 and in the output (actiontoken="..."), and a callback function which
365 should return the token, or false if the user isn't allowed to obtain
366 it. The prototype of the callback function is func($pageid, $title, $rc)
367 where $pageid is the page ID of the page associated to the revision the
368 token is requested for, $title the associated Title object and $rc the
369 associated RecentChange object. In the hook, just add your callback to the
370 $tokenFunctions array and return true (returning false makes no sense)
371 $tokenFunctions: array(action => callback)
373 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
374 the sites general information.
375 $module: the current ApiQuerySiteInfo module
376 &$results: array of results, add things here
378 'APIQueryUsersTokens': use this hook to add custom token to list=users.
379 Every token has an action, which will be used in the ustoken parameter
380 and in the output (actiontoken="..."), and a callback function which
381 should return the token, or false if the user isn't allowed to obtain
382 it. The prototype of the callback function is func($user) where $user
383 is the User object. In the hook, just add your callback to the
384 $tokenFunctions array and return true (returning false makes no sense)
385 $tokenFunctions: array(action => callback)
387 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
388 Each service should have its own entry in the $apis array and have a
389 unique name, passed as key for the array that represents the service data.
390 In this data array, the key-value-pair identified by the apiLink key is
392 &$apis: array of services
394 'ArticleAfterFetchContent': after fetching content of an article from
396 $article: the article (object) being loaded from the database
397 $content: the content (string) of the article
399 'ArticleConfirmDelete': before writing the confirmation form for article
401 $article: the article (object) being deleted
402 $output: the OutputPage object ($wgOut)
403 &$reason: the reason (string) the article is being deleted
405 'ArticleContentOnDiff': before showing the article content below a diff.
406 Use this to change the content in this area or how it is loaded.
407 $diffEngine: the DifferenceEngine
408 $output: the OutputPage object ($wgOut)
410 'ArticleDelete': before an article is deleted
411 $article: the WikiPage (object) being deleted
412 $user: the user (object) deleting the article
413 $reason: the reason (string) the article is being deleted
414 $error: if the deletion was prohibited, the (raw HTML) error message to display
417 'ArticleDeleteComplete': after an article is deleted
418 $article: the WikiPage that was deleted
419 $user: the user that deleted the article
420 $reason: the reason the article was deleted
421 $id: id of the article that was deleted
423 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
425 $article: WikiPage (object) of the user talk page
427 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
428 article has been changed
429 $article: the WikiPage (object)
430 $editInfo: data holder that includes the parser output ($editInfo->output) for
431 that page after the change
432 $changed: bool for if the page was changed
434 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
435 recentchanges table, return false to not delete old entries
436 $article: WikiPage (object) being modified
438 'ArticleFromTitle': when creating an article object from a title object using
439 Wiki::articleFromTitle()
440 $title: title (object) used to create the article object
441 $article: article (object) that will be returned
443 'ArticleInsertComplete': After a new article is created
444 $article: WikiPage created
445 $user: User creating the article
447 $summary: Edit summary/comment
448 $isMinor: Whether or not the edit was marked as minor
449 $isWatch: (No longer used)
450 $section: (No longer used)
451 $flags: Flags passed to Article::doEdit()
452 $revision: New Revision of the article
454 'ArticleMergeComplete': after merging to article using Special:Mergehistory
455 $targetTitle: target title (object)
456 $destTitle: destination title (object)
458 'ArticlePageDataAfter': after loading data of an article from the database
459 $article: WikiPage (object) whose data were loaded
460 $row: row (object) returned from the database server
462 'ArticlePageDataBefore': before loading data of an article from the database
463 $article: WikiPage (object) that data will be loaded
464 $fields: fileds (array) to load from the database
466 'ArticlePrepareTextForEdit': called when preparing text to be saved
467 $article: the WikiPage being saved
468 $popts: parser options to be used for pre-save transformation
470 'ArticleProtect': before an article is protected
471 $article: the WikiPage being protected
472 $user: the user doing the protection
473 $protect: boolean whether this is a protect or an unprotect
474 $reason: Reason for protect
475 $moveonly: boolean whether this is for move only or not
477 'ArticleProtectComplete': after an article is protected
478 $article: the WikiPage that was protected
479 $user: the user who did the protection
480 $protect: boolean whether it was a protect or an unprotect
481 $reason: Reason for protect
482 $moveonly: boolean whether it was for move only or not
484 'ArticlePurge': before executing "&action=purge"
485 $article: WikiPage (object) to purge
487 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
488 revision of an article
489 &$title: title object of the article
491 'ArticleRevisionUndeleted': after an article revision is restored
492 $title: the article title
493 $revision: the revision
494 $oldPageID: the page ID of the revision when archived (may be null)
496 'ArticleRollbackComplete': after an article rollback is completed
497 $article: the WikiPage that was edited
498 $user: the user who did the rollback
499 $revision: the revision the page was reverted back to
500 $current: the reverted revision
502 'ArticleSave': before an article is saved
503 $article: the WikiPage (object) being saved
504 $user: the user (object) saving the article
505 $text: the new article text
506 $summary: the article summary (comment)
511 'ArticleSaveComplete': After an article has been updated
512 $article: WikiPage modified
513 $user: User performing the modification
515 $summary: Edit summary/comment
516 $isMinor: Whether or not the edit was marked as minor
517 $isWatch: (No longer used)
518 $section: (No longer used)
519 $flags: Flags passed to Article::doEdit()
520 $revision: New Revision of the article
521 $baseRevId: the rev ID (or false) this edit was based on
523 'ArticleUndelete': When one or more revisions of an article are restored
524 $title: Title corresponding to the article restored
525 $create: Whether or not the restoration caused the page to be created
526 (i.e. it didn't exist before)
527 $comment: The comment associated with the undeletion.
529 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
530 before the user is redirected back to the page
531 &$article: the article
532 &$sectionanchor: The section anchor link (e.g. "#overview" )
533 &$extraq: Extra query parameters which can be added via hooked functions
535 'ArticleViewFooter': After showing the footer section of an ordinary page view
536 $article: Article object
538 'ArticleViewHeader': Before the parser cache is about to be tried for article
540 &$article: the article
541 &$pcache: whether to try the parser cache or not
542 &$outputDone: whether the output for this page finished or not
544 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
546 $article: target article (object)
548 'AuthPluginAutoCreate': Called when creating a local account for an user logged
549 in from an external authentication method
550 $user: User object created locally
552 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
553 Gives a chance for an extension to set it programattically to a variable class.
554 &$auth: the $wgAuth object, probably a stub
556 'AutopromoteCondition': check autopromote condition for user.
557 $type: condition type
560 $result: result of checking autopromote condition
562 'BadImage': When checking against the bad image list
563 $name: Image name being checked
564 &$bad: Whether or not the image is "bad"
566 Change $bad and return false to override. If an image is "bad", it is not
567 rendered inline in wiki pages or galleries in category pages.
569 'BeforeInitialize': before anything is initialized in performRequestForTitle()
570 &$title: Title being used for request
571 &$article: The associated Article object
572 &$output: OutputPage object
574 $request: WebRequest object
575 $mediaWiki: Mediawiki object
577 'BeforePageDisplay': Prior to outputting a page
578 &$out: OutputPage object
581 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
582 $parser: Parser object
584 &$time: the image timestamp (use '0' to force a broken thumbnail)
585 &$sha1: image base 36 sha1 (used to specify the file, $nt will be ignored if this is set)
586 &$descQuery: query string to add to thumbnail URL
588 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
589 $parser: Parser object
590 $title: title of the template
591 &$skip: skip this template and link it?
592 &$id: the id of the revision being parsed
594 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
595 &$parser: Parser object
596 &$ig: ImageGallery object
598 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
599 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
600 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
602 'BitmapHandlerTransform': before a file is transformed, gives extension the
603 possibility to transform it themselves
604 $handler: BitmapHandler
606 &$scalerParams: Array with scaler parameters
607 &$mto: null, set to a MediaTransformOutput
609 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
610 $block: Block object (which is set to be autoblocking)
611 &$blockIds: Array of block IDs of the autoblock
613 'BlockIp': before an IP address or user is blocked
614 $block: the Block object about to be saved
615 $user: the user _doing_ the block (not the one being blocked)
617 'BlockIpComplete': after an IP address or user is blocked
618 $block: the Block object that was saved
619 $user: the user who did the block (not the one being blocked)
621 'BookInformation': Before information output on Special:Booksources
622 $isbn: ISBN to show information for
623 $output: OutputPage object in use
625 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
626 &$namespaces: Array of namespace numbers with corresponding canonical names
628 'CategoryPageView': before viewing a categorypage in CategoryPage::view
629 $catpage: CategoryPage instance
631 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
632 &$changesList: ChangesList instance.
633 &$articlelink: HTML of link to article (already filled-in).
634 &$s: HTML of row that is being constructed.
635 &$rc: RecentChange instance.
636 $unpatrolled: Whether or not we are showing unpatrolled changes.
637 $watched: Whether or not the change is watched by the user.
639 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
640 $collationName: Name of the collation in question
641 &$collationObject: Null. Replace with a subclass of the Collation class that implements
642 the collation given in $collationName.
644 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
645 $user: user (object) whose email is being confirmed
647 'ContribsPager::getQueryInfo': Before the contributions query is about to run
648 &$pager: Pager object for contributions
649 &queryInfo: The query for the contribs Pager
651 'ContributionsLineEnding': Called before a contributions HTML line is finished
652 $page: SpecialPage object for contributions
654 $row: the DB row for this line
656 'ContributionsToolLinks': Change tool links above Special:Contributions
658 $title: User page title
659 &$tools: Array of tool links
661 'CustomEditor': When invoking the page editor
662 $article: Article being edited
663 $user: User performing the edit
665 Return true to allow the normal editor to be used, or false
666 if implementing a custom editor, e.g. for a special namespace,
669 'DatabaseOraclePostInit': Called after initialising an Oracle database
670 &$db: the DatabaseOracle object
672 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
673 $text: plaintext string to be output
674 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
676 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
677 $title: the diff page title (nullable)
678 &$oldId: the actual old Id to use in the diff
679 &$newId: the actual new Id to use in the diff (0 means current)
680 $old: the ?old= param value from the url
681 $new: the ?new= param value from the url
683 'DiffViewHeader': called before diff display
684 $diff: DifferenceEngine object that's calling
685 $oldRev: Revision object of the "old" revision (may be null/invalid)
686 $newRev: Revision object of the "new" revision
688 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
690 $article: article (object) being viewed
691 $oldid: oldid (int) being viewed
693 'DoEditSectionLink': Override the HTML generated for section edit links
694 $skin: Skin object rendering the UI
695 $title: Title object for the title being linked to (may not be the same as
696 $wgTitle, if the section is included from a template)
697 $section: The designation of the section being pointed to, to be included in
698 the link, like "§ion=$section"
699 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
700 By default, this is wrapped in the 'editsectionhint' message.
701 &$result: The HTML to return, prefilled with the default plus whatever other
702 changes earlier hooks have made
703 $lang: The language code to use for the link in the wfMsg* functions
705 'EditFilter': Perform checks on an edit
706 $editor: Edit form (see includes/EditPage.php)
707 $text: Contents of the edit box
708 $section: Section being edited
709 &$error: Error message to return
710 $summary: Edit summary for page
712 'EditFilterMerged': Post-section-merge edit filter
713 $editor: EditPage instance (object)
714 $text: content of the edit box
715 &$error: error message to return
716 $summary: Edit summary for page
718 'EditFormPreloadText': Allows population of the edit form when creating
720 &$text: Text to preload with
721 &$title: Title object representing the page being created
723 'EditFormInitialText': Allows modifying the edit form when editing existing
725 $editPage: EditPage object
727 'EditPage::attemptSave': called before an article is
728 saved, that is before Article::doEdit() is called
729 $editpage_Obj: the current EditPage object
731 'EditPage::importFormData': allow extensions to read additional data
733 $editpage: EditPage instance
735 return value is ignored (should always return true)
737 'EditPage::showEditForm:fields': allows injection of form field into edit form
738 &$editor: the EditPage instance for reference
739 &$out: an OutputPage instance to write to
740 return value is ignored (should always return true)
742 'EditPage::showEditForm:initial': before showing the edit form
743 $editor: EditPage instance (object)
744 $formCallback: Array for callback of modifying the edit form
746 Return false to halt editing; you'll need to handle error messages, etc.
747 yourself. Alternatively, modifying $error and returning true will cause the
748 contents of $error to be echoed at the top of the edit form as wikitext.
749 Return true without altering $error to allow the edit to proceed.
751 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
752 when there's an edit conflict. Return false to halt normal diff output; in
753 this case you're responsible for computing and outputting the entire "conflict"
754 part, i.e., the "difference between revisions" and "your text" headers and
756 &$editor: EditPage instance
757 &$out: OutputPage instance
759 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
760 textarea in the edit form
761 &$editpage: The current EditPage object
762 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
763 &$tabindex: HTML tabindex of the last edit check/button
765 'EditPageBeforeEditChecks': allows modifying the edit checks below the
766 textarea in the edit form
767 &$editpage: The current EditPage object
768 &$checks: Array of edit checks like "watch this page"/"minor edit"
769 &$tabindex: HTML tabindex of the last edit check/button
771 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
772 textarea in the edit form
773 &$toolbar: The toolbar HTMl
775 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
776 $title: title of page being edited
777 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
779 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
781 $editPage: EditPage object
782 &$newtext: wikitext that will be used as "your version"
784 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
785 $editPage: EditPage object
786 &$toparse: wikitext that will be parsed
788 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
789 &$editpage: The current EditPage object
790 &$res: the HTML of the error text
792 'EditPageTosSummary': Give a chance for site and per-namespace customizations
793 of terms of service summary link that might exist separately from the copyright
795 $title: title of page being edited
796 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
798 'EditSectionLink': Do not use, use DoEditSectionLink instead.
799 $skin: Skin rendering the UI
800 $title: Title being linked to
801 $section: Section to link to
803 &$result: Result (alter this to override the generated links)
804 $lang: The language code to use for the link in the wfMsg* functions
806 'EmailConfirmed': When checking that the user's email address is "confirmed"
807 $user: User being checked
808 $confirmed: Whether or not the email address is confirmed
809 This runs before the other checks, such as anonymity and the real check; return
810 true to allow those checks to occur, and false if checking is done.
812 'EmailUser': before sending email from one user to another
813 $to: address of receiving user
814 $from: address of sending user
815 $subject: subject of the mail
816 $text: text of the mail
818 'EmailUserCC': before sending the copy of the email to the author
819 $to: address of receiving user
820 $from: address of sending user
821 $subject: subject of the mail
822 $text: text of the mail
824 'EmailUserComplete': after sending email from one user to another
825 $to: address of receiving user
826 $from: address of sending user
827 $subject: subject of the mail
828 $text: text of the mail
830 'EmailUserForm': after building the email user form object
831 $form: HTMLForm object
833 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
834 $user: The user who is trying to email another user.
835 $editToken: The user's edit token.
836 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
838 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
839 &$extTypes: associative array of extensions types
841 'FetchChangesList': When fetching the ChangesList derivative for
843 $user: User the list is being fetched for
844 &$skin: Skin object to be used with the list
845 &$list: List object (defaults to NULL, change it to an object
846 instance and return false override the list derivative used)
848 'FileDeleteComplete': When a file is deleted
849 $file: reference to the deleted file
850 $oldimage: in case of the deletion of an old image, the name of the old file
851 $article: in case all revisions of the file are deleted a reference to the
852 article associated with the file.
853 $user: user who performed the deletion
856 'FileUpload': When a file upload occurs
857 $file : Image object representing the file that was uploaded
858 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
859 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
861 'FileUndeleteComplete': When a file is undeleted
862 $title: title object to the file
863 $fileVersions: array of undeleted versions. Empty if all versions were restored
864 $user: user who performed the undeletion
867 'GetAutoPromoteGroups': When determining which autopromote groups a user
868 is entitled to be in.
869 &$user: user to promote.
870 &$promote: groups that will be added.
872 'GetBlockedStatus': after loading blocking status of an user from the database
873 $user: user (object) being checked
875 'GetCacheVaryCookies': get cookies that should vary cache options
876 $out: OutputPage object
877 &$cookies: array of cookies name, add a value to it if you want to add a cookie
878 that have to vary cache options
880 'GetDefaultSortkey': Override the default sortkey for a page.
881 $title: Title object that we need to get a sortkey for
882 &$sortkey: Sortkey to use.
884 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
885 $title: Title object of page
886 $url: string value as output (out parameter, can modify)
887 $query: query options passed to Title::getFullURL()
889 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
890 $title: Title object of page
891 $url: string value as output (out parameter, can modify)
892 $query: query options passed to Title::getInternalURL()
894 'GetIP': modify the ip of the current user (called only once)
895 &$ip: string holding the ip as determined so far
897 'GetLinkColours': modify the CSS class of an array of page links
898 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
900 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
902 'GetLocalURL': modify local URLs as output into page links
903 $title: Title object of page
904 $url: string value as output (out parameter, can modify)
905 $query: query options passed to Title::getLocalURL()
907 'GetMetadataVersion': modify the image metadata version currently in use. This is
908 used when requesting image metadata from a ForiegnApiRepo. Media handlers
909 that need to have versioned metadata should add an element to the end of
910 the version array of the form 'handler_name=version'. Most media handlers
911 won't need to do this unless they broke backwards compatibility with a
912 previous version of the media handler metadata output.
913 &$version: Array of version strings
915 'GetPreferences': modify user preferences
916 $user: User whose preferences are being modified.
917 &$preferences: Preferences description array, to be fed to an HTMLForm object
919 'getUserPermissionsErrors': Add a permissions error when permissions errors are
920 checked for. Use instead of userCan for most cases. Return false if the
921 user can't do it, and populate $result with the reason in the form of
922 array( messagename, param1, param2, ... ). For consistency, error messages
923 should be plain text with no special coloring, bolding, etc. to show that
924 they're errors; presenting them properly to the user as errors is done by
926 $title: Title object being checked against
927 $user : Current user object
928 $action: Action being checked
929 $result: User permissions error to add. If none, return true.
931 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
932 if expensive checks are enabled.
934 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
935 image insertion. You can skip the default logic entirely by returning
936 false, or just modify a few things using call-by-reference.
938 &$title: Title object of the image
939 &$file: File object, or false if it doesn't exist
940 &$frameParams: Various parameters with special meanings; see documentation in
941 includes/Linker.php for Linker::makeImageLink2
942 &$handlerParams: Various parameters with special meanings; see documentation in
943 includes/Linker.php for Linker::makeImageLink2
944 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
945 &$res: Final HTML output, used if you return false
948 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
949 the image on an image page
950 $imagePage: ImagePage object ($this)
953 'ImagePageAfterImageLinks': called after the image links section on an image
955 $imagePage: ImagePage object ($this)
956 &$html: HTML for the hook to add
958 'ImagePageFileHistoryLine': called when a file history line is contructed
960 $line: the HTML of the history line
961 $css: the line CSS class
963 'ImagePageFindFile': called when fetching the file associated with an image page
964 $page: ImagePage object
966 &$displayFile: displayed File object
968 'ImagePageShowTOC': called when the file toc on an image page is generated
969 $page: ImagePage object
970 &$toc: Array of <li> strings
972 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
974 &$title: the Title object of the file as it would appear for the upload page
975 &$path: the original file and path name when img_auth was invoked by the the web
977 &$name: the name only component of the file
978 &$result: The location to pass back results of the hook routine (only used if
980 $result[0]=The index of the header message
981 $result[1]=The index of the body text message
982 $result[2 through n]=Parameters passed to body text message. Please note the
983 header message cannot receive/use parameters.
985 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
986 $reader: XMLReader object
987 $logInfo: Array of information
988 Return false to stop further processing of the tag
990 'ImportHandlePageXMLTag': When parsing a XML tag in a page
991 $reader: XMLReader object
992 $pageInfo: Array of information
993 Return false to stop further processing of the tag
995 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
996 $reader: XMLReader object
997 $revInfo: Array of information
998 Return false to stop further processing of the tag
1000 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
1001 $reader: XMLReader object
1002 Return false to stop further processing of the tag
1004 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
1005 $reader: XMLReader object
1006 $revisionInfo: Array of information
1007 Return false to stop further processing of the tag
1009 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
1010 $title: Title object ($wgTitle)
1011 $request: WebRequest
1012 $ignoreRedirect: boolean to skip redirect check
1013 $target: Title/string of redirect target
1014 $article: Article object
1016 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1017 Return true without providing an interwiki to continue interwiki search.
1018 $prefix: interwiki prefix we are looking for.
1019 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1020 iw_trans and optionally iw_api and iw_wikiid.
1022 'InternalParseBeforeLinks': during Parser's internalParse method before links
1023 but after noinclude/includeonly/onlyinclude and other processing.
1024 &$parser: Parser object
1025 &$text: string containing partially parsed text
1026 &$stripState: Parser's internal StripState object
1028 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1029 $user: user (object) whose email is being invalidated
1031 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1032 $article: article (object) being checked
1034 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1036 $result: Change this value to override the result of wfIsTrustedProxy()
1038 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1039 tance to return false if the domain name doesn't match your organization
1040 $addr: The e-mail address entered by the user
1041 &$result: Set this and return false to override the internal checks
1043 'isValidPassword': Override the result of User::isValidPassword()
1044 $password: The password entered by the user
1045 &$result: Set this and return false to override the internal checks
1046 $user: User the password is being validated for
1048 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1049 $wgExtensionMessagesFiles instead.
1050 Use this to define synonyms of magic words depending of the language
1051 $magicExtensions: associative array of magic words synonyms
1052 $lang: laguage code (string)
1054 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1055 listed in $wgExtensionMessagesFiles instead.
1056 Use to define aliases of special pages names depending of the language
1057 $specialPageAliases: associative array of magic words synonyms
1058 $lang: laguage code (string)
1060 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1061 &$names: array of language code => language name
1062 $code language of the preferred translations
1064 'LinkBegin': Used when generating internal and interwiki links in
1065 Linker::link(), before processing starts. Return false to skip default proces-
1066 sing and return $ret. See documentation for Linker::link() for details on the
1067 expected meanings of parameters.
1068 $skin: the Skin object
1069 $target: the Title that the link is pointing to
1070 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1072 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1073 tive array form, with keys and values unescaped. Should be merged with de-
1074 fault values, with a value of false meaning to suppress the attribute.
1075 &$query: the query string to add to the generated URL (the bit after the "?"),
1076 in associative array form, with keys and values unescaped.
1077 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1078 &$ret: the value to return if your hook returns false.
1080 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1081 just before the function returns a value. If you return true, an <a> element
1082 with HTML attributes $attribs and contents $html will be returned. If you re-
1083 turn false, $ret will be returned.
1084 $skin: the Skin object
1085 $target: the Title object that the link is pointing to
1086 $options: the options. Will always include either 'known' or 'broken', and may
1087 include 'noclasses'.
1088 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1089 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1091 &$ret: the value to return if your hook returns false.
1093 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1095 &$url: the image url
1096 &$alt: the image's alt text
1097 &$img: the new image HTML (if returning false)
1099 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1102 &$text: the link text
1103 &$link: the new link HTML (if returning false)
1104 &$attribs: the attributes to be applied.
1105 $linkType: The external link type
1107 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1109 &$linksUpdate: the LinksUpdate object
1111 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1113 &$linksUpdate: the LinksUpdate object
1115 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1116 &$linksUpdate: the LinksUpdate object
1118 'ListDefinedTags': When trying to find all defined tags.
1119 &$tags: The list of tags.
1121 'LoadExtensionSchemaUpdates': called during database installation and updates
1122 &updater: A DatabaseUpdater subclass
1124 'LocalFile::getHistory': called before file history query performed
1127 $fields: select fields
1129 $opts: query options
1130 $join_conds: JOIN conditions
1132 'LocalisationCacheRecache': Called when loading the localisation data into cache
1133 $cache: The LocalisationCache object
1134 $code: language code
1135 &$alldata: The localisation data from core and extensions
1137 'LoginAuthenticateAudit': a login attempt for a valid user account either
1138 succeeded or failed. No return data is accepted; this hook is for auditing only.
1139 $user: the User object being authenticated against
1140 $password: the password being submitted and found wanting
1141 $retval: a LoginForm class constant with authenticateUserData() return
1142 value (SUCCESS, WRONG_PASS, etc)
1144 'LogLine': Processes a single log entry on Special:Log
1145 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1146 logging.log_type database field.
1147 $log_action: string for the type of log action (e.g. 'delete', 'block',
1148 'create2'). Corresponds to logging.log_action database field.
1149 $title: Title object that corresponds to logging.log_namespace and
1150 logging.log_title database fields.
1151 $paramArray: Array of parameters that corresponds to logging.log_params field.
1152 Note that only $paramArray[0] appears to contain anything.
1153 &$comment: string that corresponds to logging.log_comment database field, and
1154 which is displayed in the UI.
1155 &$revert: string that is displayed in the UI, similar to $comment.
1156 $time: timestamp of the log entry (added in 1.12)
1158 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1159 $refreshLinks: RefreshLinks object
1161 'MagicWordMagicWords': When defining new magic word.
1162 DEPRECATED: use $magicWords in a file listed in
1163 $wgExtensionMessagesFiles instead.
1164 $magicWords: array of strings
1166 'MagicWordwgVariableIDs': When definig new magic words IDs.
1167 $variableIDs: array of strings
1169 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1170 is executed. Ideally, this hook should only be used to add variables that
1171 depend on the current page/request; static configuration should be added
1172 through ResourceLoaderGetConfigVars instead.
1173 &$vars: variable (or multiple variables) to be added into the output
1174 of Skin::makeVariablesScript
1176 'MarkPatrolled': before an edit is marked patrolled
1177 $rcid: ID of the revision to be marked patrolled
1178 $user: the user (object) marking the revision as patrolled
1179 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1180 needs to be a sysop in order to mark an edit patrolled
1182 'MarkPatrolledComplete': after an edit is marked patrolled
1183 $rcid: ID of the revision marked as patrolled
1184 $user: user (object) who marked the edit patrolled
1185 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1186 must be a sysop to patrol the edit
1188 'MediaWikiPerformAction': Override MediaWiki::performAction().
1189 Use this to do something completely different, after the basic
1190 globals have been set up, but before ordinary actions take place.
1192 $article: $wgArticle
1195 $request: $wgRequest
1196 $mediaWiki: The $mediawiki object
1198 'MessagesPreLoad': When loading a message from the database
1199 $title: title of the message (string)
1200 $message: value (string), change it to the message you want to define
1202 'MessageCacheReplace': When a message page is changed.
1203 Useful for updating caches.
1204 $title: name of the page changed.
1205 $text: new contents of the page.
1207 'ModifyExportQuery': Modify the query used by the exporter.
1208 $db: The database object to be queried.
1209 &$tables: Tables in the query.
1210 &$conds: Conditions in the query.
1211 &$opts: Options for the query.
1212 &$join_conds: Join conditions for the query.
1214 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1215 been rendered (useful for adding more)
1216 Note: this is only run for the Monobook skin. This hook is deprecated and
1217 may be removed in the future. To add items to the toolbox you should use
1218 the SkinTemplateToolboxEnd hook instead, which works for all
1219 "SkinTemplate"-type skins.
1220 $tools: array of tools
1222 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1223 and returning it for the skin to output. You can add items to the toolbox while
1224 still letting the skin make final decisions on skin-specific markup conventions
1226 &$sk: The BaseTemplate base skin template
1227 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1228 BaseTemplate::makeListItem for details on the format of individual
1229 items inside of this array
1231 'NewRevisionFromEditComplete': called when a revision was inserted
1233 $article: the WikiPage edited
1234 $rev: the new revision
1235 $baseID: the revision ID this was based off, if any
1236 $user: the editing user
1238 'NormalizeMessageKey': Called before the software gets the text of a message
1239 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1241 &$key: the message being looked up. Change this to something else to change
1242 what message gets displayed (string)
1243 &$useDB: whether or not to look up the message in the database (bool)
1244 &$langCode: the language code to get the message for (string) - or -
1245 whether to use the content language (true) or site language (false) (bool)
1246 &$transform: whether or not to expand variables and templates
1247 in the message (bool)
1249 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1250 &$changeslist: The OldChangesList instance.
1251 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1252 &$rc: The RecentChange object.
1254 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1255 Hooks can alter or append to the array of URLs for search & suggestion formats.
1256 &$urls: array of associative arrays with Url element attributes
1258 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1259 users and/or IP addresses too
1260 $otherBlockLink: An array with links to other block logs
1261 $ip: The requested IP address or username
1263 'OutputPageBeforeHTML': a page has been processed by the parser and
1264 the resulting HTML is about to be displayed.
1265 $parserOutput: the parserOutput (object) that corresponds to the page
1266 $text: the text that will be displayed, in HTML (string)
1268 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1269 tag to allow for extensions to add attributes to the body of the page they might
1270 need. Or to allow building extensions to add body classes that aren't of high
1271 enough demand to be included in core.
1272 $out: The OutputPage which called the hook, can be used to get the real title
1273 $sk: The Skin that called OutputPage::headElement
1274 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1276 'OutputPageCheckLastModified': when checking if the page has been modified
1277 since the last visit
1278 &$modifiedTimes: array of timestamps.
1279 The following keys are set: page, user, epoch
1281 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1282 $out: OutputPage instance (object)
1283 $parserOutput: parserOutput instance being added in $out
1285 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1286 categories. Implementations should return false if they generate the category
1287 links, so the default link generation is skipped.
1288 $out: OutputPage instance (object)
1289 $categories: associative array, keys are category names, values are category
1290 types ("normal" or "hidden")
1291 $links: array, intended to hold the result. Must be an associative array with
1292 category types as keys and arrays of HTML links as values.
1294 'PageHistoryBeforeList': When a history page list is about to be constructed.
1295 $article: the article that the history is loading for
1297 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1298 $row: the revision row for this line
1299 $s: the string representing this parsed line
1300 $classes: array containing the <li> element classes
1302 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1305 $queryInfo: the query parameters
1307 'PageRenderingHash': alter the parser cache option hash key
1308 A parser extension which depends on user options should install
1309 this hook and append its values to the key.
1310 $hash: reference to a hash key string which can be modified
1312 'ParserAfterStrip': Same as ParserBeforeStrip
1314 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1315 $parser: Parser object being used
1316 $text: text that'll be returned
1318 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1319 $parser: Parser object
1320 $text: text to parse
1321 $stripState: StripState instance being used
1323 'ParserBeforeStrip': Called at start of parsing time
1324 (no more strip, deprecated ?)
1325 $parser: parser object
1326 $text: text being parsed
1327 $stripState: stripState used (object)
1329 'ParserBeforeTidy': called before tidy and custom tags replacements
1330 $parser: Parser object being used
1333 'ParserClearState': called at the end of Parser::clearState()
1334 $parser: Parser object being cleared
1336 'ParserFirstCallInit': called when the parser initialises for the first time
1337 &$parser: Parser object being cleared
1339 'ParserGetVariableValueSwitch': called when the parser need the value of a
1341 $parser: Parser object
1342 $varCache: array to store the value in case of multiples calls of the
1344 $index: index (string) of the magic
1345 $ret: value of the magic word (the hook should set it)
1346 $frame: PPFrame object to use for expanding any template variables
1348 'ParserGetVariableValueTs': use this to change the value of the time for the
1349 {{LOCAL...}} magic word
1350 $parser: Parser object
1351 $time: actual time (timestamp)
1353 'ParserGetVariableValueVarCache': use this to change the value of the
1354 variable cache or return false to not use it
1355 $parser: Parser object
1356 $varCache: varaiable cache (array)
1358 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1359 include comments about size of the text parsed
1360 $parser: Parser object
1361 $limitReport: text that will be included (without comment tags)
1363 'ParserMakeImageParams': Called before the parser make an image link, use this
1364 to modify the parameters of the image.
1365 $title: title object representing the file
1366 $file: file object that will be used to create the image
1367 &$params: 2-D array of parameters
1369 'ParserSectionCreate': Called each time the parser creates a document section
1370 from wikitext. Use this to apply per-section modifications to HTML (like
1371 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1372 can begin in one section and end in another. Make sure your code can handle
1373 that case gracefully. See the EditSectionClearerLink extension for an
1375 $this: the calling Parser instance
1376 $section: the section number, zero-based, but section 0 is usually empty
1377 &$sectionContent: ref to the content of the section. modify this.
1378 $showEditLinks: boolean describing whether this section has an edit link
1380 'ParserTestParser': called when creating a new instance of Parser in
1381 maintenance/parserTests.inc
1382 $parser: Parser object created
1384 'ParserTestTables': alter the list of tables to duplicate when parser tests
1385 are run. Use when page save hooks require the presence of custom tables
1386 to ensure that tests continue to run properly.
1387 &$tables: array of table names
1389 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1390 my talk page, my contributions" etc).
1392 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1393 &$title: Title object representing the current page
1395 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1396 &$user : User performing the action
1397 $action : Action being performed
1398 &$result : Whether or not the action should be prevented
1399 Change $result and return false to give a definitive answer, otherwise
1400 the built-in rate limiting checks are used, if enabled.
1402 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1403 AJAX search suggestions. Put results into &$results outparam and return false.
1404 $ns : array of int namespace keys to search in
1405 $search : search term (not guaranteed to be conveniently normalized)
1406 $limit : maximum number of results to return
1407 &$results : out param: array of page names (strings)
1409 'PrefsEmailAudit': called when user changes his email address
1410 $user: User (object) changing his email address
1411 $oldaddr: old email address (string)
1412 $newaddr: new email address (string)
1414 'PrefsPasswordAudit': called when user changes his password
1415 $user: User (object) changing his passoword
1416 $newPass: new password
1417 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1419 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1420 $article: the title being (un)protected
1421 $output: a string of the form HTML so far
1423 'ProtectionForm::save': called when a protection form is submitted
1424 $article: the title being (un)protected
1425 $errorMsg: an html message string of an error
1427 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1428 $article: the page the form is shown for
1429 $out: OutputPage object
1431 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1432 loader request or generating HTML output.
1433 &$resourceLoader: ResourceLoader object
1435 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1436 to add modules to the startup module. This hook should be used sparingly since any module added here
1437 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1440 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1441 &$obj: RawPage object
1442 &$text: The text that's going to be the output
1444 'RecentChange_save': called at the end of RecentChange::save()
1445 $recentChange: RecentChange object
1447 'ResourceLoaderGetConfigVars': called at the end of
1448 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1449 configuration variables to JavaScript. Things that depend on the current
1450 page/request state must be added through MakeGlobalVariablesScript instead.
1451 &$vars: array( variable name => value )
1453 'RevisionInsertComplete': called after a revision is inserted into the DB
1454 &$revision: the Revision
1455 $data: the data stored in old_text. The meaning depends on $flags: if external
1456 is set, it's the URL of the revision text in external storage; otherwise,
1457 it's the revision text itself. In either case, if gzip is set, the revision
1459 $flags: a comma-delimited list of strings representing the options used. May
1460 include: utf8 (this will always be set for new revisions); gzip; external.
1462 'SearchUpdate': Prior to search update completion
1464 $namespace : Page namespace
1466 $text : Current text being indexed
1468 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1469 $allSearchTerms : Array of the search terms in all content languages
1470 &$titleResult : Outparam; the value to return. A Title object or null.
1472 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1473 $term : Search term string
1474 &$title : Outparam; set to $title object and return false for a match
1476 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1477 $term : Search term string
1478 &$title : Current Title object that is being returned (null if none found).
1480 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1481 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1482 in the $searchEngine->namespaces array.
1483 $query : Original query.
1484 &$parsed : Resultant query with the prefixes stripped.
1486 'SearchableNamespaces': An option to modify which namespaces are searchable.
1487 &$arr : Array of namespaces ($nsId => $name) which will be used.
1489 'SetupAfterCache': Called in Setup.php, after cache objects are set
1491 'ShowMissingArticle': Called when generating the output for a non-existent page
1492 $article: The article object corresponding to the page
1494 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1495 $text: Text being shown
1496 $title: Title of the custom script/stylesheet page
1497 $output: Current OutputPage object
1499 'ShowSearchHitTitle': Customise display of search hit title/link.
1500 &$title: Title to link to
1501 &$text: Text to use for the link
1502 $result: The search result
1503 $terms: The search terms entered
1504 $page: The SpecialSearch object.
1506 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1507 &$siteNotice: HTML returned as the sitenotice
1509 Return true to allow the normal method of notice selection/rendering to work,
1510 or change the value of $siteNotice and return false to alter it.
1512 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1513 &$siteNotice: HTML sitenotice
1515 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1517 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1519 &$text: bottomScripts Text
1520 Append to $text to add additional text/scripts after the stock bottom scripts.
1522 'SkinAfterContent': Allows extensions to add text after the page content and
1524 &$data: (string) Text to be printed out directly (without parsing)
1526 This hook should work in all skins. Just set the &$data variable to the text
1527 you're going to add.
1529 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1531 &$bar: Sidebar contents
1532 Modify $bar to add or modify sidebar portlets.
1534 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1535 $title: displayed page title
1536 $type: 'normal' or 'history' for old/diff views
1537 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1538 &$link: overridable HTML link to be passed into the message as $1
1539 &$forContent: overridable flag if copyright footer is shown in content language.
1542 &$text: additional 'powered by' icons in HTML.
1543 Note: Modern skin does not use the MediaWiki icon but plain text instead
1546 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1547 &$subpages: Subpage links HTML
1549 $out: OutputPage object
1550 If false is returned $subpages will be used instead of the HTML
1551 subPageSubtitle() generates.
1552 If true is returned, $subpages will be ignored and the rest of
1553 subPageSubtitle() will run.
1555 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1556 "permanent link" tab
1557 $sktemplate: SkinTemplate object
1558 $nav_urls: array of tabs
1560 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1561 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1562 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1563 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1564 &$sktemplate: SkinTemplate object
1565 &$links: Structured navigation links
1566 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1568 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1570 &$sktemplate: SkinTemplate object
1571 &$tpl: Template engine object
1573 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1574 $sktemplate: SkinTemplate object
1575 $res: set to true to prevent active tabs
1577 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1578 You can either create your own array, or alter the parameters for
1580 &$sktemplate: The SkinTemplate instance.
1581 $title: Title instance for the page.
1582 $message: Visible label of tab.
1583 $selected: Whether this is a selected tab.
1584 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1585 &$classes: Array of CSS classes to apply.
1586 &$query: Query string to add to link.
1588 &$result: Complete assoc. array if you want to return true.
1590 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1591 been rendered (useful for adding more)
1592 $sk: The QuickTemplate based skin template running the hook.
1594 'SoftwareInfo': Called by Special:Version for returning information about
1596 $software: The array of software in format 'name' => 'version'.
1597 See SpecialVersion::softwareInformation()
1599 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1600 $id: User identifier
1602 'SpecialListusersDefaultQuery': called right before the end of
1603 UsersPager::getDefaultQuery()
1604 $pager: The UsersPager instance
1605 $query: The query array to be returned
1607 'SpecialListusersFormatRow': called right before the end of
1608 UsersPager::formatRow()
1609 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1610 $row: Database row object
1612 'SpecialListusersHeader': called before closing the <fieldset> in
1613 UsersPager::getPageHeader()
1614 $pager: The UsersPager instance
1615 $out: The header HTML
1617 'SpecialListusersHeaderForm': called before adding the submit button in
1618 UsersPager::getPageHeader()
1619 $pager: The UsersPager instance
1620 $out: The header HTML
1622 'SpecialListusersQueryInfo': called right before the end of
1623 UsersPager::getQueryInfo()
1624 $pager: The UsersPager instance
1625 $query: The query array to be returned
1627 'SpecialMovepageAfterMove': called after moving a page
1628 $movePage: MovePageForm object
1629 $oldTitle: old title (object)
1630 $newTitle: new title (object)
1632 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1633 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1634 $opts: FormOptions object containing special page options
1635 &$conds: array of WHERE conditionals for query
1636 &tables: array of tables to be queried
1637 &$fields: array of columns to select
1638 &$join_conds: join conditions for the tables
1640 'SpecialNewPagesFilters': called after building form options at NewPages
1641 $special: the special page object
1642 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1643 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1645 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1646 hook to remove a core special page
1647 $list: list (array) of core special pages
1649 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1650 $users: array of User objects
1651 $data: array of data submitted by the user
1652 &$error: string, error code (message name) used to describe to error (out paramater).
1653 The hook needs to return false when setting this, otherwise it will have no effect.
1655 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1656 use this to change some selection criteria or substitute a different title
1657 &$randstr: The random number from wfRandom()
1658 &$isRedir: Boolean, whether to select a redirect or non-redirect
1659 &$namespaces: An array of namespace indexes to get the title from
1660 &$extra: An array of extra SQL statements
1661 &$title: If the hook returns false, a Title object to use instead of the
1662 result from the normal query
1664 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1665 $special: the special page object
1666 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1667 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1669 'SpecialRecentChangesPanel': called when building form options in
1670 SpecialRecentChanges
1671 &$extraOpts: array of added items, to which can be added
1672 $opts: FormOptions for this request
1674 'SpecialRecentChangesQuery': called when building sql query for
1675 SpecialRecentChanges and SpecialRecentChangesLinked
1676 &$conds: array of WHERE conditionals for query
1677 &$tables: array of tables to be queried
1678 &$join_conds: join conditions for the tables
1679 $opts: FormOptions for this request
1680 &$query_options: array of options for the database request
1681 &$select: Array of columns to select
1683 'SpecialSearchGo': called when user clicked the "Go"
1684 &$title: title object generated from the text entered by the user
1685 &$term: the search term entered by the user
1687 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1688 target doesn't exist
1689 &$title: title object generated from the text entered by the user
1691 'SpecialSearchProfiles': allows modification of search profiles
1692 &$profiles: profiles, which can be modified.
1694 'SpecialSearchProfileForm': allows modification of search profile forms
1695 $search: special page object
1696 &$form: String: form html
1697 $profile: String: current search profile
1698 $term: String: search term
1699 $opts: Array: key => value of hidden options for inclusion in custom forms
1701 'SpecialSearchSetupEngine': allows passing custom data to search engine
1702 $search: special page object
1703 $profile: String: current search profile
1704 $engine: the search engine
1706 'SpecialSearchResults': called before search result display when there
1708 $term: string of search term
1709 &$titleMatches: empty or SearchResultSet object
1710 &$textMatches: empty or SearchResultSet object
1712 'SpecialSearchNoResults': called before search result display when there are
1714 $term: string of search term
1716 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1717 &$extraStats: Array to save the new stats
1718 ( $extraStats['<name of statistic>'] => <value>; )
1720 'SpecialUploadComplete': Called after successfully uploading a file from
1722 $form: The SpecialUpload object
1724 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1725 use this to change the tables headers
1726 $extTypes: associative array of extensions types
1728 'SpecialWatchlistFilters': called after building form options at Watchlist
1729 $special: the special page object
1730 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1731 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1733 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1734 &$conds: array of WHERE conditionals for query
1735 &$tables: array of tables to be queried
1736 &$join_conds: join conditions for the tables
1737 &$fields: array of query fields
1739 'TitleArrayFromResult': called when creating an TitleArray object from a
1741 &$titleArray: set this to an object to override the default object returned
1742 $res: database result used to create the object
1744 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1745 that can be applied.
1746 $title: The title in question.
1747 &$types: The types of protection available.
1749 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
1750 $title: Title object that is being checked
1751 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page. Hooks may change this value to override the return value of Title::isCssOrJsPage()
1753 'TitleMoveComplete': after moving an article (title)
1756 $user: user who did the move
1757 $pageid: database ID of the page that's been moved
1758 $redirid: database ID of the created redirect
1760 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
1761 PageArchive object has been created but before any further processing is done.
1762 &$archive: PageArchive object
1763 $title: Title object of the page that we're viewing
1765 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
1766 PageArchive object has been created but before any further processing is done.
1767 &$archive: PageArchive object
1768 $title: Title object of the page that we're viewing
1770 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
1771 the site is not in read-only mode, that the Title object is not null and after
1772 a PageArchive object has been constructed but before performing any further
1774 &$archive: PageArchive object
1775 $title: Title object of the page that we're about to undelete
1777 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1778 $title: title object related to the revision
1779 $rev: revision (object) that will be viewed
1781 'UnknownAction': An unknown "action" has occured (useful for defining
1783 $action: action name
1784 $article: article "acted on"
1786 'UnitTestsList': Called when building a list of files with PHPUnit tests
1787 &$files: list of files
1789 'UnwatchArticle': before a watch is removed from an article
1790 $user: user watching
1791 $article: article object to be removed
1793 'UnwatchArticle': after a watch is removed from an article
1794 $user: user that was watching
1795 $article: article object removed
1797 'UnwatchArticleComplete': after a watch is removed from an article
1798 $user: user that watched
1799 $article: article object that was watched
1801 'UploadForm:initial': before the upload form is generated
1802 $form: UploadForm object
1803 You might set the member-variables $uploadFormTextTop and
1804 $uploadFormTextAfterSummary to inject text (HTML) either before
1805 or after the editform.
1807 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1808 $form: UploadForm object
1809 Lets you poke at member variables like $mUploadDescription before the
1811 Do not use this hook to break upload processing. This will return the user to
1812 a blank form with no error message; use UploadVerification and
1813 UploadVerifyFile instead
1815 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1816 $type: (string) the requested upload type
1817 &$className: the class name of the Upload instance to be created
1819 'UploadComplete': when Upload completes an upload
1820 &$upload: an UploadBase child instance
1822 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1824 $descriptor: (array) the HTMLForm descriptor
1826 'UploadFormSourceDescriptors': after the standard source inputs have been
1827 added to the descriptor
1828 $descriptor: (array) the HTMLForm descriptor
1830 'UploadVerification': additional chances to reject an uploaded file. Consider
1831 using UploadVerifyFile instead.
1832 string $saveName: destination file name
1833 string $tempName: filesystem path to the temporary file for checks
1834 string &$error: output: message key for message to show if upload canceled
1835 by returning false. May also be an array, where the first element
1836 is the message key and the remaining elements are used as parameters to
1839 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1840 in most cases over UploadVerification.
1841 object $upload: an instance of UploadBase, with all info about the upload
1842 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1843 will typically only apply for specific mime types.
1844 object &$error: output: true if the file is valid. Otherwise, an indexed array
1845 representing the problem with the file, where the first element
1846 is the message key and the remaining elements are used as parameters to
1849 'UploadComplete': Upon completion of a file upload
1850 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1851 $uploadBase->getLocalFile().
1853 'User::mailPasswordInternal': before creation and mailing of a user's new
1855 $user: the user who sent the message out
1856 $ip: IP of the user who sent the message out
1857 $u: the account whose new password will be set
1859 'UserAddGroup': called when adding a group; return false to override
1860 stock group addition.
1861 $user: the user object that is to have a group added
1862 &$group: the group to add, can be modified
1864 'UserArrayFromResult': called when creating an UserArray object from a
1866 &$userArray: set this to an object to override the default object returned
1867 $res: database result used to create the object
1869 'userCan': To interrupt/advise the "user can do X to Y article" check.
1870 If you want to display an error message, try getUserPermissionsErrors.
1871 $title: Title object being checked against
1872 $user : Current user object
1873 $action: Action being checked
1874 $result: Pointer to result returned if hook returns false. If null is returned,
1875 userCan checks are continued by internal code.
1877 'UserCanSendEmail': To override User::canSendEmail() permission check
1878 $user: User (object) whose permission is being checked
1879 &$canSend: bool set on input, can override on output
1881 'UserClearNewTalkNotification': called when clearing the
1882 "You have new messages!" message, return false to not delete it
1883 $user: User (object) that'll clear the message
1885 'UserComparePasswords': called when checking passwords, return false to
1886 override the default password checks
1887 &$hash: String of the password hash (from the database)
1888 &$password: String of the plaintext password the user entered
1889 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1891 &$result: If the hook returns false, this Boolean value will be checked to
1892 determine if the password was valid
1894 'UserCreateForm': change to manipulate the login form
1895 $template: SimpleTemplate instance for the form
1897 'UserCryptPassword': called when hashing a password, return false to implement
1898 your own hashing method
1899 &$password: String of the plaintext password to encrypt
1900 &$salt: String of the password salt or Boolean false if no salt is provided
1901 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1903 &$hash: If the hook returns false, this String will be used as the hash
1905 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1906 $user: User to get groups for
1907 &$groups: Current effective groups
1909 'UserGetAllRights': after calculating a list of all available rights
1910 &$rights: Array of rights, which may be added to.
1912 'UserGetEmail': called when getting an user email address
1914 &$email: email, change this to override local email
1916 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1917 email authentification
1919 &$timestamp: timestamp, change this to override local email authentification
1922 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1923 &$groups: List of implicit (automatically-assigned) groups
1925 'UserGetLanguageObject': Called when getting user's interface language object
1927 &$code: Langauge code that will be used to create the object
1929 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1930 &$reservedUsernames: $wgReservedUsernames
1932 'UserGetRights': Called in User::getRights()
1933 $user: User to get rights for
1934 &$rights: Current rights
1936 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1938 $user: User in question
1939 $title: Title of the page in question
1940 &$blocked: Out-param, whether or not the user is blocked from that page.
1941 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1942 own user talk pages.
1944 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1946 $ip: User's IP address
1947 &$blocked: Whether the user is blocked, to be modified by the hook
1949 'UserLoadAfterLoadFromSession': called to authenticate users on
1950 external/environmental means; occurs after session is loaded
1951 $user: user object being loaded
1953 'UserLoadDefaults': called when loading a default user
1957 'UserLoadFromDatabase': called when loading a user from the database
1959 &$s: database query object
1961 'UserLoadFromSession': called to authenticate users on external/environmental
1962 means; occurs before session is loaded
1963 $user: user object being loaded
1964 &$result: set this to a boolean value to abort the normal authentification
1967 'UserLoadOptions': when user options/preferences are being loaded from
1970 &$options: Options, can be modified.
1972 'UserLoginComplete': after a user has logged in
1973 $user: the user object that was created on login
1974 $inject_html: Any HTML to inject after the "logged in" message.
1976 'UserLoginForm': change to manipulate the login form
1977 $template: SimpleTemplate instance for the form
1979 'UserLogout': before a user logs out
1980 $user: the user object that is about to be logged out
1982 'UserLogoutComplete': after a user has logged out
1983 $user: the user object _after_ logout (won't have name, ID, etc.)
1984 $inject_html: Any HTML to inject after the "logged out" message.
1985 $oldName: name of the user before logout (string)
1987 'UserRemoveGroup': called when removing a group; return false to override
1988 stock group removal.
1989 $user: the user object that is to have a group removed
1990 &$group: the group to be removed, can be modified
1992 'UserRights': After a user's group memberships are changed
1993 $user : User object that was changed
1994 $add : Array of strings corresponding to groups added
1995 $remove: Array of strings corresponding to groups removed
1997 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1999 $user: user retrieving new talks messages
2000 $talks: array of new talks page(s)
2002 'UserSaveSettings': called when saving user settings
2005 'UserSaveOptions': Called just before saving user preferences/options.
2007 &$options: Options, modifiable
2009 'UserSetCookies': called when setting user cookies
2011 &$session: session array, will be added to $_SESSION
2012 &$cookies: cookies array mapping cookie name to its value
2014 'UserSetEmail': called when changing user email address
2016 &$email: new email, change this to override new email address
2018 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2019 of email authentification
2021 &$timestamp: new timestamp, change this to override local email
2022 authentification timestamp
2024 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2025 used to alter the SQL query which gets the list of wanted pages
2026 &$wantedPages: WantedPagesPage object
2027 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2029 'WatchArticle': before a watch is added to an article
2030 $user: user that will watch
2031 $article: article object to be watched
2033 'WatchArticleComplete': after a watch is added to an article
2034 $user: user that watched
2035 $article: article object watched
2037 'WatchlistEditorBuildRemoveLine': when building remove lines in
2038 Special:Watchlist/edit
2039 &$tools: array of extra links
2040 $title: Title object
2041 $redirect: whether the page is a redirect
2044 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2046 One, and only one hook should set this, and return false.
2047 &$tables: Database tables to use in the SELECT query
2048 &$opts: Options to use for the query
2049 &$join: Join conditions
2051 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2052 query pages to be updated with maintenance/updateSpecialPages.php
2053 $query: $wgQueryPages itself
2055 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2056 metadata to be added.
2057 $obj: The XmlDumpWriter object.
2058 &$out: The output string.
2059 $row: The database row for the page.
2060 $title: The title of the page.
2062 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2064 $obj: The XmlDumpWriter object.
2065 &$out: The text being output.
2066 $row: The database row for the revision.
2067 $text: The revision text.
2069 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2070 additional tags to extract.
2071 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2073 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2074 used to post-process the results.
2075 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2076 metadata tags returned (each tag is either a value, or an array of values).
2078 More hooks might be available but undocumented, you can execute
2079 ./maintenance/findhooks.php to find hidden one.