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)
260 $byEmail: true when account was created "by email" (added in 1.12)
262 'AjaxAddScript': Called in output page just before the initialisation
263 of the javascript ajax engine. The hook is only called when ajax
264 is enabled ( $wgUseAjax = true; ).
266 'AlternateEdit': before checking if an user can edit a page and
267 before showing the edit form ( EditPage::edit() ). This is triggered
269 $EditPage : the EditPage object
271 'ArticleAfterFetchContent': after fetching content of an article from the database
272 $article: the article (object) being loaded from the database
273 $content: the content (string) of the article
275 'ArticleDelete': before an article is deleted
276 $article: the article (object) being deleted
277 $user: the user (object) deleting the article
278 $reason: the reason (string) the article is being deleted
280 'ArticleDeleteComplete': after an article is deleted
281 $article: the article that was deleted
282 $user: the user that deleted the article
283 $reason: the reason the article was deleted
285 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
286 $article: article (object) of the user talk page
288 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
289 $article: article (object) being modified
291 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
292 $title: title (object) used to create the article object
293 $article: article (object) that will be returned
295 'ArticleInsertComplete': After an article is created
296 $article: Article created
297 $user: User creating the article
299 $summary: Edit summary/comment
300 $isMinor: Whether or not the edit was marked as minor
301 $isWatch: (No longer used)
302 $section: (No longer used)
303 $flags: Flags passed to Article::doEdit()
304 $revision: New Revision of the article
306 'ArticleMergeComplete': after merging to article using Special:Mergehistory
307 $targetTitle: target title (object)
308 $destTitle: destination title (object)
310 'ArticlePageDataAfter': after loading data of an article from the database
311 $article: article (object) whose data were loaded
312 $row: row (object) returned from the database server
314 'ArticlePageDataBefore': before loading data of an article from the database
315 $article: article (object) that data will be loaded
316 $fields: fileds (array) to load from the database
318 'ArticleProtect': before an article is protected
319 $article: the article being protected
320 $user: the user doing the protection
321 $protect: boolean whether this is a protect or an unprotect
322 $reason: Reason for protect
323 $moveonly: boolean whether this is for move only or not
325 'ArticleProtectComplete': after an article is protected
326 $article: the article that was protected
327 $user: the user who did the protection
328 $protect: boolean whether it was a protect or an unprotect
329 $reason: Reason for protect
330 $moveonly: boolean whether it was for move only or not
332 'ArticlePurge': before executing "&action=purge"
333 $article: article (object) to purge
335 'ArticleRevisionUndeleted' after an article revision is restored
336 $title: the article title
337 $revision: the revision
338 $oldPageID: the page ID of the revision when archived (may be null)
340 'ArticleRollbackComplete': after an article rollback is completed
341 $article: the article that was edited
342 $user: the user who did the rollback
343 $revision: the revision the page was reverted back to
345 'ArticleSave': before an article is saved
346 $article: the article (object) being saved
347 $user: the user (object) saving the article
348 $text: the new article text
349 $summary: the article summary (comment)
354 'ArticleSaveComplete': After an article has been updated
355 $article: Article modified
356 $user: User performing the modification
358 $summary: Edit summary/comment
359 $isMinor: Whether or not the edit was marked as minor
360 $isWatch: (No longer used)
361 $section: (No longer used)
362 $flags: Flags passed to Article::doEdit()
363 $revision: New Revision of the article
365 'ArticleSaveComplete': after an article is saved
366 $article: the article (object) saved
367 $user: the user (object) who saved the article
368 $text: the new article text
369 $summary: the article summary (comment)
374 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
376 'ArticleUndelete': When one or more revisions of an article are restored
377 $title: Title corresponding to the article restored
378 $create: Whether or not the restoration caused the page to be created
379 (i.e. it didn't exist before)
381 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
382 &$article: the article
383 &$sectionanchor: The section anchor link (e.g. "#overview" )
384 &$extraq: Extra query parameters which can be added via hooked functions
386 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
387 &$article: the article
388 &$pcache: whether to try the parser cache or not
389 &$outputDone: whether the output for this page finished or not
391 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
392 $article: target article (object)
394 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
395 Gives a chance for an extension to set it programattically to a variable class.
396 &$auth: the $wgAuth object, probably a stub
398 'AutoAuthenticate': called to authenticate users on external/environmental means
399 $user: writes user object to this parameter
401 'AutopromoteCondition': check autopromote condition for user.
402 $type: condition type
405 $result: result of checking autopromote condition
407 'BadImage': When checking against the bad image list
408 $name: Image name being checked
409 &$bad: Whether or not the image is "bad"
411 Change $bad and return false to override. If an image is "bad", it is not
412 rendered inline in wiki pages or galleries in category pages.
414 'BeforeGalleryFindFile': before an image is fetched for a gallery
415 &$gallery,: the gallery object
416 &$nt: the image title
417 &$time: image timestamp
419 'BeforePageDisplay': Prior to outputting a page
420 $out: OutputPage object
422 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
423 &$parser: Parser object
424 &$title: title of the template
425 &$skip: skip this template and link it?
426 &$id: the id of the revision being parsed
428 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
429 &$parser: Parser object
430 &$nt: the image title
431 &$skip: skip this image and link it?
432 &$time: the image timestamp
434 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
435 &$parser: Parser object
436 &$ig: ImageGallery object
438 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
439 $nondefaults: Assoc array with the following keys:
440 days, hideOwn, hideBots, hideMinor, namespace
442 &$hookSql: a string which will be inserted without sanitation into the SQL query
443 used to get the watchlist, at the end of the WHERE part.
445 'BlockIp': before an IP address or user is blocked
446 $block: the Block object about to be saved
447 $user: the user _doing_ the block (not the one being blocked)
449 'BlockIpComplete': after an IP address or user is blocked
450 $block: the Block object that was saved
451 $user: the user who did the block (not the one being blocked)
453 'BookInformation': Before information output on Special:Booksources
454 $isbn: ISBN to show information for
455 $output: OutputPage object in use
457 'CategoryPageView': before viewing a categorypage in CategoryPage::view
458 $catpage: CategoryPage instance
460 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
461 &$this: ChangesList instance.
462 &$articlelink: HTML of link to article (already filled-in).
463 &$s: HTML of row that is being constructed.
464 &$rc: RecentChange instance.
465 $unpatrolled: Whether or not we are showing unpatrolled changes.
466 $watched: Whether or not the change is watched by the user.
468 'ContributionsToolLinks': Change tool links above Special:Contributions
470 $title: User page title
471 &$tools: Array of tool links
473 'CustomEditor': When invoking the page editor
474 $article: Article being edited
475 $user: User performing the edit
477 Return true to allow the normal editor to be used, or false
478 if implementing a custom editor, e.g. for a special namespace,
481 'DiffViewHeader': called before diff display
482 $diff: DifferenceEngine object that's calling
483 $oldRev: Revision object of the "old" revision (may be null/invalid)
484 $newRev: Revision object of the "new" revision
486 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
487 $article: article (object) being viewed
488 $oldid: oldid (int) being viewed
490 'EditFilter': Perform checks on an edit
491 $editor: Edit form (see includes/EditPage.php)
492 $text: Contents of the edit box
493 $section: Section being edited
494 &$error: Error message to return
496 'EditFilterMerged': Post-section-merge edit filter
497 $editor: EditPage instance (object)
498 $text: content of the edit box
499 $error: error message to return
501 'EditFormPreloadText': Allows population of the edit form when creating new pages
502 &$text: Text to preload with
503 &$title: Title object representing the page being created
505 'EditPage::attemptSave': called before an article is
506 saved, that is before insertNewArticle() is called
507 &$editpage_Obj: the current EditPage object
509 'EditPage::showEditForm:fields': allows injection of form field into edit form
510 &$editor: the EditPage instance for reference
511 &$out: an OutputPage instance to write to
512 return value is ignored (should always return true)
514 'EditPage::showEditForm:initial': before showing the edit form
515 $editor: EditPage instance (object)
517 Return false to halt editing; you'll need to handle error messages, etc. yourself.
518 Alternatively, modifying $error and returning true will cause the contents of $error
519 to be echoed at the top of the edit form as wikitext. Return true without altering
520 $error to allow the edit to proceed.
522 'EditSectionLink': Override the return value of Linker::editSectionLink()
523 $skin: Skin rendering the UI
524 $title: Title being linked to
525 $section: Section to link to
527 $result: Result (alter this to override the generated links)
529 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
530 $skin: Skin rendering the UI
531 $title: Title being linked to
532 $section: Section to link to
533 $hint: Anchor title/tooltip attributes
535 $result: Result (alter this to override the generated links)
537 'EmailConfirmed': When checking that the user's email address is "confirmed"
538 $user: User being checked
539 $confirmed: Whether or not the email address is confirmed
540 This runs before the other checks, such as anonymity and the real check; return
541 true to allow those checks to occur, and false if checking is done.
543 'EmailUser': before sending email from one user to another
544 $to: address of receiving user
545 $from: address of sending user
546 $subject: subject of the mail
547 $text: text of the mail
549 'EmailUserComplete': after sending email from one user to another
550 $to: address of receiving user
551 $from: address of sending user
552 $subject: subject of the mail
553 $text: text of the mail
555 'FetchChangesList': When fetching the ChangesList derivative for a particular user
556 &$user: User the list is being fetched for
557 &$skin: Skin object to be used with the list
558 &$list: List object (defaults to NULL, change it to an object instance and return
559 false override the list derivative used)
561 'FileUpload': When a file upload occurs
562 $file : Image object representing the file that was uploaded
564 'GetBlockedStatus': after loading blocking status of an user from the database
565 $user: user (object) being checked
567 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
568 $title: Title object of page
569 $url: string value as output (out parameter, can modify)
570 $query: query options passed to Title::getFullURL()
572 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
573 $title: Title object of page
574 $url: string value as output (out parameter, can modify)
575 $query: query options passed to Title::getInternalURL()
577 'GetLinkColours': modify the CSS class of an array of page links
578 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
579 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
581 'GetLocalURL': modify local URLs as output into page links
582 $title: Title object of page
583 $url: string value as output (out parameter, can modify)
584 $query: query options passed to Title::getLocalURL()
586 'getUserPermissionsErrors': Add a permissions error when permissions errors are
587 checked for. Use instead of userCan for most cases. Return false if the
588 user can't do it, and populate $result with the reason in the form of
589 array( messagename, param1, param2, ... ). For consistency, error messages
590 should be plain text with no special coloring, bolding, etc. to show that
591 they're errors; presenting them properly to the user as errors is done by
593 $title: Title object being checked against
594 $user : Current user object
595 $action: Action being checked
596 $result: User permissions error to add. If none, return true.
598 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
599 if expensive checks are enabled.
601 'ImageOpenShowImageInlineBefore': Call potential extension just before showing the image on an image page
602 $imagePage: ImagePage object ($this)
605 'InitPreferencesForm': called at the end of PreferencesForm's constructor
606 $form: the PreferencesForm
607 $request: the web request to initialized from
609 'InternalParseBeforeLinks': during Parser's internalParse method before links but
610 after noinclude/includeonly/onlyinclude and other processing.
611 &$this: Parser object
612 &$text: string containing partially parsed text
613 &$this->mStripState: Parser's internal StripState object
615 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
616 $article: article (object) being checked
618 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
620 $result: Change this value to override the result of wfIsTrustedProxy()
622 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
623 tance to return false if the domain name doesn't match your organization
624 $addr: The e-mail address entered by the user
625 &$result: Set this and return false to override the internal checks
627 'isValidPassword': Override the result of User::isValidPassword()
628 $password: The password entered by the user
629 &$result: Set this and return false to override the internal checks
630 $user: User the password is being validated for
632 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
633 $magicExtensions: associative array of magic words synonyms
634 $lang: laguage code (string)
636 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
637 $specialPageAliases: associative array of magic words synonyms
638 $lang: laguage code (string)
640 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
641 &$linksUpdate: the LinkUpdate object
643 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
644 &$linksUpdate: the LinkUpdate object
646 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
647 &$linksUpdate: the LinkUpdate object
649 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
651 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
653 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
654 No return data is accepted; this hook is for auditing only.
655 $user: the User object being authenticated against
656 $password: the password being submitted and found wanting
657 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
659 'LogLine': Processes a single log entry on Special:Log
660 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
662 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
663 to logging.log_action database field.
664 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
665 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
666 appears to contain anything.
667 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
668 &$revert: string that is displayed in the UI, similar to $comment.
669 $time: timestamp of the log entry (added in 1.12)
671 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
672 &$type: array of strings
674 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
675 &$typeText: array of strings
677 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
678 &$headerText: array of strings
680 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
681 &$actionText: array of strings
683 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
684 $magicWords: array of strings
686 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
687 $variableIDs: array of strings
689 'MarkPatrolled': before an edit is marked patrolled
690 $rcid: ID of the revision to be marked patrolled
691 $user: the user (object) marking the revision as patrolled
692 $wcOnlySysopsCanPatrol: config setting indicating whether the user
693 needs to be a sysop in order to mark an edit patrolled
695 'MarkPatrolledComplete': after an edit is marked patrolled
696 $rcid: ID of the revision marked as patrolled
697 $user: user (object) who marked the edit patrolled
698 $wcOnlySysopsCanPatrol: config setting indicating whether the user
699 must be a sysop to patrol the edit
701 'MathAfterTexvc': after texvc is executed when rendering mathematics
702 $mathRenderer: instance of MathRenderer
703 $errmsg: error message, in HTML (string). Nonempty indicates failure
704 of rendering the formula
706 'MediaWikiPerformAction': Override MediaWiki::performAction().
707 Use this to do something completely different, after the basic
708 globals have been set up, but before ordinary actions take place.
715 'MessagesPreLoad': When loading a message from the database
716 $title: title of the message (string)
717 $message: value (string), change it to the message you want to define
719 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
720 $tools: array of tools
722 'OutputPageBeforeHTML': a page has been processed by the parser and
723 the resulting HTML is about to be displayed.
724 $parserOutput: the parserOutput (object) that corresponds to the page
725 $text: the text that will be displayed, in HTML (string)
727 'OutputPageParserOutput': after adding a parserOutput to $wgOut
728 $out: OutputPage instance (object)
729 $parserOutput: parserOutput instance being added in $out
731 'PageHistoryBeforeList': When a history page list is about to be constructed.
732 $article: the article that the history is loading for
734 'PageHistoryLineEnding' : right before the end <li> is added to a history line
735 $row: the revision row for this line
736 $s: the string representing this parsed line
738 'PageRenderingHash': alter the parser cache option hash key
739 A parser extension which depends on user options should install
740 this hook and append its values to the key.
741 $hash: reference to a hash key string which can be modified
743 'ParserAfterStrip': Same as ParserBeforeStrip
745 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
746 $parser: Parser object being used
747 $text: text that'll be returned
749 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
750 $parser: Parser object
752 $stripState: StripState instance being used
754 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
755 $parser: parser object
756 $text: text being parsed
757 $stripState: stripState used (object)
759 'ParserBeforeTidy': called before tidy and custom tags replacements
760 $parser: Parser object being used
763 'ParserClearState': called at the end of Parser::clearState()
764 $parser: Parser object being cleared
766 'ParserFirstCallInit': called when the ther parser initialises for the first time
767 $parser: Parser object being cleared
769 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
770 $parser: Parser object
771 $varCache: array to store the value in case of multiples calls of the same magic word
772 $index: index (string) of the magic
773 $ret: value of the magic word (the hook should set it)
775 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
776 $parser: Parser object
777 $time: actual time (timestamp)
779 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
780 $parser: Parser object
781 $varCache: varaiable cache (array)
783 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
784 $parser: Parser object
785 $limitReport: text that will be included (without comment tags)
787 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
788 $parser: Parser object created
790 'ParserTestTables': alter the list of tables to duplicate when parser tests
791 are run. Use when page save hooks require the presence of custom tables
792 to ensure that tests continue to run properly.
793 &$tables: array of table names
795 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
796 my talk page, my contributions" etc).
798 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
799 &$title: Title object representing the current page
801 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
802 &$user : User performing the action
803 $action : Action being performed
804 &$result : Whether or not the action should be prevented
805 Change $result and return false to give a definitive answer, otherwise
806 the built-in rate limiting checks are used, if enabled.
808 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
809 $form : PreferencesForm object
810 &$html : HTML to append to
812 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
813 AJAX search suggestions. Put results into &$results outparam and return false.
814 $ns : int namespace key to search in
815 $search : search term (not guaranteed to be conveniently normalized)
816 $limit : maximum number of results to return
817 &$results : out param: array of page names (strings)
819 'PrefsEmailAudit': called when user changes his email address
820 $user: User (object) changing his email address
821 $oldaddr: old email address (string)
822 $newaddr: new email address (string)
824 'PrefsPasswordAudit': called when user changes his password
825 $user: User (object) changing his passoword
826 $newPass: new password
827 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
829 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
830 &$obj: RawPage object
831 &$text: The text that's going to be the output
833 'RecentChange_save': called at the end of RecenChange::save()
834 $recentChange: RecentChange object
836 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
837 $form: the PreferencesForm
838 $out: output page to render to, probably $wgOut
840 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
841 $form: the PreferencesForm
842 $user: the User object to load preferences from
844 'SavePreferences': called at the end of PreferencesForm::savePreferences;
845 returning false prevents the preferences from being saved.
846 $form: the PreferencesForm
847 $user: the User object to save preferences to
848 $message: change this to set an error message (ignored if the hook does notreturn fals)
850 'SearchUpdate': Prior to search update completion
852 $namespace : Page namespace
854 $text : Current text being indexed
856 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
857 $term : Search term string
858 &$title : Outparam; set to $title object and return false for a match
860 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
861 $text: Text being shown
862 $title: Title of the custom script/stylesheet page
863 $output: Current OutputPage object
865 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
866 &$siteNotice: HTML returned as the sitenotice
867 Return true to allow the normal method of notice selection/rendering to work,
868 or change the value of $siteNotice and return false to alter it.
870 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
871 &$siteNotice: HTML sitenotice
872 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
874 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
876 &$text: bottomScripts Text
877 Append to $text to add additional text/scripts after the stock bottom scripts.
879 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
881 &$subpages: Subpage links HTML
882 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
883 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
885 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
886 $sktemplate: SkinTemplate object
887 $content_actions: array of tabs
889 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
890 $sktemplate: SkinTemplate object
891 $nav_urls: array of tabs
893 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
894 &$content_actions: Content actions
895 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
898 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
899 &$sktemplate: SkinTemplate object
900 &$tpl: Template engine object
902 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
903 $sktemplate: SkinTemplate object
904 $res: set to true to prevent active tabs
906 'SkinTemplateSetupPageCss': use this to provide per-page CSS
909 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
910 You can either create your own array, or alter the parameters for the normal one.
911 &$this: The SkinTemplate instance.
912 $title: Title instance for the page.
913 $message: Visible label of tab.
914 $selected: Whether this is a selected tab.
915 $checkEdit: Whether or not the action=edit query should be added if appropriate.
916 &$classes: Array of CSS classes to apply.
917 &$query: Query string to add to link.
919 &$result: Complete assoc. array if you want to return true.
921 'SkinTemplateTabs': called when finished to build the actions tabs
922 $sktemplate: SkinTemplate object
923 $content_actions: array of tabs
925 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
928 'SpecialMovepageAfterMove': called after moving a page
929 $movePage: MovePageForm object
930 $oldTitle: old title (object)
931 $newTitle: new title (object)
933 'SpecialPageExecuteAfterPage': called after executing a special page
934 Warning: Not all the special pages call this hook
935 $specialPage: SpecialPage object
936 $par: paramter passed to the special page (string)
937 $funct: function called to execute the special page
939 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
940 Warning: Not all the special pages call this hook
941 $specialPage: SpecialPage object
942 $par: paramter passed to the special page (string)
943 $funct: function called to execute the special page
945 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
946 Warning: Not all the special pages call this hook
947 $specialPage: SpecialPage object
948 $par: paramter passed to the special page (string)
949 $funct: function called to execute the special page
951 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
952 $list: list (array) of core special pages
954 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
955 $title: title object generated from the text entred by the user
957 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
958 $extTypes: associative array of extensions types
960 'TitleMoveComplete': after moving an article (title)
963 $user: user who did the move
964 $pageid: database ID of the page that's been moved
965 $redirid: database ID of the created redirect
967 'UndeleteShowRevision': called when showing a revision in Special:Undelete
968 $title: title object related to the revision
969 $rev: revision (object) that will be viewed
971 'UnknownAction': An unknown "action" has occured (useful for defining
974 $article: article "acted on"
976 'UnwatchArticle': before a watch is removed from an article
978 $article: article object to be removed
980 'UnwatchArticle': after a watch is removed from an article
981 $user: user that was watching
982 $article: article object removed
984 'UnwatchArticleComplete': after a watch is removed from an article
985 $user: user that watched
986 $article: article object that was watched
988 'UploadForm:initial': before the upload form is generated
989 $form: UploadForm object
990 You might set the member-variables $uploadFormTextTop and
991 $uploadFormTextAfterSummary to inject text (HTML) either before
992 or after the editform.
994 'UploadForm:BeforeProcessing': at the beginning of processUpload()
995 $form: UploadForm object
996 Lets you poke at member variables like $mUploadDescription before the
999 'UploadVerification': additional chances to reject an uploaded file
1000 string $saveName: destination file name
1001 string $tempName: filesystem path to the temporary file for checks
1002 string &$error: output: HTML error to show if upload canceled by returning false
1004 'UploadComplete': Upon completion of a file upload
1005 $image: Image object representing the file that was uploaded
1007 'userCan': To interrupt/advise the "user can do X to Y article" check.
1008 If you want to display an error message, try getUserPermissionsErrors.
1009 $title: Title object being checked against
1010 $user : Current user object
1011 $action: Action being checked
1012 $result: Pointer to result returned if hook returns false. If null is returned,
1013 userCan checks are continued by internal code.
1015 'UserCanSendEmail': To override User::canSendEmail() permission check
1016 $user: User (object) whose permission is being checked
1017 &$canSend: bool set on input, can override on output
1020 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1021 $user: User (object) that'll clear the message
1023 'UserCreateForm': change to manipulate the login form
1024 $template: SimpleTemplate instance for the form
1026 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1027 $user: User to get groups for
1028 &$groups: Current effective groups
1030 'UserLoginComplete': after a user has logged in
1031 $user: the user object that was created on login
1033 'UserLoginForm': change to manipulate the login form
1034 $template: SimpleTemplate instance for the form
1036 'UserLogout': before a user logs out
1037 $user: the user object that is about to be logged out
1039 'UserLogoutComplete': after a user has logged out
1040 $user: the user object _after_ logout (won't have name, ID, etc.)
1042 'UserRights': After a user's group memberships are changed
1043 $user : User object that was changed
1044 $add : Array of strings corresponding to groups added
1045 $remove: Array of strings corresponding to groups removed
1047 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1048 &$groups: List of implicit (automatically-assigned) groups
1050 'UserGetRights': Called in User::getRights()
1051 $user: User to get rights for
1052 &$rights: Current rights
1054 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1055 $user: user retrieving new talks messages
1056 $talks: array of new talks page(s)
1058 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1059 $toggles: array of toggles to add
1061 'WatchArticle': before a watch is added to an article
1062 $user: user that will watch
1063 $article: article object to be watched
1065 'WatchArticleComplete': after a watch is added to an article
1066 $user: user that watched
1067 $article: article object watched
1069 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1070 $query: $wgQueryPages itself
1072 More hooks might be available but undocumented, you can execute
1073 ./maintenance/findhooks.php to find hidden one.