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 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
245 'AbortLogin': Return false to cancel account login.
246 $user: the User object being authenticated against
247 $password: the password being submitted, not yet checked for validity
248 &$retval: a LoginForm class constant to return from authenticateUserData();
249 default is LoginForm::ABORTED. Note that the client may be using
250 a machine API rather than the HTML user interface.
252 'AbortMove': allows to abort moving an article (title)
255 $user: user who is doing the move
258 'AbortNewAccount': Return false to cancel account creation.
259 $user: the User object about to be created (read-only, incomplete)
260 $message: out parameter: error message to display on abort
262 'AddNewAccount': after a user account is created
263 $user: the User object that was created. (Parameter added in 1.7)
264 $byEmail: true when account was created "by email" (added in 1.12)
266 'AjaxAddScript': Called in output page just before the initialisation
267 of the javascript ajax engine. The hook is only called when ajax
268 is enabled ( $wgUseAjax = true; ).
270 'AlternateEdit': before checking if an user can edit a page and
271 before showing the edit form ( EditPage::edit() ). This is triggered
273 $EditPage : the EditPage object
275 'APIEditBeforeSave': before saving a page with api.php?action=edit,
276 after processing request parameters. Return false to let the request
277 fail, returning an error message or an <edit result="Failure"> tag
278 if $resultArr was filled.
279 $EditPage : the EditPage object
280 $text : the new text of the article (has yet to be saved)
281 $resultArr : data in this array will be added to the API result
283 'ArticleAfterFetchContent': after fetching content of an article from the database
284 $article: the article (object) being loaded from the database
285 $content: the content (string) of the article
287 'ArticleDelete': before an article is deleted
288 $article: the article (object) being deleted
289 $user: the user (object) deleting the article
290 $reason: the reason (string) the article is being deleted
292 'ArticleDeleteComplete': after an article is deleted
293 $article: the article that was deleted
294 $user: the user that deleted the article
295 $reason: the reason the article was deleted
296 $id: id of the article that was deleted
298 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
299 $article: article (object) of the user talk page
301 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
302 $article: article (object) being modified
304 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
305 $title: title (object) used to create the article object
306 $article: article (object) that will be returned
308 'ArticleInsertComplete': After a new article is created
309 $article: Article created
310 $user: User creating the article
312 $summary: Edit summary/comment
313 $isMinor: Whether or not the edit was marked as minor
314 $isWatch: (No longer used)
315 $section: (No longer used)
316 $flags: Flags passed to Article::doEdit()
317 $revision: New Revision of the article
319 'ArticleMergeComplete': after merging to article using Special:Mergehistory
320 $targetTitle: target title (object)
321 $destTitle: destination title (object)
323 'ArticlePageDataAfter': after loading data of an article from the database
324 $article: article (object) whose data were loaded
325 $row: row (object) returned from the database server
327 'ArticlePageDataBefore': before loading data of an article from the database
328 $article: article (object) that data will be loaded
329 $fields: fileds (array) to load from the database
331 'ArticleProtect': before an article is protected
332 $article: the article being protected
333 $user: the user doing the protection
334 $protect: boolean whether this is a protect or an unprotect
335 $reason: Reason for protect
336 $moveonly: boolean whether this is for move only or not
338 'ArticleProtectComplete': after an article is protected
339 $article: the article that was protected
340 $user: the user who did the protection
341 $protect: boolean whether it was a protect or an unprotect
342 $reason: Reason for protect
343 $moveonly: boolean whether it was for move only or not
345 'ArticlePurge': before executing "&action=purge"
346 $article: article (object) to purge
348 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
349 revision of an article
350 &$title: title object of the article
352 'ArticleRevisionUndeleted': after an article revision is restored
353 $title: the article title
354 $revision: the revision
355 $oldPageID: the page ID of the revision when archived (may be null)
357 'ArticleRollbackComplete': after an article rollback is completed
358 $article: the article that was edited
359 $user: the user who did the rollback
360 $revision: the revision the page was reverted back to
362 'ArticleSave': before an article is saved
363 $article: the article (object) being saved
364 $user: the user (object) saving the article
365 $text: the new article text
366 $summary: the article summary (comment)
371 'ArticleSaveComplete': After an article has been updated
372 $article: Article modified
373 $user: User performing the modification
375 $summary: Edit summary/comment
376 $isMinor: Whether or not the edit was marked as minor
377 $isWatch: (No longer used)
378 $section: (No longer used)
379 $flags: Flags passed to Article::doEdit()
380 $revision: New Revision of the article
382 'ArticleSaveComplete': after an article is saved
383 $article: the article (object) saved
384 $user: the user (object) who saved the article
385 $text: the new article text
386 $summary: the article summary (comment)
391 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
393 'ArticleUndelete': When one or more revisions of an article are restored
394 $title: Title corresponding to the article restored
395 $create: Whether or not the restoration caused the page to be created
396 (i.e. it didn't exist before)
398 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
399 &$article: the article
400 &$sectionanchor: The section anchor link (e.g. "#overview" )
401 &$extraq: Extra query parameters which can be added via hooked functions
403 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
404 &$article: the article
405 &$pcache: whether to try the parser cache or not
406 &$outputDone: whether the output for this page finished or not
408 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
409 $article: target article (object)
411 'AuthPluginAutoCreate': Called when creating a local account for an user logged
412 in from an external authentication method
413 $user: User object created locally
415 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
416 Gives a chance for an extension to set it programattically to a variable class.
417 &$auth: the $wgAuth object, probably a stub
419 'AutopromoteCondition': check autopromote condition for user.
420 $type: condition type
423 $result: result of checking autopromote condition
425 'BadImage': When checking against the bad image list
426 $name: Image name being checked
427 &$bad: Whether or not the image is "bad"
429 Change $bad and return false to override. If an image is "bad", it is not
430 rendered inline in wiki pages or galleries in category pages.
432 'BeforeGalleryFindFile': before an image is fetched for a gallery
433 &$gallery,: the gallery object
434 &$nt: the image title
435 &$time: image timestamp
437 'BeforePageDisplay': Prior to outputting a page
438 &$out: OutputPage object
441 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
442 &$parser: Parser object
443 &$title: title of the template
444 &$skip: skip this template and link it?
445 &$id: the id of the revision being parsed
447 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
448 &$parser: Parser object
449 &$nt: the image title
450 &$skip: skip this image and link it?
451 &$time: the image timestamp
453 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
454 &$parser: Parser object
455 &$ig: ImageGallery object
457 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
458 $nondefaults: Assoc array with the following keys:
459 days, hideOwn, hideBots, hideMinor, namespace
461 &$hookSql: a string which will be inserted without sanitation into the SQL query
462 used to get the watchlist, at the end of the WHERE part.
464 'BlockIp': before an IP address or user is blocked
465 $block: the Block object about to be saved
466 $user: the user _doing_ the block (not the one being blocked)
468 'BlockIpComplete': after an IP address or user is blocked
469 $block: the Block object that was saved
470 $user: the user who did the block (not the one being blocked)
472 'BookInformation': Before information output on Special:Booksources
473 $isbn: ISBN to show information for
474 $output: OutputPage object in use
476 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
477 &$linker: Linker instance
479 $query: the URL query string passed in
480 &$u: the URL of this link
481 &$style: the inline CSS style
482 &$prefix: a prefix prepended to the linked text
483 &$text: the text placed by the user in the wiki-link
484 &$inside: any additional alphanumeric characters placed after the wiki-link,
485 that are made part of the link text
486 &$trail: text placed immediately after the HTML link
488 'CategoryPageView': before viewing a categorypage in CategoryPage::view
489 $catpage: CategoryPage instance
491 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
492 &$this: ChangesList instance.
493 &$articlelink: HTML of link to article (already filled-in).
494 &$s: HTML of row that is being constructed.
495 &$rc: RecentChange instance.
496 $unpatrolled: Whether or not we are showing unpatrolled changes.
497 $watched: Whether or not the change is watched by the user.
499 'ContributionsToolLinks': Change tool links above Special:Contributions
501 $title: User page title
502 &$tools: Array of tool links
504 'CustomEditor': When invoking the page editor
505 $article: Article being edited
506 $user: User performing the edit
508 Return true to allow the normal editor to be used, or false
509 if implementing a custom editor, e.g. for a special namespace,
512 'DiffViewHeader': called before diff display
513 $diff: DifferenceEngine object that's calling
514 $oldRev: Revision object of the "old" revision (may be null/invalid)
515 $newRev: Revision object of the "new" revision
517 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
518 $article: article (object) being viewed
519 $oldid: oldid (int) being viewed
521 'EditFilter': Perform checks on an edit
522 $editor: Edit form (see includes/EditPage.php)
523 $text: Contents of the edit box
524 $section: Section being edited
525 &$error: Error message to return
526 $summary: Edit summary for page
528 'EditFilterMerged': Post-section-merge edit filter
529 $editor: EditPage instance (object)
530 $text: content of the edit box
531 $error: error message to return
532 $summary: Edit summary for page
534 'EditFormPreloadText': Allows population of the edit form when creating new pages
535 &$text: Text to preload with
536 &$title: Title object representing the page being created
538 'EditPage::attemptSave': called before an article is
539 saved, that is before insertNewArticle() is called
540 &$editpage_Obj: the current EditPage object
542 'EditPage::showEditForm:fields': allows injection of form field into edit form
543 &$editor: the EditPage instance for reference
544 &$out: an OutputPage instance to write to
545 return value is ignored (should always return true)
547 'EditPage::showEditForm:initial': before showing the edit form
548 $editor: EditPage instance (object)
550 Return false to halt editing; you'll need to handle error messages, etc. yourself.
551 Alternatively, modifying $error and returning true will cause the contents of $error
552 to be echoed at the top of the edit form as wikitext. Return true without altering
553 $error to allow the edit to proceed.
555 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
556 when there's an edit conflict. Return false to halt normal diff output; in
557 this case you're responsible for computing and outputting the entire "conflict"
558 part, i.e., the "difference between revisions" and "your text" headers and
560 &$editor: EditPage instance
561 &$out: OutputPage instance
563 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
564 &$editpage: The current EditPage object
565 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
567 'EditSectionLink': Override the return value of Linker::editSectionLink()
568 $skin: Skin rendering the UI
569 $title: Title being linked to
570 $section: Section to link to
572 $result: Result (alter this to override the generated links)
574 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
575 $skin: Skin rendering the UI
576 $title: Title being linked to
577 $section: Section to link to
578 $hint: Anchor title/tooltip attributes
580 $result: Result (alter this to override the generated links)
582 'EmailConfirmed': When checking that the user's email address is "confirmed"
583 $user: User being checked
584 $confirmed: Whether or not the email address is confirmed
585 This runs before the other checks, such as anonymity and the real check; return
586 true to allow those checks to occur, and false if checking is done.
588 'EmailUser': before sending email from one user to another
589 $to: address of receiving user
590 $from: address of sending user
591 $subject: subject of the mail
592 $text: text of the mail
594 'EmailUserComplete': after sending email from one user to another
595 $to: address of receiving user
596 $from: address of sending user
597 $subject: subject of the mail
598 $text: text of the mail
600 'FetchChangesList': When fetching the ChangesList derivative for a particular user
601 &$user: User the list is being fetched for
602 &$skin: Skin object to be used with the list
603 &$list: List object (defaults to NULL, change it to an object instance and return
604 false override the list derivative used)
606 'FileDeleteComplete': When a file is deleted
607 $file: reference to the deleted file
608 $oldimage: in case of the deletion of an old image, the name of the old file
609 $article: in case all revisions of the file are deleted a reference to the article
610 associated with the file.
611 $user: user who performed the deletion
614 'FileUpload': When a file upload occurs
615 $file : Image object representing the file that was uploaded
617 'FileUndeleteComplete': When a file is undeleted
618 $title: title object to the file
619 $fileVersions: array of undeleted versions. Empty if all versions were restored
620 $user: user who performed the undeletion
623 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
624 &$user: user to promote.
625 &$promote: groups that will be added.
627 'GetBlockedStatus': after loading blocking status of an user from the database
628 $user: user (object) being checked
630 'GetCacheVaryCookies': get cookies that should vary cache options
631 $out: OutputPage object
632 &$cookies: array of cookies name, add a value to it if you want to add a cookie
633 that have to vary cache options
635 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
636 $title: Title object of page
637 $url: string value as output (out parameter, can modify)
638 $query: query options passed to Title::getFullURL()
640 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
641 $title: Title object of page
642 $url: string value as output (out parameter, can modify)
643 $query: query options passed to Title::getInternalURL()
645 'GetLinkColours': modify the CSS class of an array of page links
646 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
647 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
649 'GetLocalURL': modify local URLs as output into page links
650 $title: Title object of page
651 $url: string value as output (out parameter, can modify)
652 $query: query options passed to Title::getLocalURL()
654 'getUserPermissionsErrors': Add a permissions error when permissions errors are
655 checked for. Use instead of userCan for most cases. Return false if the
656 user can't do it, and populate $result with the reason in the form of
657 array( messagename, param1, param2, ... ). For consistency, error messages
658 should be plain text with no special coloring, bolding, etc. to show that
659 they're errors; presenting them properly to the user as errors is done by
661 $title: Title object being checked against
662 $user : Current user object
663 $action: Action being checked
664 $result: User permissions error to add. If none, return true.
666 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
667 if expensive checks are enabled.
669 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
670 image insertion. You can skip the default logic entirely by returning
671 false, or just modify a few things using call-by-reference.
673 &$title: Title object of the image
674 &$file: File object, or false if it doesn't exist
675 &$frameParams: Various parameters with special meanings; see documentation in
676 includes/Linker.php for Linker::makeImageLink2
677 &$handlerParams: Various parameters with special meanings; see documentation in
678 includes/Linker.php for Linker::makeImageLink2
679 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
680 &$res: Final HTML output, used if you return false
683 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
684 the image on an image page
685 $imagePage: ImagePage object ($this)
688 'ImagePageFileHistoryLine': called when a file history line is contructed
690 $line: the HTML of the history line
691 $css: the line CSS class
693 'ImagePageFindFile': called when fetching the file associated with an image page
694 $page: ImagePage object
696 &$displayFile: displayed File object
698 'InitPreferencesForm': called at the end of PreferencesForm's constructor
699 $form: the PreferencesForm
700 $request: the web request to initialized from
702 'InternalParseBeforeLinks': during Parser's internalParse method before links but
703 after noinclude/includeonly/onlyinclude and other processing.
704 &$this: Parser object
705 &$text: string containing partially parsed text
706 &$this->mStripState: Parser's internal StripState object
708 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
709 $article: article (object) being checked
711 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
713 $result: Change this value to override the result of wfIsTrustedProxy()
715 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
716 tance to return false if the domain name doesn't match your organization
717 $addr: The e-mail address entered by the user
718 &$result: Set this and return false to override the internal checks
720 'isValidPassword': Override the result of User::isValidPassword()
721 $password: The password entered by the user
722 &$result: Set this and return false to override the internal checks
723 $user: User the password is being validated for
725 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
726 $magicExtensions: associative array of magic words synonyms
727 $lang: laguage code (string)
729 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
730 $specialPageAliases: associative array of magic words synonyms
731 $lang: laguage code (string)
733 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
735 &$text: the link text
736 &$link: the new link HTML (if returning false)
738 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
739 &$linksUpdate: the LinkUpdate object
741 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
742 &$linksUpdate: the LinkUpdate object
744 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
745 &$linksUpdate: the LinkUpdate object
747 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
749 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
751 'LocalFile::getHistory': called before file history query performed
754 $fields: select fields
757 $join_conds: JOIN conditions
759 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
760 No return data is accepted; this hook is for auditing only.
761 $user: the User object being authenticated against
762 $password: the password being submitted and found wanting
763 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
765 'LogLine': Processes a single log entry on Special:Log
766 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
768 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
769 to logging.log_action database field.
770 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
771 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
772 appears to contain anything.
773 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
774 &$revert: string that is displayed in the UI, similar to $comment.
775 $time: timestamp of the log entry (added in 1.12)
777 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
778 &$type: array of strings
780 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
781 &$typeText: array of strings
783 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
784 &$headerText: array of strings
786 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
787 &$actionText: array of strings
789 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
790 $magicWords: array of strings
792 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
793 $variableIDs: array of strings
795 'MarkPatrolled': before an edit is marked patrolled
796 $rcid: ID of the revision to be marked patrolled
797 $user: the user (object) marking the revision as patrolled
798 $wcOnlySysopsCanPatrol: config setting indicating whether the user
799 needs to be a sysop in order to mark an edit patrolled
801 'MarkPatrolledComplete': after an edit is marked patrolled
802 $rcid: ID of the revision marked as patrolled
803 $user: user (object) who marked the edit patrolled
804 $wcOnlySysopsCanPatrol: config setting indicating whether the user
805 must be a sysop to patrol the edit
807 'MathAfterTexvc': after texvc is executed when rendering mathematics
808 $mathRenderer: instance of MathRenderer
809 $errmsg: error message, in HTML (string). Nonempty indicates failure
810 of rendering the formula
812 'MediaWikiPerformAction': Override MediaWiki::performAction().
813 Use this to do something completely different, after the basic
814 globals have been set up, but before ordinary actions take place.
821 'MessagesPreLoad': When loading a message from the database
822 $title: title of the message (string)
823 $message: value (string), change it to the message you want to define
825 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
826 Note: this is only run for the Monobook skin. To add items to the toolbox
827 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
829 $tools: array of tools
831 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
832 $article: the article edited
833 $rev: the new revision
834 $baseID: the revision ID this was based off, if any
836 'OutputPageBeforeHTML': a page has been processed by the parser and
837 the resulting HTML is about to be displayed.
838 $parserOutput: the parserOutput (object) that corresponds to the page
839 $text: the text that will be displayed, in HTML (string)
841 'OutputPageParserOutput': after adding a parserOutput to $wgOut
842 $out: OutputPage instance (object)
843 $parserOutput: parserOutput instance being added in $out
845 'PageHistoryBeforeList': When a history page list is about to be constructed.
846 $article: the article that the history is loading for
848 'PageHistoryLineEnding' : right before the end <li> is added to a history line
849 $row: the revision row for this line
850 $s: the string representing this parsed line
852 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed
854 $queryInfo: the query parameters
856 'PageRenderingHash': alter the parser cache option hash key
857 A parser extension which depends on user options should install
858 this hook and append its values to the key.
859 $hash: reference to a hash key string which can be modified
861 'ParserAfterStrip': Same as ParserBeforeStrip
863 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
864 $parser: Parser object being used
865 $text: text that'll be returned
867 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
868 $parser: Parser object
870 $stripState: StripState instance being used
872 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
873 $parser: parser object
874 $text: text being parsed
875 $stripState: stripState used (object)
877 'ParserBeforeTidy': called before tidy and custom tags replacements
878 $parser: Parser object being used
881 'ParserClearState': called at the end of Parser::clearState()
882 $parser: Parser object being cleared
884 'ParserFirstCallInit': called when the parser initialises for the first time
885 &$parser: Parser object being cleared
887 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
888 $parser: Parser object
889 $varCache: array to store the value in case of multiples calls of the same magic word
890 $index: index (string) of the magic
891 $ret: value of the magic word (the hook should set it)
893 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
894 $parser: Parser object
895 $time: actual time (timestamp)
897 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
898 $parser: Parser object
899 $varCache: varaiable cache (array)
901 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
902 $parser: Parser object
903 $limitReport: text that will be included (without comment tags)
905 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
906 $title: title object representing the file
907 $file: file object that will be used to create the image
908 &$params: 2-D array of parameters
910 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
911 $parser: Parser object created
913 'ParserTestTables': alter the list of tables to duplicate when parser tests
914 are run. Use when page save hooks require the presence of custom tables
915 to ensure that tests continue to run properly.
916 &$tables: array of table names
918 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
919 my talk page, my contributions" etc).
921 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
922 &$title: Title object representing the current page
924 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
925 &$user : User performing the action
926 $action : Action being performed
927 &$result : Whether or not the action should be prevented
928 Change $result and return false to give a definitive answer, otherwise
929 the built-in rate limiting checks are used, if enabled.
931 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
932 $form : PreferencesForm object
933 &$html : HTML to append to
935 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
936 AJAX search suggestions. Put results into &$results outparam and return false.
937 $ns : array of int namespace keys to search in
938 $search : search term (not guaranteed to be conveniently normalized)
939 $limit : maximum number of results to return
940 &$results : out param: array of page names (strings)
942 'PrefsEmailAudit': called when user changes his email address
943 $user: User (object) changing his email address
944 $oldaddr: old email address (string)
945 $newaddr: new email address (string)
947 'PrefsPasswordAudit': called when user changes his password
948 $user: User (object) changing his passoword
949 $newPass: new password
950 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
952 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
953 &$obj: RawPage object
954 &$text: The text that's going to be the output
956 'RecentChange_save': called at the end of RecenChange::save()
957 $recentChange: RecentChange object
959 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
960 $form: the PreferencesForm
961 $out: output page to render to, probably $wgOut
963 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
964 $form: the PreferencesForm
965 $user: the User object to load preferences from
967 'RevisionInsertComplete': called after a revision is inserted into the DB
968 $revision: the Revision
970 'SavePreferences': called at the end of PreferencesForm::savePreferences;
971 returning false prevents the preferences from being saved.
972 $form: the PreferencesForm
973 $user: the User object to save preferences to
974 $message: change this to set an error message (ignored if the hook does not return false)
975 $old: old preferences of the user
977 'SearchUpdate': Prior to search update completion
979 $namespace : Page namespace
981 $text : Current text being indexed
983 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
984 $term : Search term string
985 &$title : Outparam; set to $title object and return false for a match
987 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
988 $text: Text being shown
989 $title: Title of the custom script/stylesheet page
990 $output: Current OutputPage object
992 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
993 &$siteNotice: HTML returned as the sitenotice
994 Return true to allow the normal method of notice selection/rendering to work,
995 or change the value of $siteNotice and return false to alter it.
997 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
998 &$siteNotice: HTML sitenotice
999 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1001 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1003 &$text: bottomScripts Text
1004 Append to $text to add additional text/scripts after the stock bottom scripts.
1006 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1008 &$subpages: Subpage links HTML
1009 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
1010 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
1012 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
1013 $sktemplate: SkinTemplate object
1014 $content_actions: array of tabs
1016 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
1017 $sktemplate: SkinTemplate object
1018 $nav_urls: array of tabs
1020 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1021 &$content_actions: Content actions
1022 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1025 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
1026 &$sktemplate: SkinTemplate object
1027 &$tpl: Template engine object
1029 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1030 $sktemplate: SkinTemplate object
1031 $res: set to true to prevent active tabs
1033 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1036 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1037 You can either create your own array, or alter the parameters for the normal one.
1038 &$this: The SkinTemplate instance.
1039 $title: Title instance for the page.
1040 $message: Visible label of tab.
1041 $selected: Whether this is a selected tab.
1042 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1043 &$classes: Array of CSS classes to apply.
1044 &$query: Query string to add to link.
1046 &$result: Complete assoc. array if you want to return true.
1048 'SkinTemplateTabs': called when finished to build the actions tabs
1049 $sktemplate: SkinTemplate object
1050 $content_actions: array of tabs
1052 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1053 $tools: array of tools
1055 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1056 $id: User identifier
1058 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1059 $pager: The UsersPager instance
1060 $query: The query array to be returned
1062 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1063 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1064 $row: Database row object
1066 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1067 $pager: The UsersPager instance
1068 $out: The header HTML
1070 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1071 $pager: The UsersPager instance
1072 $out: The header HTML
1074 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1075 $pager: The UsersPager instance
1076 $query: The query array to be returned
1078 'SpecialMovepageAfterMove': called after moving a page
1079 $movePage: MovePageForm object
1080 $oldTitle: old title (object)
1081 $newTitle: new title (object)
1083 'SpecialPageExecuteAfterPage': called after executing a special page
1084 Warning: Not all the special pages call this hook
1085 $specialPage: SpecialPage object
1086 $par: paramter passed to the special page (string)
1087 $funct: function called to execute the special page
1089 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1090 Warning: Not all the special pages call this hook
1091 $specialPage: SpecialPage object
1092 $par: paramter passed to the special page (string)
1093 $funct: function called to execute the special page
1095 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1096 Warning: Not all the special pages call this hook
1097 $specialPage: SpecialPage object
1098 $par: paramter passed to the special page (string)
1099 $funct: function called to execute the special page
1101 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1102 $list: list (array) of core special pages
1104 'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges
1105 &$extraOpts: array of added items, to which can be added
1106 $opts: FormOptions for this request
1108 'SpecialRecentChangesQuery': called when building sql query for SpecialRecentChanges
1109 &$conds: array of where conditionals for query
1110 &$tables: array of tables to be queried
1111 &$join_conds: join conditions for the tables
1112 $opts: FormOptions for this request
1114 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1115 $title: title object generated from the text entred by the user
1117 'SpecialSearchResults': called before search result display when there are matches
1118 $term: string of search term
1119 &$titleMatches: empty or SearchResultSet object
1120 &$textMatches: empty or SearchResultSet object
1122 'SpecialSearchNoResults': called before search result display when there are no matches
1123 $term: string of search term
1125 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1126 $extTypes: associative array of extensions types
1128 'TitleMoveComplete': after moving an article (title)
1131 $user: user who did the move
1132 $pageid: database ID of the page that's been moved
1133 $redirid: database ID of the created redirect
1135 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1136 $title: title object related to the revision
1137 $rev: revision (object) that will be viewed
1139 'UnknownAction': An unknown "action" has occured (useful for defining
1141 $action: action name
1142 $article: article "acted on"
1144 'UnwatchArticle': before a watch is removed from an article
1145 $user: user watching
1146 $article: article object to be removed
1148 'UnwatchArticle': after a watch is removed from an article
1149 $user: user that was watching
1150 $article: article object removed
1152 'UnwatchArticleComplete': after a watch is removed from an article
1153 $user: user that watched
1154 $article: article object that was watched
1156 'UploadForm:initial': before the upload form is generated
1157 $form: UploadForm object
1158 You might set the member-variables $uploadFormTextTop and
1159 $uploadFormTextAfterSummary to inject text (HTML) either before
1160 or after the editform.
1162 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1163 $form: UploadForm object
1164 Lets you poke at member variables like $mUploadDescription before the
1167 'UploadVerification': additional chances to reject an uploaded file
1168 string $saveName: destination file name
1169 string $tempName: filesystem path to the temporary file for checks
1170 string &$error: output: HTML error to show if upload canceled by returning false
1172 'UploadComplete': Upon completion of a file upload
1173 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1175 'UserArrayFromResult': called when creating an UserArray object from a database result
1176 &$userArray: set this to an object to override the default object returned
1177 $res: database result used to create the object
1179 'userCan': To interrupt/advise the "user can do X to Y article" check.
1180 If you want to display an error message, try getUserPermissionsErrors.
1181 $title: Title object being checked against
1182 $user : Current user object
1183 $action: Action being checked
1184 $result: Pointer to result returned if hook returns false. If null is returned,
1185 userCan checks are continued by internal code.
1187 'UserCanSendEmail': To override User::canSendEmail() permission check
1188 $user: User (object) whose permission is being checked
1189 &$canSend: bool set on input, can override on output
1192 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1193 $user: User (object) that'll clear the message
1195 'UserCreateForm': change to manipulate the login form
1196 $template: SimpleTemplate instance for the form
1198 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1199 $user: User to get groups for
1200 &$groups: Current effective groups
1202 'UserGetAllRights': after calculating a list of all available rights
1203 &$rights: Array of rights, which may be added to.
1205 'UserGetEmail': called when getting an user email address
1207 &$email: email, change this to override local email
1209 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1211 &$timestamp: timestamp, change this to override local email authentification timestamp
1213 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1214 &$groups: List of implicit (automatically-assigned) groups
1216 'UserGetRights': Called in User::getRights()
1217 $user: User to get rights for
1218 &$rights: Current rights
1220 'UserLoadDefaults': called when loading a default user
1224 'UserLoadFromSession': called to authenticate users on external/environmental means
1225 $user: user object being loaded
1226 &$result: set this to a boolean value to abort the normal authentification process
1228 'UserLoginComplete': after a user has logged in
1229 $user: the user object that was created on login
1230 $inject_html: Any HTML to inject after the "logged in" message.
1232 'UserLoginForm': change to manipulate the login form
1233 $template: SimpleTemplate instance for the form
1235 'UserLogout': before a user logs out
1236 $user: the user object that is about to be logged out
1238 'UserLogoutComplete': after a user has logged out
1239 $user: the user object _after_ logout (won't have name, ID, etc.)
1240 $inject_html: Any HTML to inject after the "logged out" message.
1241 $oldName: name of the user before logout (string)
1243 'UserRights': After a user's group memberships are changed
1244 $user : User object that was changed
1245 $add : Array of strings corresponding to groups added
1246 $remove: Array of strings corresponding to groups removed
1248 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1249 $user: user retrieving new talks messages
1250 $talks: array of new talks page(s)
1252 'UserSaveSettings': called when saving user settings
1255 'UserSetCookies': called when setting user cookies
1257 &$session: session array, will be added to $_SESSION
1258 &$cookies: cookies array mapping cookie name to its value
1260 'UserSetEmail': called when changing user email address
1262 &$email: new email, change this to override new email address
1264 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1266 &$timestamp: new timestamp, change this to override local email authentification timestamp
1268 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1269 $toggles: array of toggles to add
1271 'WatchArticle': before a watch is added to an article
1272 $user: user that will watch
1273 $article: article object to be watched
1275 'WatchArticleComplete': after a watch is added to an article
1276 $user: user that watched
1277 $article: article object watched
1279 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1280 $query: $wgQueryPages itself
1282 More hooks might be available but undocumented, you can execute
1283 ./maintenance/findhooks.php to find hidden one.