3 This document describes how event hooks work in MediaWiki; how to add
4 hooks for an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs
10 in. A wiki page is saved. A wiki page is deleted. Often there are
11 two events associated with a single action: one before the code
12 is run to make the event happen, and one after. Each event has a
13 name, preferably in CamelCase. For example, 'UserLogin',
14 'ArticleSave', 'ArticleSaveComplete', 'ArticleDelete'.
17 A clump of code and data that should be run when an event
18 happens. This can be either a function and a chunk of data, or an
22 The function part of a hook.
26 Hooks allow us to decouple optionally-run code from code that is run
27 for everyone. It allows MediaWiki hackers, third-party developers and
28 local administrators to define code that will be run at certain points
29 in the mainline code, and to modify the data run by that mainline
30 code. Hooks can keep mainline code simple, and make it easier to
31 write extensions. Hooks are a principled alternative to local patches.
33 Consider, for example, two options in MediaWiki. One reverses the
34 order of a title before displaying the article; the other converts the
35 title to all uppercase letters. Currently, in MediaWiki code, we
36 would handle this as follows (note: not real code, here):
38 function showAnArticle($article) {
39 global $wgReverseTitle, $wgCapitalizeTitle;
41 if ($wgReverseTitle) {
42 wfReverseTitle($article);
45 if ($wgCapitalizeTitle) {
46 wfCapitalizeTitle($article);
49 # code to actually show the article goes here
52 An extension writer, or a local admin, will often add custom code to
53 the function -- with or without a global variable. For example,
54 someone wanting email notification when an article is shown may add:
56 function showAnArticle($article) {
57 global $wgReverseTitle, $wgCapitalizeTitle;
59 if ($wgReverseTitle) {
60 wfReverseTitle($article);
63 if ($wgCapitalizeTitle) {
64 wfCapitalizeTitle($article);
67 # code to actually show the article goes here
69 if ($wgNotifyArticle) {
70 wfNotifyArticleShow($article));
74 Using a hook-running strategy, we can avoid having all this
75 option-specific stuff in our mainline code. Using hooks, the function
78 function showAnArticle($article) {
80 if (wfRunHooks('ArticleShow', array(&$article))) {
82 # code to actually show the article goes here
84 wfRunHooks('ArticleShowComplete', array(&$article));
88 We've cleaned up the code here by removing clumps of weird,
89 infrequently used code and moving them off somewhere else. It's much
90 easier for someone working with this code to see what's _really_ going
91 on, and make changes or fix bugs.
93 In addition, we can take all the code that deals with the little-used
94 title-reversing options (say) and put it in one place. Instead of
95 having little title-reversing if-blocks spread all over the codebase
96 in showAnArticle, deleteAnArticle, exportArticle, etc., we can
97 concentrate it all in an extension file:
99 function reverseArticleTitle($article) {
103 function reverseForExport($article) {
107 The setup function for the extension just has to add its hook
108 functions to the appropriate events:
110 setupTitleReversingExtension() {
113 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
114 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
115 $wgHooks['ArticleExport'][] = 'reverseForExport';
118 Having all this code related to the title-reversion option in one
119 place means that it's easier to read and understand; you don't have to
120 do a grep-find to see where the $wgReverseTitle variable is used, say.
122 If the code is well enough isolated, it can even be excluded when not
123 used -- making for some slight savings in memory and load-up
124 performance at runtime. Admins who want to have all the reversed
127 require_once('extensions/ReverseTitle.php');
129 ...to their LocalSettings.php file; those of us who don't want or need
130 it can just leave it out.
132 The extensions don't even have to be shipped with MediaWiki; they
133 could be provided by a third-party developer or written by the admin
138 A hook is a chunk of code run at some particular event. It consists of:
140 * a function with some optional accompanying data, or
141 * an object with a method and some optional accompanying data.
143 Hooks are registered by adding them to the global $wgHooks array for a
144 given event. All the following are valid ways to define hooks:
146 $wgHooks['EventName'][] = 'someFunction'; # function, no data
147 $wgHooks['EventName'][] = array('someFunction', $someData);
148 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
150 $wgHooks['EventName'][] = $object; # object only
151 $wgHooks['EventName'][] = array($object, 'someMethod');
152 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
153 $wgHooks['EventName'][] = array($object); # weird but OK
155 When an event occurs, the function (or object method) will be called
156 with the optional data provided as well as event-specific parameters.
157 The above examples would result in the following code being executed
158 when 'EventName' happened:
161 someFunction($param1, $param2)
163 someFunction($someData, $param1, $param2)
166 $object->onEventName($param1, $param2)
168 $object->someMethod($param1, $param2)
169 # object with method and data
170 $object->someMethod($someData, $param1, $param2)
172 Note that when an object is the hook, and there's no specified method,
173 the default method called is 'onEventName'. For different events this
174 would be different: 'onArticleSave', 'onUserLogin', etc.
176 The extra data is useful if we want to use the same function or object
177 for different purposes. For example:
179 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
180 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
182 This code would result in ircNotify being run twice when an article is
183 saved: once for 'TimStarling', and once for 'brion'.
185 Hooks can return three possible values:
187 * true: the hook has operated successfully
188 * "some string": an error occurred; processing should
189 stop and the error should be shown to the user
190 * false: the hook has successfully done the work
191 necessary and the calling function should skip
193 The last result would be for cases where the hook function replaces
194 the main functionality. For example, if you wanted to authenticate
195 users to a custom system (LDAP, another PHP program, whatever), you
198 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
200 function ldapLogin($username, $password) {
205 Returning false makes less sense for events where the action is
206 complete, and will normally be ignored.
210 A calling function or method uses the wfRunHooks() function to run
211 the hooks related to a particular event, like so:
217 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
218 # protect the article
219 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
224 wfRunHooks() returns true if the calling function should continue
225 processing (the hooks ran OK, or there are no hooks to run), or false
226 if it shouldn't (an error occurred, or one of the hooks handled the
227 action already). Checking the return value matters more for "before"
228 hooks than for "complete" hooks.
230 Note that hook parameters are passed in an array; this is a necessary
231 inconvenience to make it possible to pass reference values (that can
232 be changed) into the hook code. Also note that earlier versions of
233 wfRunHooks took a variable number of arguments; the array() calling
234 protocol came about after MediaWiki 1.4rc1.
236 ==Events and parameters==
238 This is a list of known events and parameters; please add to it if
239 you're going to add events to the MediaWiki code.
241 'AbortLogin': Return false to cancel account login.
242 $user: the User object being authenticated against
243 $password: the password being submitted, not yet checked for validity
244 &$retval: a LoginForm class constant to return from authenticateUserData();
245 default is LoginForm::ABORTED. Note that the client may be using
246 a machine API rather than the HTML user interface.
248 'AbortMove': allows to abort moving an article (title)
251 $user: user who is doing the move
254 'AbortNewAccount': Return false to cancel account creation.
255 $user: the User object about to be created (read-only, incomplete)
256 $message: out parameter: error message to display on abort
258 'AddNewAccount': after a user account is created
259 $user: the User object that was created. (Parameter added in 1.7)
261 'AjaxAddScript': Called in output page just before the initialisation
262 of the javascript ajax engine. The hook is only called when ajax
263 is enabled ( $wgUseAjax = true; ).
265 'AlternateEdit': before checking if an user can edit a page and
266 before showing the edit form ( EditPage::edit() ). This is triggered
268 $EditPage : the EditPage object
270 'ArticleAfterFetchContent': after fetching content of an article from the database
271 $article: the article (object) being loaded from the database
272 $content: the content (string) of the article
274 'ArticleDelete': before an article is deleted
275 $article: the article (object) being deleted
276 $user: the user (object) deleting the article
277 $reason: the reason (string) the article is being deleted
279 'ArticleDeleteComplete': after an article is deleted
280 $article: the article that was deleted
281 $user: the user that deleted the article
282 $reason: the reason the article was deleted
284 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
285 $article: article (object) of the user talk page
287 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
288 $article: article (object) being modified
290 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
291 $title: title (object) used to create the article object
292 $article: article (object) that will be returned
294 'ArticleInsertComplete': After an article is created
295 $article: Article created
296 $user: User creating the article
298 $summary: Edit summary/comment
299 $isMinor: Whether or not the edit was marked as minor
300 $isWatch: (No longer used)
301 $section: (No longer used)
302 $flags: Flags passed to Article::doEdit()
303 $revision: New Revision of the article
305 'ArticleMergeComplete': after merging to article using Special:Mergehistory
306 $targetTitle: target title (object)
307 $destTitle: destination title (object)
309 'ArticlePageDataAfter': after loading data of an article from the database
310 $article: article (object) whose data were loaded
311 $row: row (object) returned from the database server
313 'ArticlePageDataBefore': before loading data of an article from the database
314 $article: article (object) that data will be loaded
315 $fields: fileds (array) to load from the database
317 'ArticleProtect': before an article is protected
318 $article: the article being protected
319 $user: the user doing the protection
320 $protect: boolean whether this is a protect or an unprotect
321 $reason: Reason for protect
322 $moveonly: boolean whether this is for move only or not
324 'ArticleProtectComplete': after an article is protected
325 $article: the article that was protected
326 $user: the user who did the protection
327 $protect: boolean whether it was a protect or an unprotect
328 $reason: Reason for protect
329 $moveonly: boolean whether it was for move only or not
331 'ArticlePurge': before executing "&action=purge"
332 $article: article (object) to purge
334 'ArticleRevisionUndeleted' after an article revision is restored
335 $title: the article title
336 $revision: the revision
337 $oldPageID: the page ID of the revision when archived (may be null)
339 'ArticleRollbackComplete': after an article rollback is completed
340 $article: the article that was edited
341 $user: the user who did the rollback
342 $revision: the revision the page was reverted back to
344 'ArticleSave': before an article is saved
345 $article: the article (object) being saved
346 $user: the user (object) saving the article
347 $text: the new article text
348 $summary: the article summary (comment)
353 'ArticleSaveComplete': After an article has been updated
354 $article: Article modified
355 $user: User performing the modification
357 $summary: Edit summary/comment
358 $isMinor: Whether or not the edit was marked as minor
359 $isWatch: (No longer used)
360 $section: (No longer used)
361 $flags: Flags passed to Article::doEdit()
362 $revision: New Revision of the article
364 'ArticleSaveComplete': after an article is saved
365 $article: the article (object) saved
366 $user: the user (object) who saved the article
367 $text: the new article text
368 $summary: the article summary (comment)
373 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
375 'ArticleUndelete': When one or more revisions of an article are restored
376 $title: Title corresponding to the article restored
377 $create: Whether or not the restoration caused the page to be created
378 (i.e. it didn't exist before)
380 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
381 &$article: the article
382 &$sectionanchor: The section anchor link (e.g. "#overview" )
383 &$extraq: Extra query parameters which can be added via hooked functions
385 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
386 &$article: the article
387 &$pcache: whether to try the parser cache or not
388 &$outputDone: whether the output for this page finished or not
390 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
391 $article: target article (object)
393 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
394 Gives a chance for an extension to set it programattically to a variable class.
395 &$auth: the $wgAuth object, probably a stub
397 'AutoAuthenticate': called to authenticate users on external/environmental means
398 $user: writes user object to this parameter
400 'AutopromoteCondition': check autopromote condition for user.
401 $type: condition type
404 $result: result of checking autopromote condition
406 'BadImage': When checking against the bad image list
407 $name: Image name being checked
408 &$bad: Whether or not the image is "bad"
410 Change $bad and return false to override. If an image is "bad", it is not
411 rendered inline in wiki pages or galleries in category pages.
413 'BeforeGalleryFindFile': before an image is fetched for a gallery
414 &$gallery,: the gallery object
415 &$nt: the image title
416 &$time: image timestamp
418 'BeforePageDisplay': Prior to outputting a page
419 $out: OutputPage object
421 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
422 &$parser: Parser object
423 &$title: title of the template
424 &$skip: skip this template and link it?
425 &$id: the id of the revision being parsed
427 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
428 &$parser: Parser object
429 &$nt: the image title
430 &$skip: skip this image and link it?
431 &$time: the image timestamp
433 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
434 &$parser: Parser object
435 &$ig: ImageGallery object
437 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
438 $nondefaults: Assoc array with the following keys:
439 days, hideOwn, hideBots, hideMinor, namespace
441 &$hookSql: a string which will be inserted without sanitation into the SQL query
442 used to get the watchlist, at the end of the WHERE part.
444 'BlockIp': before an IP address or user is blocked
445 $block: the Block object about to be saved
446 $user: the user _doing_ the block (not the one being blocked)
448 'BlockIpComplete': after an IP address or user is blocked
449 $block: the Block object that was saved
450 $user: the user who did the block (not the one being blocked)
452 'BookInformation': Before information output on Special:Booksources
453 $isbn: ISBN to show information for
454 $output: OutputPage object in use
456 'CategoryPageView': before viewing a categorypage in CategoryPage::view
457 $catpage: CategoryPage instance
459 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
460 &$this: ChangesList instance.
461 &$articlelink: HTML of link to article (already filled-in).
462 &$s: HTML of row that is being constructed.
463 &$rc: RecentChange instance.
464 $unpatrolled: Whether or not we are showing unpatrolled changes.
465 $watched: Whether or not the change is watched by the user.
467 'ContributionsToolLinks': Change tool links above Special:Contributions
469 $title: User page title
470 &$tools: Array of tool links
472 'CustomEditor': When invoking the page editor
473 $article: Article being edited
474 $user: User performing the edit
476 Return true to allow the normal editor to be used, or false
477 if implementing a custom editor, e.g. for a special namespace,
480 'DiffViewHeader': called before diff display
481 $diff: DifferenceEngine object that's calling
482 $oldRev: Revision object of the "old" revision (may be null/invalid)
483 $newRev: Revision object of the "new" revision
485 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
486 $article: article (object) being viewed
487 $oldid: oldid (int) being viewed
489 'EditFilter': Perform checks on an edit
490 $editor: Edit form (see includes/EditPage.php)
491 $text: Contents of the edit box
492 $section: Section being edited
493 &$error: Error message to return
495 'EditFilterMerged': Post-section-merge edit filter
496 $editor: EditPage instance (object)
497 $text: content of the edit box
498 $error: error message to return
500 'EditFormPreloadText': Allows population of the edit form when creating new pages
501 &$text: Text to preload with
502 &$title: Title object representing the page being created
504 'EditPage::attemptSave': called before an article is
505 saved, that is before insertNewArticle() is called
506 &$editpage_Obj: the current EditPage object
508 'EditPage::showEditForm:fields': allows injection of form field into edit form
509 &$editor: the EditPage instance for reference
510 &$out: an OutputPage instance to write to
511 return value is ignored (should always return true)
513 'EditPage::showEditForm:initial': before showing the edit form
514 $editor: EditPage instance (object)
516 Return false to halt editing; you'll need to handle error messages, etc. yourself.
517 Alternatively, modifying $error and returning true will cause the contents of $error
518 to be echoed at the top of the edit form as wikitext. Return true without altering
519 $error to allow the edit to proceed.
521 'EditSectionLink': Override the return value of Linker::editSectionLink()
522 $skin: Skin rendering the UI
523 $title: Title being linked to
524 $section: Section to link to
526 $result: Result (alter this to override the generated links)
528 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
529 $skin: Skin rendering the UI
530 $title: Title being linked to
531 $section: Section to link to
532 $hint: Anchor title/tooltip attributes
534 $result: Result (alter this to override the generated links)
536 'EmailConfirmed': When checking that the user's email address is "confirmed"
537 $user: User being checked
538 $confirmed: Whether or not the email address is confirmed
539 This runs before the other checks, such as anonymity and the real check; return
540 true to allow those checks to occur, and false if checking is done.
542 'EmailUser': before sending email from one user to another
543 $to: address of receiving user
544 $from: address of sending user
545 $subject: subject of the mail
546 $text: text of the mail
548 'EmailUserComplete': after sending email from one user to another
549 $to: address of receiving user
550 $from: address of sending user
551 $subject: subject of the mail
552 $text: text of the mail
554 'FetchChangesList': When fetching the ChangesList derivative for a particular user
555 &$user: User the list is being fetched for
556 &$skin: Skin object to be used with the list
557 &$list: List object (defaults to NULL, change it to an object instance and return
558 false override the list derivative used)
560 'FileUpload': When a file upload occurs
561 $file : Image object representing the file that was uploaded
563 'GetBlockedStatus': after loading blocking status of an user from the database
564 $user: user (object) being checked
566 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
567 $title: Title object of page
568 $url: string value as output (out parameter, can modify)
569 $query: query options passed to Title::getFullURL()
571 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
572 $title: Title object of page
573 $url: string value as output (out parameter, can modify)
574 $query: query options passed to Title::getInternalURL()
576 'GetLinkColours': modify the CSS class of an array of page links
577 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
578 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
580 'GetLocalURL': modify local URLs as output into page links
581 $title: Title object of page
582 $url: string value as output (out parameter, can modify)
583 $query: query options passed to Title::getLocalURL()
585 'getUserPermissionsErrors': Add a permissions error when permissions errors are checked for.
586 Use instead of userCan for most cases. Return false if the user can't do it,
587 and populate $result with the reason in the form of array( messagename, param1, param2 )
588 $title: Title object being checked against
589 $user : Current user object
590 $action: Action being checked
591 $result: User permissions error to add. If none, return true.
593 'ImageOpenShowImageInlineBefore': Call potential extension just before showing the image on an image page
594 $imagePage: ImagePage object ($this)
597 'InitPreferencesForm': called at the end of PreferencesForm's constructor
598 $form: the PreferencesForm
599 $request: the web request to initialized from
601 'InternalParseBeforeLinks': during Parser's internalParse method before links but
602 after noinclude/includeonly/onlyinclude and other processing.
603 &$this: Parser object
604 &$text: string containing partially parsed text
605 &$this->mStripState: Parser's internal StripState object
607 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
608 $article: article (object) being checked
610 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
612 $result: Change this value to override the result of wfIsTrustedProxy()
614 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
615 tance to return false if the domain name doesn't match your organization
616 $addr: The e-mail address entered by the user
617 &$result: Set this and return false to override the internal checks
619 'isValidPassword': Override the result of User::isValidPassword()
620 $password: The password entered by the user
621 &$result: Set this and return false to override the internal checks
622 $user: User the password is being validated for
624 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
625 $magicExtensions: associative array of magic words synonyms
626 $lang: laguage code (string)
628 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
629 $specialPageAliases: associative array of magic words synonyms
630 $lang: laguage code (string)
632 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
633 &$linksUpdate: the LinkUpdate object
635 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
637 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
639 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
640 No return data is accepted; this hook is for auditing only.
641 $user: the User object being authenticated against
642 $password: the password being submitted and found wanting
643 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
645 'LogLine': Processes a single log entry on Special:Log
646 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
648 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
649 to logging.log_action database field.
650 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
651 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
652 appears to contain anything.
653 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
654 &$revert: string that is displayed in the UI, similar to $comment.
656 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
657 &$type: array of strings
659 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
660 &$typeText: array of strings
662 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
663 &$headerText: array of strings
665 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
666 &$actionText: array of strings
668 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
669 $magicWords: array of strings
671 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
672 $variableIDs: array of strings
674 'MarkPatrolled': before an edit is marked patrolled
675 $rcid: ID of the revision to be marked patrolled
676 $user: the user (object) marking the revision as patrolled
677 $wcOnlySysopsCanPatrol: config setting indicating whether the user
678 needs to be a sysop in order to mark an edit patrolled
680 'MarkPatrolledComplete': after an edit is marked patrolled
681 $rcid: ID of the revision marked as patrolled
682 $user: user (object) who marked the edit patrolled
683 $wcOnlySysopsCanPatrol: config setting indicating whether the user
684 must be a sysop to patrol the edit
686 'MathAfterTexvc': after texvc is executed when rendering mathematics
687 $mathRenderer: instance of MathRenderer
688 $errmsg: error message, in HTML (string). Nonempty indicates failure
689 of rendering the formula
691 'MediaWikiPerformAction': Override MediaWiki::performAction().
692 Use this to do something completely different, after the basic
693 globals have been set up, but before ordinary actions take place.
700 'MessagesPreLoad': When loading a message from the database
701 $title: title of the message (string)
702 $message: value (string), change it to the message you want to define
704 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
705 $tools: array of tools
707 'OutputPageBeforeHTML': a page has been processed by the parser and
708 the resulting HTML is about to be displayed.
709 $parserOutput: the parserOutput (object) that corresponds to the page
710 $text: the text that will be displayed, in HTML (string)
712 'OutputPageParserOutput': after adding a parserOutput to $wgOut
713 $out: OutputPage instance (object)
714 $parserOutput: parserOutput instance being added in $out
716 'PageHistoryBeforeList': When a history page list is about to be constructed.
717 $article: the article that the history is loading for
719 'PageHistoryLineEnding' : right before the end <li> is added to a history line
720 $row: the revision row for this line
721 $s: the string representing this parsed line
723 'PageRenderingHash': alter the parser cache option hash key
724 A parser extension which depends on user options should install
725 this hook and append its values to the key.
726 $hash: reference to a hash key string which can be modified
728 'ParserAfterStrip': Same as ParserBeforeStrip
730 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
731 $parser: Parser object being used
732 $text: text that'll be returned
734 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
735 $parser: Parser object
737 $stripState: StripState instance being used
739 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
740 $parser: parser object
741 $text: text being parsed
742 $stripState: stripState used (object)
744 'ParserBeforeTidy': called before tidy and custom tags replacements
745 $parser: Parser object being used
748 'ParserClearState': called at the end of Parser::clearState()
749 $parser: Parser object being cleared
751 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
752 $parser: Parser object
753 $varCache: array to store the value in case of multiples calls of the same magic word
754 $index: index (string) of the magic
755 $ret: value of the magic word (the hook should set it)
757 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
758 $parser: Parser object
759 $time: actual time (timestamp)
761 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
762 $parser: Parser object
763 $varCache: varaiable cache (array)
765 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
766 $parser: Parser object
767 $limitReport: text that will be included (without comment tags)
769 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
770 $parser: Parser object created
772 'ParserTestTables': alter the list of tables to duplicate when parser tests
773 are run. Use when page save hooks require the presence of custom tables
774 to ensure that tests continue to run properly.
775 &$tables: array of table names
777 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
778 my talk page, my contributions" etc).
780 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
781 &$title: Title object representing the current page
783 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
784 &$user : User performing the action
785 $action : Action being performed
786 &$result : Whether or not the action should be prevented
787 Change $result and return false to give a definitive answer, otherwise
788 the built-in rate limiting checks are used, if enabled.
790 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
791 $form : PreferencesForm object
792 &$html : HTML to append to
794 'PrefsEmailAudit': called when user changes his email address
795 $user: User (object) changing his email address
796 $oldaddr: old email address (string)
797 $newaddr: new email address (string)
799 'PrefsPasswordAudit': called when user changes his password
800 $user: User (object) changing his passoword
801 $newPass: new password
802 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
804 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
805 &$obj: RawPage object
806 &$text: The text that's going to be the output
808 'RecentChange_save': called at the end of RecenChange::save()
809 $recentChange: RecentChange object
811 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
812 $form: the PreferencesForm
813 $out: output page to render to, probably $wgOut
815 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
816 $form: the PreferencesForm
817 $user: the User object to load preferences from
819 'SavePreferences': called at the end of PreferencesForm::savePreferences;
820 returning false prevents the preferences from being saved.
821 $form: the PreferencesForm
822 $user: the User object to save preferences to
823 $message: change this to set an error message (ignored if the hook does notreturn fals)
825 'SearchUpdate': Prior to search update completion
827 $namespace : Page namespace
829 $text : Current text being indexed
831 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
832 $text: Text being shown
833 $title: Title of the custom script/stylesheet page
834 $output: Current OutputPage object
836 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
837 &$siteNotice: HTML returned as the sitenotice
838 Return true to allow the normal method of notice selection/rendering to work,
839 or change the value of $siteNotice and return false to alter it.
841 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
842 &$siteNotice: HTML sitenotice
843 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
845 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
847 &$text: bottomScripts Text
848 Append to $text to add additional text/scripts after the stock bottom scripts.
850 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
851 $sktemplate: SkinTemplate object
852 $content_actions: array of tabs
854 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
855 $sktemplate: SkinTemplate object
856 $nav_urls: array of tabs
858 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
859 &$content_actions: Content actions
860 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
863 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
864 &$sktemplate: SkinTemplate object
865 &$tpl: Template engine object
867 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
868 $sktemplate: SkinTemplate object
869 $res: set to true to prevent active tabs
871 'SkinTemplateSetupPageCss': use this to provide per-page CSS
874 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
875 You can either create your own array, or alter the parameters for the normal one.
876 &$this: The SkinTemplate instance.
877 $title: Title instance for the page.
878 $message: Visible label of tab.
879 $selected: Whether this is a selected tab.
880 $checkEdit: Whether or not the action=edit query should be added if appropriate.
881 &$classes: Array of CSS classes to apply.
882 &$query: Query string to add to link.
884 &$result: Complete assoc. array if you want to return true.
886 'SkinTemplateTabs': called when finished to build the actions tabs
887 $sktemplate: SkinTemplate object
888 $content_actions: array of tabs
890 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
893 'SpecialMovepageAfterMove': called after moving a page
894 $movePage: MovePageForm object
895 $oldTitle: old title (object)
896 $newTitle: new title (object)
898 'SpecialPageExecuteAfterPage': called after executing a special page
899 Warning: Not all the special pages call this hook
900 $specialPage: SpecialPage object
901 $par: paramter passed to the special page (string)
902 $funct: function called to execute the special page
904 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
905 Warning: Not all the special pages call this hook
906 $specialPage: SpecialPage object
907 $par: paramter passed to the special page (string)
908 $funct: function called to execute the special page
910 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
911 Warning: Not all the special pages call this hook
912 $specialPage: SpecialPage object
913 $par: paramter passed to the special page (string)
914 $funct: function called to execute the special page
916 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
917 $list: list (array) of core special pages
919 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
920 $title: title object generated from the text entred by the user
922 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
923 $extTypes: associative array of extensions types
925 'TitleMoveComplete': after moving an article (title)
928 $user: user who did the move
929 $pageid: database ID of the page that's been moved
930 $redirid: database ID of the created redirect
932 'UndeleteShowRevision': called when showing a revision in Special:Undelete
933 $title: title object related to the revision
934 $rev: revision (object) that will be viewed
936 'UnknownAction': An unknown "action" has occured (useful for defining
939 $article: article "acted on"
941 'UnwatchArticle': before a watch is removed from an article
943 $article: article object to be removed
945 'UnwatchArticle': after a watch is removed from an article
946 $user: user that was watching
947 $article: article object removed
949 'UnwatchArticleComplete': after a watch is removed from an article
950 $user: user that watched
951 $article: article object that was watched
953 'UploadForm:initial': before the upload form is generated
954 $form: UploadForm object
955 You might set the member-variables $uploadFormTextTop and
956 $uploadFormTextAfterSummary to inject text (HTML) either before
957 or after the editform.
959 'UploadForm:BeforeProcessing': at the beginning of processUpload()
960 $form: UploadForm object
961 Lets you poke at member variables like $mUploadDescription before the
964 'UploadVerification': additional chances to reject an uploaded file
965 string $saveName: destination file name
966 string $tempName: filesystem path to the temporary file for checks
967 string &$error: output: HTML error to show if upload canceled by returning false
969 'UploadComplete': Upon completion of a file upload
970 $image: Image object representing the file that was uploaded
972 'userCan': To interrupt/advise the "user can do X to Y article" check.
973 If you want to display an error message, try getUserPermissionsErrors.
974 $title: Title object being checked against
975 $user : Current user object
976 $action: Action being checked
977 $result: Pointer to result returned if hook returns false. If null is returned,
978 userCan checks are continued by internal code.
980 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
981 $user: User (object) that'll clear the message
983 'UserCreateForm': change to manipulate the login form
984 $template: SimpleTemplate instance for the form
986 'UserEffectiveGroups': Called in User::getEffectiveGroups()
987 $user: User to get groups for
988 &$groups: Current effective groups
990 'UserLoginComplete': after a user has logged in
991 $user: the user object that was created on login
993 'UserLoginForm': change to manipulate the login form
994 $template: SimpleTemplate instance for the form
996 'UserLogout': before a user logs out
997 $user: the user object that is about to be logged out
999 'UserLogoutComplete': after a user has logged out
1000 $user: the user object _after_ logout (won't have name, ID, etc.)
1002 'UserRights': After a user's group memberships are changed
1003 $user : User object that was changed
1004 $add : Array of strings corresponding to groups added
1005 $remove: Array of strings corresponding to groups removed
1007 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1008 &$groups: List of implicit (automatically-assigned) groups
1010 'UserGetRights': Called in User::getRights()
1011 $user: User to get rights for
1012 &$rights: Current rights
1014 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1015 $user: user retrieving new talks messages
1016 $talks: array of new talks page(s)
1018 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1019 $toggles: array of toggles to add
1021 'WatchArticle': before a watch is added to an article
1022 $user: user that will watch
1023 $article: article object to be watched
1025 'WatchArticleComplete': after a watch is added to an article
1026 $user: user that watched
1027 $article: article object watched
1029 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1030 $query: $wgQueryPages itself
1032 More hooks might be available but undocumented, you can execute
1033 ./maintenance/findhooks.php to find hidden one.