3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
66 # code to actually show the article goes here
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle($article) {
78 if (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('ArticleShowComplete', array(&$article));
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle($article) {
100 function reverseForExport($article) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once('extensions/ReverseTitle.php');
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array($object, 'someMethod');
147 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148 $wgHooks['EventName'][] = array($object); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction($param1, $param2)
157 someFunction($someData, $param1, $param2)
160 $object->onEventName($param1, $param2)
162 $object->someMethod($param1, $param2)
163 # object with method and data
164 $object->someMethod($someData, $param1, $param2)
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193 function ldapLogin($username, $password) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
203 A calling function or method uses the wfRunHooks() function to run the hooks
204 related to a particular event, like so:
210 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
211 # protect the article
212 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
217 wfRunHooks() returns true if the calling function should continue processing
218 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
219 error occurred, or one of the hooks handled the action already). Checking the
220 return value matters more for "before" hooks than for "complete" hooks.
222 Note that hook parameters are passed in an array; this is a necessary
223 inconvenience to make it possible to pass reference values (that can be changed)
224 into the hook code. Also note that earlier versions of wfRunHooks took a
225 variable number of arguments; the array() calling protocol came about after
228 ==Events and parameters==
230 This is a list of known events and parameters; please add to it if you're going
231 to add events to the MediaWiki code.
233 'AbortAutoblock': Return false to cancel an autoblock.
234 $autoblockip: The IP going to be autoblocked.
235 $block: The block from which the autoblock is coming.
237 'AbortLogin': Return false to cancel account login.
238 $user: the User object being authenticated against
239 $password: the password being submitted, not yet checked for validity
240 &$retval: a LoginForm class constant to return from authenticateUserData();
241 default is LoginForm::ABORTED. Note that the client may be using
242 a machine API rather than the HTML user interface.
244 'AbortMove': allows to abort moving an article (title)
247 $user: user who is doing the move
249 $reason: the reason for the move (added in 1.13)
251 'AbortNewAccount': Return false to cancel account creation.
252 $user: the User object about to be created (read-only, incomplete)
253 $message: out parameter: error message to display on abort
255 'AddNewAccount': after a user account is created
256 $user: the User object that was created. (Parameter added in 1.7)
257 $byEmail: true when account was created "by email" (added in 1.12)
259 'AjaxAddScript': Called in output page just before the initialisation
260 of the javascript ajax engine. The hook is only called when ajax
261 is enabled ( $wgUseAjax = true; ).
263 'AlternateEdit': before checking if an user can edit a page and
264 before showing the edit form ( EditPage::edit() ). This is triggered
266 $EditPage : the EditPage object
268 'APIEditBeforeSave': before saving a page with api.php?action=edit,
269 after processing request parameters. Return false to let the request
270 fail, returning an error message or an <edit result="Failure"> tag
271 if $resultArr was filled.
272 $EditPage : the EditPage object
273 $text : the new text of the article (has yet to be saved)
274 $resultArr : data in this array will be added to the API result
276 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
277 Every token has an action, which will be used in the intoken parameter
278 and in the output (actiontoken="..."), and a callback function which
279 should return the token, or false if the user isn't allowed to obtain
280 it. The prototype of the callback function is func($pageid, $title)
281 where $pageid is the page ID of the page the token is requested for
282 and $title is the associated Title object. In the hook, just add
283 your callback to the $tokenFunctions array and return true (returning
284 false makes no sense)
285 $tokenFunctions: array(action => callback)
287 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
288 Every token has an action, which will be used in the rvtoken parameter
289 and in the output (actiontoken="..."), and a callback function which
290 should return the token, or false if the user isn't allowed to obtain
291 it. The prototype of the callback function is func($pageid, $title, $rev)
292 where $pageid is the page ID of the page associated to the revision the
293 token is requested for, $title the associated Title object and $rev the
294 associated Revision object. In the hook, just add your callback to the
295 $tokenFunctions array and return true (returning false makes no sense)
296 $tokenFunctions: array(action => callback)
298 'ArticleAfterFetchContent': after fetching content of an article from the database
299 $article: the article (object) being loaded from the database
300 $content: the content (string) of the article
302 'ArticleDelete': before an article is deleted
303 $article: the article (object) being deleted
304 $user: the user (object) deleting the article
305 $reason: the reason (string) the article is being deleted
306 $error: if the deletion was prohibited, the (raw HTML) error message to display
309 'ArticleDeleteComplete': after an article is deleted
310 $article: the article that was deleted
311 $user: the user that deleted the article
312 $reason: the reason the article was deleted
313 $id: id of the article that was deleted
315 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
316 $article: article (object) of the user talk page
318 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
319 $article: article (object) being modified
321 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
322 $title: title (object) used to create the article object
323 $article: article (object) that will be returned
325 'ArticleInsertComplete': After a new article is created
326 $article: Article created
327 $user: User creating the article
329 $summary: Edit summary/comment
330 $isMinor: Whether or not the edit was marked as minor
331 $isWatch: (No longer used)
332 $section: (No longer used)
333 $flags: Flags passed to Article::doEdit()
334 $revision: New Revision of the article
336 'ArticleMergeComplete': after merging to article using Special:Mergehistory
337 $targetTitle: target title (object)
338 $destTitle: destination title (object)
340 'ArticlePageDataAfter': after loading data of an article from the database
341 $article: article (object) whose data were loaded
342 $row: row (object) returned from the database server
344 'ArticlePageDataBefore': before loading data of an article from the database
345 $article: article (object) that data will be loaded
346 $fields: fileds (array) to load from the database
348 'ArticleProtect': before an article is protected
349 $article: the article being protected
350 $user: the user doing the protection
351 $protect: boolean whether this is a protect or an unprotect
352 $reason: Reason for protect
353 $moveonly: boolean whether this is for move only or not
355 'ArticleProtectComplete': after an article is protected
356 $article: the article that was protected
357 $user: the user who did the protection
358 $protect: boolean whether it was a protect or an unprotect
359 $reason: Reason for protect
360 $moveonly: boolean whether it was for move only or not
362 'ArticlePurge': before executing "&action=purge"
363 $article: article (object) to purge
365 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
366 revision of an article
367 &$title: title object of the article
369 'ArticleRevisionUndeleted': after an article revision is restored
370 $title: the article title
371 $revision: the revision
372 $oldPageID: the page ID of the revision when archived (may be null)
374 'ArticleRollbackComplete': after an article rollback is completed
375 $article: the article that was edited
376 $user: the user who did the rollback
377 $revision: the revision the page was reverted back to
379 'ArticleSave': before an article is saved
380 $article: the article (object) being saved
381 $user: the user (object) saving the article
382 $text: the new article text
383 $summary: the article summary (comment)
388 'ArticleSaveComplete': After an article has been updated
389 $article: Article modified
390 $user: User performing the modification
392 $summary: Edit summary/comment
393 $isMinor: Whether or not the edit was marked as minor
394 $isWatch: (No longer used)
395 $section: (No longer used)
396 $flags: Flags passed to Article::doEdit()
397 $revision: New Revision of the article
399 'ArticleSaveComplete': after an article is saved
400 $article: the article (object) saved
401 $user: the user (object) who saved the article
402 $text: the new article text
403 $summary: the article summary (comment)
408 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
410 'ArticleUndelete': When one or more revisions of an article are restored
411 $title: Title corresponding to the article restored
412 $create: Whether or not the restoration caused the page to be created
413 (i.e. it didn't exist before)
415 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
416 &$article: the article
417 &$sectionanchor: The section anchor link (e.g. "#overview" )
418 &$extraq: Extra query parameters which can be added via hooked functions
420 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
421 &$article: the article
422 &$pcache: whether to try the parser cache or not
423 &$outputDone: whether the output for this page finished or not
425 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
426 $article: target article (object)
428 'AuthPluginAutoCreate': Called when creating a local account for an user logged
429 in from an external authentication method
430 $user: User object created locally
432 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
433 Gives a chance for an extension to set it programattically to a variable class.
434 &$auth: the $wgAuth object, probably a stub
436 'AutopromoteCondition': check autopromote condition for user.
437 $type: condition type
440 $result: result of checking autopromote condition
442 'BadImage': When checking against the bad image list
443 $name: Image name being checked
444 &$bad: Whether or not the image is "bad"
446 Change $bad and return false to override. If an image is "bad", it is not
447 rendered inline in wiki pages or galleries in category pages.
449 'BeforeGalleryFindFile': before an image is fetched for a gallery
450 &$gallery,: the gallery object
451 &$nt: the image title
452 &$time: image timestamp
454 'BeforePageDisplay': Prior to outputting a page
455 &$out: OutputPage object
458 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
459 &$parser: Parser object
460 &$title: title of the template
461 &$skip: skip this template and link it?
462 &$id: the id of the revision being parsed
464 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
465 &$parser: Parser object
466 &$nt: the image title
467 &$skip: skip this image and link it?
468 &$time: the image timestamp
470 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
471 &$parser: Parser object
472 &$ig: ImageGallery object
474 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
475 $nondefaults: Assoc array with the following keys:
476 days, hideOwn, hideBots, hideMinor, namespace
478 &$hookSql: a string which will be inserted without sanitation into the SQL query
479 used to get the watchlist, at the end of the WHERE part.
481 'BlockIp': before an IP address or user is blocked
482 $block: the Block object about to be saved
483 $user: the user _doing_ the block (not the one being blocked)
485 'BlockIpComplete': after an IP address or user is blocked
486 $block: the Block object that was saved
487 $user: the user who did the block (not the one being blocked)
489 'BookInformation': Before information output on Special:Booksources
490 $isbn: ISBN to show information for
491 $output: OutputPage object in use
493 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
494 &$linker: Linker instance
496 $query: the URL query string passed in
497 &$u: the URL of this link
498 &$style: the inline CSS style
499 &$prefix: a prefix prepended to the linked text
500 &$text: the text placed by the user in the wiki-link
501 &$inside: any additional alphanumeric characters placed after the wiki-link,
502 that are made part of the link text
503 &$trail: text placed immediately after the HTML link
505 'CategoryPageView': before viewing a categorypage in CategoryPage::view
506 $catpage: CategoryPage instance
508 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
509 &$this: ChangesList instance.
510 &$articlelink: HTML of link to article (already filled-in).
511 &$s: HTML of row that is being constructed.
512 &$rc: RecentChange instance.
513 $unpatrolled: Whether or not we are showing unpatrolled changes.
514 $watched: Whether or not the change is watched by the user.
516 'ContributionsToolLinks': Change tool links above Special:Contributions
518 $title: User page title
519 &$tools: Array of tool links
521 'CustomEditor': When invoking the page editor
522 $article: Article being edited
523 $user: User performing the edit
525 Return true to allow the normal editor to be used, or false
526 if implementing a custom editor, e.g. for a special namespace,
529 'DiffViewHeader': called before diff display
530 $diff: DifferenceEngine object that's calling
531 $oldRev: Revision object of the "old" revision (may be null/invalid)
532 $newRev: Revision object of the "new" revision
534 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
535 $article: article (object) being viewed
536 $oldid: oldid (int) being viewed
538 'EditFilter': Perform checks on an edit
539 $editor: Edit form (see includes/EditPage.php)
540 $text: Contents of the edit box
541 $section: Section being edited
542 &$error: Error message to return
543 $summary: Edit summary for page
545 'EditFilterMerged': Post-section-merge edit filter
546 $editor: EditPage instance (object)
547 $text: content of the edit box
548 $error: error message to return
549 $summary: Edit summary for page
551 'EditFormPreloadText': Allows population of the edit form when creating new pages
552 &$text: Text to preload with
553 &$title: Title object representing the page being created
555 'EditPage::attemptSave': called before an article is
556 saved, that is before insertNewArticle() is called
557 &$editpage_Obj: the current EditPage object
559 'EditPage::showEditForm:fields': allows injection of form field into edit form
560 &$editor: the EditPage instance for reference
561 &$out: an OutputPage instance to write to
562 return value is ignored (should always return true)
564 'EditPage::showEditForm:initial': before showing the edit form
565 $editor: EditPage instance (object)
567 Return false to halt editing; you'll need to handle error messages, etc. yourself.
568 Alternatively, modifying $error and returning true will cause the contents of $error
569 to be echoed at the top of the edit form as wikitext. Return true without altering
570 $error to allow the edit to proceed.
572 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
573 when there's an edit conflict. Return false to halt normal diff output; in
574 this case you're responsible for computing and outputting the entire "conflict"
575 part, i.e., the "difference between revisions" and "your text" headers and
577 &$editor: EditPage instance
578 &$out: OutputPage instance
580 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
581 &$editpage: The current EditPage object
582 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
584 'EditSectionLink': Override the return value of Linker::editSectionLink()
585 $skin: Skin rendering the UI
586 $title: Title being linked to
587 $section: Section to link to
589 $result: Result (alter this to override the generated links)
591 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
592 $skin: Skin rendering the UI
593 $title: Title being linked to
594 $section: Section to link to
595 $hint: Anchor title/tooltip attributes
597 $result: Result (alter this to override the generated links)
599 'EmailConfirmed': When checking that the user's email address is "confirmed"
600 $user: User being checked
601 $confirmed: Whether or not the email address is confirmed
602 This runs before the other checks, such as anonymity and the real check; return
603 true to allow those checks to occur, and false if checking is done.
605 'EmailUser': before sending email from one user to another
606 $to: address of receiving user
607 $from: address of sending user
608 $subject: subject of the mail
609 $text: text of the mail
611 'EmailUserComplete': after sending email from one user to another
612 $to: address of receiving user
613 $from: address of sending user
614 $subject: subject of the mail
615 $text: text of the mail
617 'FetchChangesList': When fetching the ChangesList derivative for a particular user
618 &$user: User the list is being fetched for
619 &$skin: Skin object to be used with the list
620 &$list: List object (defaults to NULL, change it to an object instance and return
621 false override the list derivative used)
623 'FileDeleteComplete': When a file is deleted
624 $file: reference to the deleted file
625 $oldimage: in case of the deletion of an old image, the name of the old file
626 $article: in case all revisions of the file are deleted a reference to the article
627 associated with the file.
628 $user: user who performed the deletion
631 'FileUpload': When a file upload occurs
632 $file : Image object representing the file that was uploaded
634 'FileUndeleteComplete': When a file is undeleted
635 $title: title object to the file
636 $fileVersions: array of undeleted versions. Empty if all versions were restored
637 $user: user who performed the undeletion
640 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
641 &$user: user to promote.
642 &$promote: groups that will be added.
644 'GetBlockedStatus': after loading blocking status of an user from the database
645 $user: user (object) being checked
647 'GetCacheVaryCookies': get cookies that should vary cache options
648 $out: OutputPage object
649 &$cookies: array of cookies name, add a value to it if you want to add a cookie
650 that have to vary cache options
652 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
653 $title: Title object of page
654 $url: string value as output (out parameter, can modify)
655 $query: query options passed to Title::getFullURL()
657 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
658 $title: Title object of page
659 $url: string value as output (out parameter, can modify)
660 $query: query options passed to Title::getInternalURL()
662 'GetLinkColours': modify the CSS class of an array of page links
663 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
664 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
666 'GetLocalURL': modify local URLs as output into page links
667 $title: Title object of page
668 $url: string value as output (out parameter, can modify)
669 $query: query options passed to Title::getLocalURL()
671 'getUserPermissionsErrors': Add a permissions error when permissions errors are
672 checked for. Use instead of userCan for most cases. Return false if the
673 user can't do it, and populate $result with the reason in the form of
674 array( messagename, param1, param2, ... ). For consistency, error messages
675 should be plain text with no special coloring, bolding, etc. to show that
676 they're errors; presenting them properly to the user as errors is done by
678 $title: Title object being checked against
679 $user : Current user object
680 $action: Action being checked
681 $result: User permissions error to add. If none, return true.
683 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
684 if expensive checks are enabled.
686 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
687 image insertion. You can skip the default logic entirely by returning
688 false, or just modify a few things using call-by-reference.
690 &$title: Title object of the image
691 &$file: File object, or false if it doesn't exist
692 &$frameParams: Various parameters with special meanings; see documentation in
693 includes/Linker.php for Linker::makeImageLink2
694 &$handlerParams: Various parameters with special meanings; see documentation in
695 includes/Linker.php for Linker::makeImageLink2
696 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
697 &$res: Final HTML output, used if you return false
700 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
701 the image on an image page
702 $imagePage: ImagePage object ($this)
705 'ImagePageFileHistoryLine': called when a file history line is contructed
707 $line: the HTML of the history line
708 $css: the line CSS class
710 'ImagePageFindFile': called when fetching the file associated with an image page
711 $page: ImagePage object
713 &$displayFile: displayed File object
715 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
716 $title: Title object ($wgTitle)
718 $ignoreRedirect: boolean to skip redirect check
719 $target: Title/string of redirect target
721 'InitPreferencesForm': called at the end of PreferencesForm's constructor
722 $form: the PreferencesForm
723 $request: the web request to initialized from
725 'InternalParseBeforeLinks': during Parser's internalParse method before links but
726 after noinclude/includeonly/onlyinclude and other processing.
727 &$this: Parser object
728 &$text: string containing partially parsed text
729 &$this->mStripState: Parser's internal StripState object
731 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
732 $article: article (object) being checked
734 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
736 $result: Change this value to override the result of wfIsTrustedProxy()
738 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
739 tance to return false if the domain name doesn't match your organization
740 $addr: The e-mail address entered by the user
741 &$result: Set this and return false to override the internal checks
743 'isValidPassword': Override the result of User::isValidPassword()
744 $password: The password entered by the user
745 &$result: Set this and return false to override the internal checks
746 $user: User the password is being validated for
748 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
749 $magicExtensions: associative array of magic words synonyms
750 $lang: laguage code (string)
752 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
753 $specialPageAliases: associative array of magic words synonyms
754 $lang: laguage code (string)
756 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just before the return
758 &$alt: the image's alt text
759 &$img: the new image HTML (if returning false)
761 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
763 &$text: the link text
764 &$link: the new link HTML (if returning false)
766 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
767 &$linksUpdate: the LinkUpdate object
769 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
770 &$linksUpdate: the LinkUpdate object
772 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
773 &$linksUpdate: the LinkUpdate object
775 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
777 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
779 'LocalFile::getHistory': called before file history query performed
782 $fields: select fields
785 $join_conds: JOIN conditions
787 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
788 No return data is accepted; this hook is for auditing only.
789 $user: the User object being authenticated against
790 $password: the password being submitted and found wanting
791 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
793 'LogLine': Processes a single log entry on Special:Log
794 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
796 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
797 to logging.log_action database field.
798 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
799 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
800 appears to contain anything.
801 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
802 &$revert: string that is displayed in the UI, similar to $comment.
803 $time: timestamp of the log entry (added in 1.12)
805 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
806 &$type: array of strings
808 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
809 &$typeText: array of strings
811 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
812 &$headerText: array of strings
814 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
815 &$actionText: array of strings
817 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
818 $magicWords: array of strings
820 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
821 $variableIDs: array of strings
823 'MarkPatrolled': before an edit is marked patrolled
824 $rcid: ID of the revision to be marked patrolled
825 $user: the user (object) marking the revision as patrolled
826 $wcOnlySysopsCanPatrol: config setting indicating whether the user
827 needs to be a sysop in order to mark an edit patrolled
829 'MarkPatrolledComplete': after an edit is marked patrolled
830 $rcid: ID of the revision marked as patrolled
831 $user: user (object) who marked the edit patrolled
832 $wcOnlySysopsCanPatrol: config setting indicating whether the user
833 must be a sysop to patrol the edit
835 'MathAfterTexvc': after texvc is executed when rendering mathematics
836 $mathRenderer: instance of MathRenderer
837 $errmsg: error message, in HTML (string). Nonempty indicates failure
838 of rendering the formula
840 'MediaWikiPerformAction': Override MediaWiki::performAction().
841 Use this to do something completely different, after the basic
842 globals have been set up, but before ordinary actions take place.
848 $this: The $mediawiki object
850 'MessagesPreLoad': When loading a message from the database
851 $title: title of the message (string)
852 $message: value (string), change it to the message you want to define
854 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
855 Note: this is only run for the Monobook skin. To add items to the toolbox
856 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
858 $tools: array of tools
860 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
861 $article: the article edited
862 $rev: the new revision
863 $baseID: the revision ID this was based off, if any
865 'NormalizeMessageKey': Called before the software gets the text of a message
866 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets displayed
867 &$key: the message being looked up. Change this to something else to change what message gets displayed (string)
868 &$useDB: whether or not to look up the message in the database (bool)
869 &$langCode: the language code to get the message for (string) - or -
870 whether to use the content language (true) or site language (false) (bool)
872 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
873 Hooks can alter or append to the array of URLs for search & suggestion formats.
874 &$urls: array of associative arrays with Url element attributes
876 'OutputPageBeforeHTML': a page has been processed by the parser and
877 the resulting HTML is about to be displayed.
878 $parserOutput: the parserOutput (object) that corresponds to the page
879 $text: the text that will be displayed, in HTML (string)
881 'OutputPageParserOutput': after adding a parserOutput to $wgOut
882 $out: OutputPage instance (object)
883 $parserOutput: parserOutput instance being added in $out
885 'OutputPageMakeCategoryLinks': links are about to be generated for the page's categories.
886 Implementations should return false if they generate the category links, so the default link generation is skipped.
887 $out: OutputPage instance (object)
888 $categories: associative array, keys are category names, values are category types ("normal" or "hidden")
889 $links: array, intended to hold the result. Must be an associative array with category types as keys and arrays of HTML links as values.
891 'PageHistoryBeforeList': When a history page list is about to be constructed.
892 $article: the article that the history is loading for
894 'PageHistoryLineEnding' : right before the end <li> is added to a history line
895 $row: the revision row for this line
896 $s: the string representing this parsed line
898 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed
900 $queryInfo: the query parameters
902 'PageRenderingHash': alter the parser cache option hash key
903 A parser extension which depends on user options should install
904 this hook and append its values to the key.
905 $hash: reference to a hash key string which can be modified
907 'ParserAfterStrip': Same as ParserBeforeStrip
909 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
910 $parser: Parser object being used
911 $text: text that'll be returned
913 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
914 $parser: Parser object
916 $stripState: StripState instance being used
918 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
919 $parser: parser object
920 $text: text being parsed
921 $stripState: stripState used (object)
923 'ParserBeforeTidy': called before tidy and custom tags replacements
924 $parser: Parser object being used
927 'ParserClearState': called at the end of Parser::clearState()
928 $parser: Parser object being cleared
930 'ParserFirstCallInit': called when the parser initialises for the first time
931 &$parser: Parser object being cleared
933 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
934 $parser: Parser object
935 $varCache: array to store the value in case of multiples calls of the same magic word
936 $index: index (string) of the magic
937 $ret: value of the magic word (the hook should set it)
939 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
940 $parser: Parser object
941 $time: actual time (timestamp)
943 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
944 $parser: Parser object
945 $varCache: varaiable cache (array)
947 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
948 $parser: Parser object
949 $limitReport: text that will be included (without comment tags)
951 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
952 $title: title object representing the file
953 $file: file object that will be used to create the image
954 &$params: 2-D array of parameters
956 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
957 $parser: Parser object created
959 'ParserTestTables': alter the list of tables to duplicate when parser tests
960 are run. Use when page save hooks require the presence of custom tables
961 to ensure that tests continue to run properly.
962 &$tables: array of table names
964 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
965 my talk page, my contributions" etc).
967 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
968 &$title: Title object representing the current page
970 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
971 &$user : User performing the action
972 $action : Action being performed
973 &$result : Whether or not the action should be prevented
974 Change $result and return false to give a definitive answer, otherwise
975 the built-in rate limiting checks are used, if enabled.
977 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
978 $form : PreferencesForm object
979 &$html : HTML to append to
981 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
982 AJAX search suggestions. Put results into &$results outparam and return false.
983 $ns : array of int namespace keys to search in
984 $search : search term (not guaranteed to be conveniently normalized)
985 $limit : maximum number of results to return
986 &$results : out param: array of page names (strings)
988 'PrefsEmailAudit': called when user changes his email address
989 $user: User (object) changing his email address
990 $oldaddr: old email address (string)
991 $newaddr: new email address (string)
993 'PrefsPasswordAudit': called when user changes his password
994 $user: User (object) changing his passoword
995 $newPass: new password
996 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
998 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
999 &$obj: RawPage object
1000 &$text: The text that's going to be the output
1002 'RecentChange_save': called at the end of RecenChange::save()
1003 $recentChange: RecentChange object
1005 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
1006 $form: the PreferencesForm
1007 $out: output page to render to, probably $wgOut
1009 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
1010 $form: the PreferencesForm
1011 $user: the User object to load preferences from
1013 'RevisionInsertComplete': called after a revision is inserted into the DB
1014 &$revision: the Revision
1015 $data: the data stored in old_text. The meaning depends on $flags: if external
1016 is set, it's the URL of the revision text in external storage; otherwise,
1017 it's the revision text itself. In either case, if gzip is set, the revision
1019 $flags: a comma-delimited list of strings representing the options used. May
1020 include: utf8 (this will always be set for new revisions); gzip; external.
1022 'SavePreferences': called at the end of PreferencesForm::savePreferences;
1023 returning false prevents the preferences from being saved.
1024 $form: the PreferencesForm
1025 $user: the User object to save preferences to
1026 $message: change this to set an error message (ignored if the hook does not return false)
1027 $old: old preferences of the user
1029 'SearchUpdate': Prior to search update completion
1031 $namespace : Page namespace
1033 $text : Current text being indexed
1035 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1036 $term : Search term string
1037 &$title : Outparam; set to $title object and return false for a match
1039 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1040 $text: Text being shown
1041 $title: Title of the custom script/stylesheet page
1042 $output: Current OutputPage object
1044 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1045 &$siteNotice: HTML returned as the sitenotice
1046 Return true to allow the normal method of notice selection/rendering to work,
1047 or change the value of $siteNotice and return false to alter it.
1049 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1050 &$siteNotice: HTML sitenotice
1051 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1053 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1055 &$text: bottomScripts Text
1056 Append to $text to add additional text/scripts after the stock bottom scripts.
1058 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1060 &$subpages: Subpage links HTML
1061 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
1062 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
1064 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
1065 $sktemplate: SkinTemplate object
1066 $content_actions: array of tabs
1068 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
1069 $sktemplate: SkinTemplate object
1070 $nav_urls: array of tabs
1072 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1073 &$content_actions: Content actions
1074 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1077 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
1078 &$sktemplate: SkinTemplate object
1079 &$tpl: Template engine object
1081 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1082 $sktemplate: SkinTemplate object
1083 $res: set to true to prevent active tabs
1085 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1088 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1089 You can either create your own array, or alter the parameters for the normal one.
1090 &$this: The SkinTemplate instance.
1091 $title: Title instance for the page.
1092 $message: Visible label of tab.
1093 $selected: Whether this is a selected tab.
1094 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1095 &$classes: Array of CSS classes to apply.
1096 &$query: Query string to add to link.
1098 &$result: Complete assoc. array if you want to return true.
1100 'SkinTemplateTabs': called when finished to build the actions tabs
1101 $sktemplate: SkinTemplate object
1102 $content_actions: array of tabs
1104 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1105 $tools: array of tools
1107 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1108 $id: User identifier
1110 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1111 $pager: The UsersPager instance
1112 $query: The query array to be returned
1114 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1115 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1116 $row: Database row object
1118 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1119 $pager: The UsersPager instance
1120 $out: The header HTML
1122 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1123 $pager: The UsersPager instance
1124 $out: The header HTML
1126 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1127 $pager: The UsersPager instance
1128 $query: The query array to be returned
1130 'SpecialMovepageAfterMove': called after moving a page
1131 $movePage: MovePageForm object
1132 $oldTitle: old title (object)
1133 $newTitle: new title (object)
1135 'SpecialPageExecuteAfterPage': called after executing a special page
1136 Warning: Not all the special pages call this hook
1137 $specialPage: SpecialPage object
1138 $par: paramter passed to the special page (string)
1139 $funct: function called to execute the special page
1141 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1142 Warning: Not all the special pages call this hook
1143 $specialPage: SpecialPage object
1144 $par: paramter passed to the special page (string)
1145 $funct: function called to execute the special page
1147 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1148 Warning: Not all the special pages call this hook
1149 $specialPage: SpecialPage object
1150 $par: paramter passed to the special page (string)
1151 $funct: function called to execute the special page
1153 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1154 $list: list (array) of core special pages
1156 'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges
1157 &$extraOpts: array of added items, to which can be added
1158 $opts: FormOptions for this request
1160 'SpecialRecentChangesQuery': called when building sql query for SpecialRecentChanges
1161 &$conds: array of where conditionals for query
1162 &$tables: array of tables to be queried
1163 &$join_conds: join conditions for the tables
1164 $opts: FormOptions for this request
1166 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1167 $title: title object generated from the text entred by the user
1169 'SpecialSearchResults': called before search result display when there are matches
1170 $term: string of search term
1171 &$titleMatches: empty or SearchResultSet object
1172 &$textMatches: empty or SearchResultSet object
1174 'SpecialSearchNoResults': called before search result display when there are no matches
1175 $term: string of search term
1177 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1178 $extTypes: associative array of extensions types
1180 'TitleMoveComplete': after moving an article (title)
1183 $user: user who did the move
1184 $pageid: database ID of the page that's been moved
1185 $redirid: database ID of the created redirect
1187 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1188 $title: title object related to the revision
1189 $rev: revision (object) that will be viewed
1191 'UnknownAction': An unknown "action" has occured (useful for defining
1193 $action: action name
1194 $article: article "acted on"
1196 'UnwatchArticle': before a watch is removed from an article
1197 $user: user watching
1198 $article: article object to be removed
1200 'UnwatchArticle': after a watch is removed from an article
1201 $user: user that was watching
1202 $article: article object removed
1204 'UnwatchArticleComplete': after a watch is removed from an article
1205 $user: user that watched
1206 $article: article object that was watched
1208 'UploadForm:initial': before the upload form is generated
1209 $form: UploadForm object
1210 You might set the member-variables $uploadFormTextTop and
1211 $uploadFormTextAfterSummary to inject text (HTML) either before
1212 or after the editform.
1214 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1215 $form: UploadForm object
1216 Lets you poke at member variables like $mUploadDescription before the
1219 'UploadVerification': additional chances to reject an uploaded file
1220 string $saveName: destination file name
1221 string $tempName: filesystem path to the temporary file for checks
1222 string &$error: output: HTML error to show if upload canceled by returning false
1224 'UploadComplete': Upon completion of a file upload
1225 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1227 'UserArrayFromResult': called when creating an UserArray object from a database result
1228 &$userArray: set this to an object to override the default object returned
1229 $res: database result used to create the object
1231 'userCan': To interrupt/advise the "user can do X to Y article" check.
1232 If you want to display an error message, try getUserPermissionsErrors.
1233 $title: Title object being checked against
1234 $user : Current user object
1235 $action: Action being checked
1236 $result: Pointer to result returned if hook returns false. If null is returned,
1237 userCan checks are continued by internal code.
1239 'UserCanSendEmail': To override User::canSendEmail() permission check
1240 $user: User (object) whose permission is being checked
1241 &$canSend: bool set on input, can override on output
1244 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1245 $user: User (object) that'll clear the message
1247 'UserCreateForm': change to manipulate the login form
1248 $template: SimpleTemplate instance for the form
1250 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1251 $user: User to get groups for
1252 &$groups: Current effective groups
1254 'UserGetAllRights': after calculating a list of all available rights
1255 &$rights: Array of rights, which may be added to.
1257 'UserGetEmail': called when getting an user email address
1259 &$email: email, change this to override local email
1261 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1263 &$timestamp: timestamp, change this to override local email authentification timestamp
1265 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1266 &$groups: List of implicit (automatically-assigned) groups
1268 'UserGetRights': Called in User::getRights()
1269 $user: User to get rights for
1270 &$rights: Current rights
1272 'UserLoadDefaults': called when loading a default user
1276 'UserLoadFromSession': called to authenticate users on external/environmental means
1277 $user: user object being loaded
1278 &$result: set this to a boolean value to abort the normal authentification process
1280 'UserLoginComplete': after a user has logged in
1281 $user: the user object that was created on login
1282 $inject_html: Any HTML to inject after the "logged in" message.
1284 'UserLoginForm': change to manipulate the login form
1285 $template: SimpleTemplate instance for the form
1287 'UserLogout': before a user logs out
1288 $user: the user object that is about to be logged out
1290 'UserLogoutComplete': after a user has logged out
1291 $user: the user object _after_ logout (won't have name, ID, etc.)
1292 $inject_html: Any HTML to inject after the "logged out" message.
1293 $oldName: name of the user before logout (string)
1295 'UserRights': After a user's group memberships are changed
1296 $user : User object that was changed
1297 $add : Array of strings corresponding to groups added
1298 $remove: Array of strings corresponding to groups removed
1300 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1301 $user: user retrieving new talks messages
1302 $talks: array of new talks page(s)
1304 'UserSaveSettings': called when saving user settings
1307 'UserSetCookies': called when setting user cookies
1309 &$session: session array, will be added to $_SESSION
1310 &$cookies: cookies array mapping cookie name to its value
1312 'UserSetEmail': called when changing user email address
1314 &$email: new email, change this to override new email address
1316 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1318 &$timestamp: new timestamp, change this to override local email authentification timestamp
1320 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1321 $toggles: array of toggles to add
1323 'WatchArticle': before a watch is added to an article
1324 $user: user that will watch
1325 $article: article object to be watched
1327 'WatchArticleComplete': after a watch is added to an article
1328 $user: user that watched
1329 $article: article object watched
1331 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1332 $query: $wgQueryPages itself
1334 More hooks might be available but undocumented, you can execute
1335 ./maintenance/findhooks.php to find hidden one.