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 'AbortNewAccount': Return false to cancel account creation.
249 $user: the User object about to be created (read-only, incomplete)
250 $message: out parameter: error message to display on abort
252 'AddNewAccount': after a user account is created
253 $user: the User object that was created. (Parameter added in 1.7)
255 'AjaxAddScript': Called in output page just before the initialisation
256 of the javascript ajax engine. The hook is only called when ajax
257 is enabled ( $wgUseAjax = true; ).
259 'AlternateEdit': before checking if an user can edit a page and
260 before showing the edit form ( EditPage::edit() ). This is triggered
262 $EditPage : the EditPage object
264 'ArticleAfterFetchContent': after fetching content of an article from the database
265 $article: the article (object) being loaded from the database
266 $content: the content (string) of the article
268 'ArticleDelete': before an article is deleted
269 $article: the article (object) being deleted
270 $user: the user (object) deleting the article
271 $reason: the reason (string) the article is being deleted
273 'ArticleDeleteComplete': after an article is deleted
274 $article: the article that was deleted
275 $user: the user that deleted the article
276 $reason: the reason the article was deleted
278 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
279 $article: article (object) of the user talk page
281 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
282 $article: article (object) being modified
284 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
285 $title: title (object) used to create the article object
286 $article: article (object) that will be returned
288 'ArticleInsertComplete': After an article is created
289 $article: Article created
290 $user: User creating the article
292 $summary: Edit summary/comment
293 $isMinor: Whether or not the edit was marked as minor
294 $isWatch: (No longer used)
295 $section: (No longer used)
296 $flags: Flags passed to Article::doEdit()
297 $revision: New Revision of the article
299 'ArticleMergeComplete': after merging to article using Special:Mergehistory
300 $targetTitle: target title (object)
301 $destTitle: destination title (object)
303 'ArticlePageDataAfter': after loading data of an article from the database
304 $article: article (object) whose data were loaded
305 $row: row (object) returned from the database server
307 'ArticlePageDataBefore': before loading data of an article from the database
308 $article: article (object) that data will be loaded
309 $fields: fileds (array) to load from the database
311 'ArticleProtect': before an article is protected
312 $article: the article being protected
313 $user: the user doing the protection
314 $protect: boolean whether this is a protect or an unprotect
315 $reason: Reason for protect
316 $moveonly: boolean whether this is for move only or not
318 'ArticleProtectComplete': after an article is protected
319 $article: the article that was protected
320 $user: the user who did the protection
321 $protect: boolean whether it was a protect or an unprotect
322 $reason: Reason for protect
323 $moveonly: boolean whether it was for move only or not
325 'ArticlePurge': before executing "&action=purge"
326 $article: article (object) to purge
328 'ArticleRevisionUndeleted' after an article revision is restored
329 $title: the article title
330 $revision: the revision
331 $oldPageID: the page ID of the revision when archived (may be null)
333 'ArticleRollbackComplete': after an article rollback is completed
334 $article: the article that was edited
335 $user: the user who did the rollback
336 $revision: the revision the page was reverted back to
338 'ArticleSave': before an article is saved
339 $article: the article (object) being saved
340 $user: the user (object) saving the article
341 $text: the new article text
342 $summary: the article summary (comment)
347 'ArticleSaveComplete': After an article has been updated
348 $article: Article modified
349 $user: User performing the modification
351 $summary: Edit summary/comment
352 $isMinor: Whether or not the edit was marked as minor
353 $isWatch: (No longer used)
354 $section: (No longer used)
355 $flags: Flags passed to Article::doEdit()
356 $revision: New Revision of the article
358 'ArticleSaveComplete': after an article is saved
359 $article: the article (object) saved
360 $user: the user (object) who saved the article
361 $text: the new article text
362 $summary: the article summary (comment)
367 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
369 'ArticleUndelete': When one or more revisions of an article are restored
370 $title: Title corresponding to the article restored
371 $create: Whether or not the restoration caused the page to be created
372 (i.e. it didn't exist before)
374 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
375 &$article: the article
376 &$sectionanchor: The section anchor link (e.g. "#overview" )
377 &$extraq: Extra query parameters which can be added via hooked functions
379 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
380 &$article: the article
381 &$pcache: whether to try the parser cache or not
382 &$outputDone: whether the output for this page finished or not
384 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
385 $article: target article (object)
387 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
388 Gives a chance for an extension to set it programattically to a variable class.
389 &$auth: the $wgAuth object, probably a stub
391 'AutoAuthenticate': called to authenticate users on external/environmental means
392 $user: writes user object to this parameter
394 'BadImage': When checking against the bad image list
395 $name: Image name being checked
396 &$bad: Whether or not the image is "bad"
398 Change $bad and return false to override. If an image is "bad", it is not
399 rendered inline in wiki pages or galleries in category pages.
401 'BeforeGalleryFindFile': before an image is fetched for a gallery
402 &$gallery,: the gallery object
403 &$nt: the image title
404 &$time: image timestamp
406 'BeforePageDisplay': Prior to outputting a page
407 $out: OutputPage object
409 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
410 &$parser: Parser object
411 &$title: title of the template
412 &$skip: skip this template and link it?
413 &$id: the id of the revision being parsed
415 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
416 &$parser: Parser object
417 &$nt: the image title
418 &$skip: skip this image and link it?
419 &$time: the image timestamp
421 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
422 &$parser: Parser object
423 &$ig: ImageGallery object
425 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
426 $nondefaults: Assoc array with the following keys:
427 days, hideOwn, hideBots, hideMinor, namespace
429 &$hookSql: a string which will be inserted without sanitation into the SQL query
430 used to get the watchlist, at the end of the WHERE part.
432 'BlockIp': before an IP address or user is blocked
433 $block: the Block object about to be saved
434 $user: the user _doing_ the block (not the one being blocked)
436 'BlockIpComplete': after an IP address or user is blocked
437 $block: the Block object that was saved
438 $user: the user who did the block (not the one being blocked)
440 'BookInformation': Before information output on Special:Booksources
441 $isbn: ISBN to show information for
442 $output: OutputPage object in use
444 'CategoryPageView': before viewing a categorypage in CategoryPage::view
445 $catpage: CategoryPage instance
447 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
448 &$this: ChangesList instance.
449 &$articlelink: HTML of link to article (already filled-in).
450 &$s: HTML of row that is being constructed.
451 &$rc: RecentChange instance.
452 $unpatrolled: Whether or not we are showing unpatrolled changes.
453 $watched: Whether or not the change is watched by the user.
455 'ContributionsToolLinks': Change tool links above Special:Contributions
457 $title: User page title
458 &$tools: Array of tool links
460 'CustomEditor': When invoking the page editor
461 $article: Article being edited
462 $user: User performing the edit
464 Return true to allow the normal editor to be used, or false
465 if implementing a custom editor, e.g. for a special namespace,
468 'DiffViewHeader': called before diff display
469 $diff: DifferenceEngine object that's calling
470 $oldRev: Revision object of the "old" revision (may be null/invalid)
471 $newRev: Revision object of the "new" revision
473 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
474 $article: article (object) being viewed
475 $oldid: oldid (int) being viewed
477 'EditPage::attemptSave': called before an article is
478 saved, that is before insertNewArticle() is called
479 &$editpage_Obj: the current EditPage object
481 'EditPage::showEditForm:initial': before showing the edit form
482 $editor: EditPage instance (object)
484 'EditFormPreloadText': Allows population of the edit form when creating new pages
485 &$text: Text to preload with
486 &$title: Title object representing the page being created
488 'EditPage::showEditForm:fields': allows injection of form field into edit form
489 &$editor: the EditPage instance for reference
490 &$out: an OutputPage instance to write to
491 return value is ignored (should always return true)
493 'EditFilter': Perform checks on an edit
494 $editor: Edit form (see includes/EditPage.php)
495 $text: Contents of the edit box
496 $section: Section being edited
497 &$error: Error message to return
499 'EditFilterMerged': Post-section-merge edit filter
500 $editor: EditPage instance (object)
501 $text: content of the edit box
502 $error: error message to return
504 Return false to halt editing; you'll need to handle error messages, etc. yourself.
505 Alternatively, modifying $error and returning true will cause the contents of $error
506 to be echoed at the top of the edit form as wikitext. Return true without altering
507 $error to allow the edit to proceed.
509 'EditSectionLink': Override the return value of Linker::editSectionLink()
510 $skin: Skin rendering the UI
511 $title: Title being linked to
512 $section: Section to link to
514 $result: Result (alter this to override the generated links)
516 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
517 $skin: Skin rendering the UI
518 $title: Title being linked to
519 $section: Section to link to
520 $hint: Anchor title/tooltip attributes
522 $result: Result (alter this to override the generated links)
524 'EmailConfirmed': When checking that the user's email address is "confirmed"
525 $user: User being checked
526 $confirmed: Whether or not the email address is confirmed
527 This runs before the other checks, such as anonymity and the real check; return
528 true to allow those checks to occur, and false if checking is done.
530 'EmailUser': before sending email from one user to another
531 $to: address of receiving user
532 $from: address of sending user
533 $subject: subject of the mail
534 $text: text of the mail
536 'EmailUserComplete': after sending email from one user to another
537 $to: address of receiving user
538 $from: address of sending user
539 $subject: subject of the mail
540 $text: text of the mail
542 'FetchChangesList': When fetching the ChangesList derivative for a particular user
543 &$user: User the list is being fetched for
544 &$skin: Skin object to be used with the list
545 &$list: List object (defaults to NULL, change it to an object instance and return
546 false override the list derivative used)
548 'FileUpload': When a file upload occurs
549 $file : Image object representing the file that was uploaded
551 'GetBlockedStatus': after loading blocking status of an user from the database
552 $user: user (object) being checked
554 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
555 $title: Title object of page
556 $url: string value as output (out parameter, can modify)
557 $query: query options passed to Title::getInternalURL()
559 'GetLinkColours': modify the CSS class of an array of page links
560 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
561 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
563 'GetLocalURL': modify local URLs as output into page links
564 $title: Title object of page
565 $url: string value as output (out parameter, can modify)
566 $query: query options passed to Title::getLocalURL()
568 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
569 $title: Title object of page
570 $url: string value as output (out parameter, can modify)
571 $query: query options passed to Title::getFullURL()
573 'getUserPermissionsErrors': Add a permissions error when permissions errors are checked for.
574 Use instead of userCan for most cases. Return false if the user can't do it,
575 and populate $result with the reason in the form of array( messagename, param1, param2 )
576 $title: Title object being checked against
577 $user : Current user object
578 $action: Action being checked
579 $result: User permissions error to add. If none, return true.
581 'ImageOpenShowImageInlineBefore': Call potential extension just before showing the image on an image page
582 $imagePage: ImagePage object ($this)
585 'InitPreferencesForm': called at the end of PreferencesForm's constructor
586 $form: the PreferencesForm
587 $request: the web request to initialized from
589 'InternalParseBeforeLinks': during Parser's internalParse method before links but
590 after noinclude/includeonly/onlyinclude and other processing.
591 &$this: Parser object
592 &$text: string containing partially parsed text
593 &$this->mStripState: Parser's internal StripState object
595 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
596 $article: article (object) being checked
598 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
600 $result: Change this value to override the result of wfIsTrustedProxy()
602 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
603 tance to return false if the domain name doesn't match your organization
604 $addr: The e-mail address entered by the user
605 &$result: Set this and return false to override the internal checks
607 'isValidPassword': Override the result of User::isValidPassword()
608 $password: The password entered by the user
609 &$result: Set this and return false to override the internal checks
610 $user: User the password is being validated for
612 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
613 &$linksUpdate: the LinkUpdate object
615 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
617 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
619 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
620 No return data is accepted; this hook is for auditing only.
621 $user: the User object being authenticated against
622 $password: the password being submitted and found wanting
623 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
625 'LogLine': Processes a single log entry on Special:Log
626 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
628 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
629 to logging.log_action database field.
630 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
631 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
632 appears to contain anything.
633 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
634 &$revert: string that is displayed in the UI, similar to $comment.
636 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
637 &$type: array of strings
639 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
640 &$typeText: array of strings
642 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
643 &$headerText: array of strings
645 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
646 &$actionText: array of strings
648 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
649 $magicWords: array of strings
651 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
652 $variableIDs: array of strings
654 'MarkPatrolled': before an edit is marked patrolled
655 $rcid: ID of the revision to be marked patrolled
656 $user: the user (object) marking the revision as patrolled
657 $wcOnlySysopsCanPatrol: config setting indicating whether the user
658 needs to be a sysop in order to mark an edit patrolled
660 'MarkPatrolledComplete': after an edit is marked patrolled
661 $rcid: ID of the revision marked as patrolled
662 $user: user (object) who marked the edit patrolled
663 $wcOnlySysopsCanPatrol: config setting indicating whether the user
664 must be a sysop to patrol the edit
666 'MathAfterTexvc': after texvc is executed when rendering mathematics
667 $mathRenderer: instance of MathRenderer
668 $errmsg: error message, in HTML (string). Nonempty indicates failure
669 of rendering the formula
671 'MediaWikiPerformAction': Override MediaWiki::performAction().
672 Use this to do something completely different, after the basic
673 globals have been set up, but before ordinary actions take place.
680 'MessagesPreLoad': When loading a message from the database
681 $title: title of the message (string)
682 $message: value (string), change it to the message you want to define
684 'OutputPageBeforeHTML': a page has been processed by the parser and
685 the resulting HTML is about to be displayed.
686 $parserOutput: the parserOutput (object) that corresponds to the page
687 $text: the text that will be displayed, in HTML (string)
689 'OutputPageParserOutput': after adding a parserOutput to $wgOut
690 $out: OutputPage instance (object)
691 $parserOutput: parserOutput instance being added in $out
693 'PageHistoryBeforeList': When a history page list is about to be constructed.
694 $article: the article that the history is loading for
696 'PageHistoryLineEnding' : right before the end <li> is added to a history line
697 $row: the revision row for this line
698 $s: the string representing this parsed line
700 'PageRenderingHash': alter the parser cache option hash key
701 A parser extension which depends on user options should install
702 this hook and append its values to the key.
703 $hash: reference to a hash key string which can be modified
705 'ParserAfterStrip': Same as ParserBeforeStrip
707 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
708 $parser: Parser object being used
709 $text: text that'll be returned
711 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
712 $parser: Parser object
714 $stripState: StripState instance being used
716 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
717 $parser: parser object
718 $text: text being parsed
719 $stripState: stripState used (object)
721 'ParserBeforeTidy': called before tidy and custom tags replacements
722 $parser: Parser object being used
725 'ParserClearState': called at the end of Parser::clearState()
726 $parser: Parser object being cleared
728 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
729 $parser: Parser object
730 $varCache: array to store the value in case of multiples calls of the same magic word
731 $index: index (string) of the magic
732 $ret: value of the magic word (the hook should set it)
734 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
735 $parser: Parser object
736 $time: actual time (timestamp)
738 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
739 $parser: Parser object
740 $varCache: varaiable cache (array)
742 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
743 $parser: Parser object
744 $limitReport: text that will be included (without comment tags)
746 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
747 $parser: Parser object created
749 'ParserTestTables': alter the list of tables to duplicate when parser tests
750 are run. Use when page save hooks require the presence of custom tables
751 to ensure that tests continue to run properly.
752 &$tables: array of table names
754 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
755 my talk page, my contributions" etc).
757 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
758 &$title: Title object representing the current page
760 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
761 &$user : User performing the action
762 $action : Action being performed
763 &$result : Whether or not the action should be prevented
764 Change $result and return false to give a definitive answer, otherwise
765 the built-in rate limiting checks are used, if enabled.
767 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
768 $form : PreferencesForm object
769 &$html : HTML to append to
771 'PrefsEmailAudit': called when user changes his email address
772 $user: User (object) changing his email address
773 $oldaddr: old email address (string)
774 $newaddr: new email address (string)
776 'PrefsPasswordAudit': called when user changes his password
777 $user: User (object) changing his passoword
778 $newPass: new password
779 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
781 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
782 &$obj: RawPage object
783 &$text: The text that's going to be the output
785 'RecentChange_save': called at the end of RecenChange::save()
786 $recentChange: RecentChange object
788 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
789 $form: the PreferencesForm
790 $out: output page to render to, probably $wgOut
792 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
793 $form: the PreferencesForm
794 $user: the User object to load preferences from
796 'SavePreferences': called at the end of PreferencesForm::savePreferences;
797 returning false prevents the preferences from being saved.
798 $form: the PreferencesForm
799 $user: the User object to save preferences to
800 $message: change this to set an error message (ignored if the hook does notreturn fals)
802 'SearchUpdate': Prior to search update completion
804 $namespace : Page namespace
806 $text : Current text being indexed
808 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
809 $text: Text being shown
810 $title: Title of the custom script/stylesheet page
811 $output: Current OutputPage object
813 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
814 &$siteNotice: HTML returned as the sitenotice
815 Return true to allow the normal method of notice selection/rendering to work,
816 or change the value of $siteNotice and return false to alter it.
818 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
819 &$siteNotice: HTML sitenotice
820 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
822 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
824 &$text: bottomScripts Text
825 Append to $text to add additional text/scripts after the stock bottom scripts.
827 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
828 $sktemplate: SkinTemplate object
829 $content_actions: array of tabs
831 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
832 $sktemplate: SkinTemplate object
833 $nav_urls: array of tabs
835 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
836 &$content_actions: Content actions
837 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
840 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
841 &$sktemplate: SkinTemplate object
842 &$tpl: Template engine object
844 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
845 $sktemplate: SkinTemplate object
846 $res: set to true to prevent active tabs
848 'SkinTemplateSetupPageCss': use this to provide per-page CSS
851 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
852 You can either create your own array, or alter the parameters for the normal one.
853 &$this: The SkinTemplate instance.
854 $title: Title instance for the page.
855 $message: Visible label of tab.
856 $selected: Whether this is a selected tab.
857 $checkEdit: Whether or not the action=edit query should be added if appropriate.
858 &$classes: Array of CSS classes to apply.
859 &$query: Query string to add to link.
861 &$result: Complete assoc. array if you want to return true.
863 'SkinTemplateTabs': called when finished to build the actions tabs
864 $sktemplate: SkinTemplate object
865 $content_actions: array of tabs
867 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
870 'SpecialMovepageAfterMove': called after moving a page
871 $movePage: MovePageForm object
872 $oldTitle: old title (object)
873 $newTitle: new title (object)
875 'SpecialPageExecuteAfterPage': called after executing a special page
876 Warning: Not all the special pages call this hook
877 $specialPage: SpecialPage object
878 $par: paramter passed to the special page (string)
879 $funct: function called to execute the special page
881 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
882 Warning: Not all the special pages call this hook
883 $specialPage: SpecialPage object
884 $par: paramter passed to the special page (string)
885 $funct: function called to execute the special page
887 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
888 Warning: Not all the special pages call this hook
889 $specialPage: SpecialPage object
890 $par: paramter passed to the special page (string)
891 $funct: function called to execute the special page
893 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
894 $list: list (array) of core special pages
896 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
897 $title: title object generated from the text entred by the user
899 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
900 $extTypes: associative array of extensions types
902 'TitleMoveComplete': after moving an article (title)
905 $user: user who did the move
906 $pageid: database ID of the page that's been moved
907 $redirid: database ID of the created redirect
909 'UndeleteShowRevision': called when showing a revision in Special:Undelete
910 $title: title object related to the revision
911 $rev: revision (object) that will be viewed
913 'UnknownAction': An unknown "action" has occured (useful for defining
916 $article: article "acted on"
918 'UnwatchArticle': before a watch is removed from an article
920 $article: article object to be removed
922 'UnwatchArticle': after a watch is removed from an article
923 $user: user that was watching
924 $article: article object removed
926 'UnwatchArticleComplete': after a watch is removed from an article
927 $user: user that watched
928 $article: article object that was watched
930 'UploadForm:initial': before the upload form is generated
931 $form: UploadForm object
932 You might set the member-variables $uploadFormTextTop and
933 $uploadFormTextAfterSummary to inject text (HTML) either before
934 or after the editform.
936 'UploadForm:BeforeProcessing': at the beginning of processUpload()
937 $form: UploadForm object
938 Lets you poke at member variables like $mUploadDescription before the
941 'UploadVerification': additional chances to reject an uploaded file
942 string $saveName: destination file name
943 string $tempName: filesystem path to the temporary file for checks
944 string &$error: output: HTML error to show if upload canceled by returning false
946 'UploadComplete': Upon completion of a file upload
947 $image: Image object representing the file that was uploaded
949 'userCan': To interrupt/advise the "user can do X to Y article" check.
950 If you want to display an error message, try getUserPermissionsErrors.
951 $title: Title object being checked against
952 $user : Current user object
953 $action: Action being checked
954 $result: Pointer to result returned if hook returns false. If null is returned,
955 userCan checks are continued by internal code.
957 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
958 $user: User (object) that'll clear the message
960 'UserCreateForm': change to manipulate the login form
961 $template: SimpleTemplate instance for the form
963 'UserEffectiveGroups': Called in User::getEffectiveGroups()
964 $user: User to get groups for
965 &$groups: Current effective groups
967 'UserLoginComplete': after a user has logged in
968 $user: the user object that was created on login
970 'UserLoginForm': change to manipulate the login form
971 $template: SimpleTemplate instance for the form
973 'UserLogout': before a user logs out
974 $user: the user object that is about to be logged out
976 'UserLogoutComplete': after a user has logged out
977 $user: the user object _after_ logout (won't have name, ID, etc.)
979 'UserRights': After a user's group memberships are changed
980 $user : User object that was changed
981 $add : Array of strings corresponding to groups added
982 $remove: Array of strings corresponding to groups removed
984 'UserGetImplicitGroups': Called in User::getImplicitGroups()
985 &$groups: List of implicit (automatically-assigned) groups
987 'UserGetRights': Called in User::getRights()
988 $user: User to get rights for
989 &$rights: Current rights
991 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
992 $user: user retrieving new talks messages
993 $talks: array of new talks page(s)
995 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
996 $toggles: array of toggles to add
998 'WatchArticle': before a watch is added to an article
999 $user: user that will watch
1000 $article: article object to be watched
1002 'WatchArticleComplete': after a watch is added to an article
1003 $user: user that watched
1004 $article: article object watched
1006 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1007 $query: $wgQueryPages itself
1009 More hooks might be available but undocumented, you can execute
1010 ./maintenance/findhooks.php to find hidden one.