diff options
Diffstat (limited to 'docs/hooks.txt')
| -rw-r--r-- | docs/hooks.txt | 500 |
1 files changed, 384 insertions, 116 deletions
diff --git a/docs/hooks.txt b/docs/hooks.txt index 9e27a8d0..286ed7e2 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -1,39 +1,38 @@ hooks.txt -This document describes how event hooks work in MediaWiki; how to add -hooks for an event; and how to run hooks for an event. +This document describes how event hooks work in MediaWiki; how to add hooks for +an event; and how to run hooks for an event. ==Glossary== event - Something that happens with the wiki. For example: a user logs - in. A wiki page is saved. A wiki page is deleted. Often there are - two events associated with a single action: one before the code - is run to make the event happen, and one after. Each event has a - name, preferably in CamelCase. For example, 'UserLogin', - 'ArticleSave', 'ArticleSaveComplete', 'ArticleDelete'. + Something that happens with the wiki. For example: a user logs in. A wiki + page is saved. A wiki page is deleted. Often there are two events + associated with a single action: one before the code is run to make the + event happen, and one after. Each event has a name, preferably in + CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete', + 'ArticleDelete'. hook - A clump of code and data that should be run when an event - happens. This can be either a function and a chunk of data, or an - object and a method. + A clump of code and data that should be run when an event happens. This can + be either a function and a chunk of data, or an object and a method. hook function The function part of a hook. ==Rationale== -Hooks allow us to decouple optionally-run code from code that is run -for everyone. It allows MediaWiki hackers, third-party developers and -local administrators to define code that will be run at certain points -in the mainline code, and to modify the data run by that mainline -code. Hooks can keep mainline code simple, and make it easier to -write extensions. Hooks are a principled alternative to local patches. +Hooks allow us to decouple optionally-run code from code that is run for +everyone. It allows MediaWiki hackers, third-party developers and local +administrators to define code that will be run at certain points in the mainline +code, and to modify the data run by that mainline code. Hooks can keep mainline +code simple, and make it easier to write extensions. Hooks are a principled +alternative to local patches. -Consider, for example, two options in MediaWiki. One reverses the -order of a title before displaying the article; the other converts the -title to all uppercase letters. Currently, in MediaWiki code, we -would handle this as follows (note: not real code, here): +Consider, for example, two options in MediaWiki. One reverses the order of a +title before displaying the article; the other converts the title to all +uppercase letters. Currently, in MediaWiki code, we would handle this as follows +(note: not real code, here): function showAnArticle($article) { global $wgReverseTitle, $wgCapitalizeTitle; @@ -49,31 +48,30 @@ would handle this as follows (note: not real code, here): # code to actually show the article goes here } -An extension writer, or a local admin, will often add custom code to -the function -- with or without a global variable. For example, -someone wanting email notification when an article is shown may add: +An extension writer, or a local admin, will often add custom code to the +function -- with or without a global variable. For example, someone wanting +email notification when an article is shown may add: function showAnArticle($article) { - global $wgReverseTitle, $wgCapitalizeTitle; + global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle; - if ($wgReverseTitle) { - wfReverseTitle($article); - } + if ($wgReverseTitle) { + wfReverseTitle($article); + } - if ($wgCapitalizeTitle) { - wfCapitalizeTitle($article); - } + if ($wgCapitalizeTitle) { + wfCapitalizeTitle($article); + } - # code to actually show the article goes here + # code to actually show the article goes here - if ($wgNotifyArticle) { - wfNotifyArticleShow($article)); - } + if ($wgNotifyArticle) { + wfNotifyArticleShow($article)); + } } -Using a hook-running strategy, we can avoid having all this -option-specific stuff in our mainline code. Using hooks, the function -becomes: +Using a hook-running strategy, we can avoid having all this option-specific +stuff in our mainline code. Using hooks, the function becomes: function showAnArticle($article) { @@ -85,16 +83,15 @@ becomes: } } -We've cleaned up the code here by removing clumps of weird, -infrequently used code and moving them off somewhere else. It's much -easier for someone working with this code to see what's _really_ going -on, and make changes or fix bugs. +We've cleaned up the code here by removing clumps of weird, infrequently used +code and moving them off somewhere else. It's much easier for someone working +with this code to see what's _really_ going on, and make changes or fix bugs. -In addition, we can take all the code that deals with the little-used -title-reversing options (say) and put it in one place. Instead of -having little title-reversing if-blocks spread all over the codebase -in showAnArticle, deleteAnArticle, exportArticle, etc., we can -concentrate it all in an extension file: +In addition, we can take all the code that deals with the little-used +title-reversing options (say) and put it in one place. Instead of having little +title-reversing if-blocks spread all over the codebase in showAnArticle, +deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension +file: function reverseArticleTitle($article) { # ... @@ -104,8 +101,8 @@ concentrate it all in an extension file: # ... } -The setup function for the extension just has to add its hook -functions to the appropriate events: +The setup function for the extension just has to add its hook functions to the +appropriate events: setupTitleReversingExtension() { global $wgHooks; @@ -115,23 +112,21 @@ functions to the appropriate events: $wgHooks['ArticleExport'][] = 'reverseForExport'; } -Having all this code related to the title-reversion option in one -place means that it's easier to read and understand; you don't have to -do a grep-find to see where the $wgReverseTitle variable is used, say. +Having all this code related to the title-reversion option in one place means +that it's easier to read and understand; you don't have to do a grep-find to see +where the $wgReverseTitle variable is used, say. -If the code is well enough isolated, it can even be excluded when not -used -- making for some slight savings in memory and load-up -performance at runtime. Admins who want to have all the reversed -titles can add: +If the code is well enough isolated, it can even be excluded when not used -- +making for some slight savings in memory and load-up performance at runtime. +Admins who want to have all the reversed titles can add: require_once('extensions/ReverseTitle.php'); -...to their LocalSettings.php file; those of us who don't want or need -it can just leave it out. +...to their LocalSettings.php file; those of us who don't want or need it can +just leave it out. -The extensions don't even have to be shipped with MediaWiki; they -could be provided by a third-party developer or written by the admin -him/herself. +The extensions don't even have to be shipped with MediaWiki; they could be +provided by a third-party developer or written by the admin him/herself. ==Writing hooks== @@ -140,8 +135,8 @@ A hook is a chunk of code run at some particular event. It consists of: * a function with some optional accompanying data, or * an object with a method and some optional accompanying data. -Hooks are registered by adding them to the global $wgHooks array for a -given event. All the following are valid ways to define hooks: +Hooks are registered by adding them to the global $wgHooks array for a given +event. All the following are valid ways to define hooks: $wgHooks['EventName'][] = 'someFunction'; # function, no data $wgHooks['EventName'][] = array('someFunction', $someData); @@ -152,10 +147,9 @@ given event. All the following are valid ways to define hooks: $wgHooks['EventName'][] = array($object, 'someMethod', $someData); $wgHooks['EventName'][] = array($object); # weird but OK -When an event occurs, the function (or object method) will be called -with the optional data provided as well as event-specific parameters. -The above examples would result in the following code being executed -when 'EventName' happened: +When an event occurs, the function (or object method) will be called with the +optional data provided as well as event-specific parameters. The above examples +would result in the following code being executed when 'EventName' happened: # function, no data someFunction($param1, $param2) @@ -169,31 +163,30 @@ when 'EventName' happened: # object with method and data $object->someMethod($someData, $param1, $param2) -Note that when an object is the hook, and there's no specified method, -the default method called is 'onEventName'. For different events this -would be different: 'onArticleSave', 'onUserLogin', etc. +Note that when an object is the hook, and there's no specified method, the +default method called is 'onEventName'. For different events this would be +different: 'onArticleSave', 'onUserLogin', etc. -The extra data is useful if we want to use the same function or object -for different purposes. For example: +The extra data is useful if we want to use the same function or object for +different purposes. For example: $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling'); $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion'); -This code would result in ircNotify being run twice when an article is -saved: once for 'TimStarling', and once for 'brion'. +This code would result in ircNotify being run twice when an article is saved: +once for 'TimStarling', and once for 'brion'. Hooks can return three possible values: * true: the hook has operated successfully - * "some string": an error occurred; processing should - stop and the error should be shown to the user - * false: the hook has successfully done the work - necessary and the calling function should skip + * "some string": an error occurred; processing should stop and the error + should be shown to the user + * false: the hook has successfully done the work necessary and the calling + function should skip -The last result would be for cases where the hook function replaces -the main functionality. For example, if you wanted to authenticate -users to a custom system (LDAP, another PHP program, whatever), you -could do: +The last result would be for cases where the hook function replaces the main +functionality. For example, if you wanted to authenticate users to a custom +system (LDAP, another PHP program, whatever), you could do: $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer); @@ -202,13 +195,13 @@ could do: return false; } -Returning false makes less sense for events where the action is -complete, and will normally be ignored. +Returning false makes less sense for events where the action is complete, and +will normally be ignored. ==Using hooks== -A calling function or method uses the wfRunHooks() function to run -the hooks related to a particular event, like so: +A calling function or method uses the wfRunHooks() function to run the hooks +related to a particular event, like so: class Article { # ... @@ -221,22 +214,25 @@ the hooks related to a particular event, like so: } } -wfRunHooks() returns true if the calling function should continue -processing (the hooks ran OK, or there are no hooks to run), or false -if it shouldn't (an error occurred, or one of the hooks handled the -action already). Checking the return value matters more for "before" -hooks than for "complete" hooks. +wfRunHooks() returns true if the calling function should continue processing +(the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an +error occurred, or one of the hooks handled the action already). Checking the +return value matters more for "before" hooks than for "complete" hooks. Note that hook parameters are passed in an array; this is a necessary -inconvenience to make it possible to pass reference values (that can -be changed) into the hook code. Also note that earlier versions of -wfRunHooks took a variable number of arguments; the array() calling -protocol came about after MediaWiki 1.4rc1. +inconvenience to make it possible to pass reference values (that can be changed) +into the hook code. Also note that earlier versions of wfRunHooks took a +variable number of arguments; the array() calling protocol came about after +MediaWiki 1.4rc1. ==Events and parameters== -This is a list of known events and parameters; please add to it if -you're going to add events to the MediaWiki code. +This is a list of known events and parameters; please add to it if you're going +to add events to the MediaWiki code. + +'AbortAutoblock': Return false to cancel an autoblock. +$autoblockip: The IP going to be autoblocked. +$block: The block from which the autoblock is coming. 'AbortLogin': Return false to cancel account login. $user: the User object being authenticated against @@ -250,6 +246,7 @@ $old: old title $nt: new title $user: user who is doing the move $err: error message +$reason: the reason for the move (added in 1.13) 'AbortNewAccount': Return false to cancel account creation. $user: the User object about to be created (read-only, incomplete) @@ -268,6 +265,36 @@ before showing the edit form ( EditPage::edit() ). This is triggered on &action=edit. $EditPage : the EditPage object +'APIEditBeforeSave': before saving a page with api.php?action=edit, +after processing request parameters. Return false to let the request +fail, returning an error message or an <edit result="Failure"> tag +if $resultArr was filled. +$EditPage : the EditPage object +$text : the new text of the article (has yet to be saved) +$resultArr : data in this array will be added to the API result + +'APIQueryInfoTokens': use this hook to add custom tokens to prop=info. +Every token has an action, which will be used in the intoken parameter +and in the output (actiontoken="..."), and a callback function which +should return the token, or false if the user isn't allowed to obtain +it. The prototype of the callback function is func($pageid, $title) +where $pageid is the page ID of the page the token is requested for +and $title is the associated Title object. In the hook, just add +your callback to the $tokenFunctions array and return true (returning +false makes no sense) +$tokenFunctions: array(action => callback) + +'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions. +Every token has an action, which will be used in the rvtoken parameter +and in the output (actiontoken="..."), and a callback function which +should return the token, or false if the user isn't allowed to obtain +it. The prototype of the callback function is func($pageid, $title, $rev) +where $pageid is the page ID of the page associated to the revision the +token is requested for, $title the associated Title object and $rev the +associated Revision object. In the hook, just add your callback to the +$tokenFunctions array and return true (returning false makes no sense) +$tokenFunctions: array(action => callback) + 'ArticleAfterFetchContent': after fetching content of an article from the database $article: the article (object) being loaded from the database $content: the content (string) of the article @@ -276,11 +303,14 @@ $content: the content (string) of the article $article: the article (object) being deleted $user: the user (object) deleting the article $reason: the reason (string) the article is being deleted +$error: if the deletion was prohibited, the (raw HTML) error message to display + (added in 1.13) 'ArticleDeleteComplete': after an article is deleted $article: the article that was deleted $user: the user that deleted the article $reason: the reason the article was deleted +$id: id of the article that was deleted 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed $article: article (object) of the user talk page @@ -292,7 +322,7 @@ $article: article (object) being modified $title: title (object) used to create the article object $article: article (object) that will be returned -'ArticleInsertComplete': After an article is created +'ArticleInsertComplete': After a new article is created $article: Article created $user: User creating the article $text: New content @@ -332,7 +362,11 @@ $moveonly: boolean whether it was for move only or not 'ArticlePurge': before executing "&action=purge" $article: article (object) to purge -'ArticleRevisionUndeleted' after an article revision is restored +'ArticleRevisionVisiblitySet': called when changing visibility of one or more +revision of an article +&$title: title object of the article + +'ArticleRevisionUndeleted': after an article revision is restored $title: the article title $revision: the revision $oldPageID: the page ID of the revision when archived (may be null) @@ -391,13 +425,14 @@ $create: Whether or not the restoration caused the page to be created 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect $article: target article (object) +'AuthPluginAutoCreate': Called when creating a local account for an user logged +in from an external authentication method +$user: User object created locally + 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth) Gives a chance for an extension to set it programattically to a variable class. &$auth: the $wgAuth object, probably a stub -'AutoAuthenticate': called to authenticate users on external/environmental means -$user: writes user object to this parameter - 'AutopromoteCondition': check autopromote condition for user. $type: condition type $args: arguments @@ -417,7 +452,8 @@ rendered inline in wiki pages or galleries in category pages. &$time: image timestamp 'BeforePageDisplay': Prior to outputting a page -$out: OutputPage object +&$out: OutputPage object +&$skin: Skin object 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser &$parser: Parser object @@ -454,6 +490,18 @@ $user: the user who did the block (not the one being blocked) $isbn: ISBN to show information for $output: OutputPage object in use +'BrokenLink': Before the HTML is created for a broken (i.e. red) link +&$linker: Linker instance +$nt: the page title +$query: the URL query string passed in +&$u: the URL of this link +&$style: the inline CSS style +&$prefix: a prefix prepended to the linked text +&$text: the text placed by the user in the wiki-link +&$inside: any additional alphanumeric characters placed after the wiki-link, +that are made part of the link text +&$trail: text placed immediately after the HTML link + 'CategoryPageView': before viewing a categorypage in CategoryPage::view $catpage: CategoryPage instance @@ -465,6 +513,15 @@ $catpage: CategoryPage instance $unpatrolled: Whether or not we are showing unpatrolled changes. $watched: Whether or not the change is watched by the user. +'ContribsPager::getQueryInfo': Before the contributions query is about to run +&$pager: Pager object for contributions +&queryInfo: The query for the contribs Pager + +'ContributionsLineEnding': Called before a contributions HTML line is finished +$page: SpecialPage object for contributions +$ret: the HTML line +$row: the DB row for this line + 'ContributionsToolLinks': Change tool links above Special:Contributions $id: User identifier $title: User page title @@ -492,11 +549,13 @@ $editor: Edit form (see includes/EditPage.php) $text: Contents of the edit box $section: Section being edited &$error: Error message to return +$summary: Edit summary for page 'EditFilterMerged': Post-section-merge edit filter $editor: EditPage instance (object) $text: content of the edit box $error: error message to return +$summary: Edit summary for page 'EditFormPreloadText': Allows population of the edit form when creating new pages &$text: Text to preload with @@ -519,6 +578,14 @@ Alternatively, modifying $error and returning true will cause the contents of $e to be echoed at the top of the edit form as wikitext. Return true without altering $error to allow the edit to proceed. +'EditPageBeforeConflictDiff': allows modifying the EditPage object and output +when there's an edit conflict. Return false to halt normal diff output; in +this case you're responsible for computing and outputting the entire "conflict" +part, i.e., the "difference between revisions" and "your text" headers and +sections. +&$editor: EditPage instance +&$out: OutputPage instance + 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form &$editpage: The current EditPage object &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff" @@ -562,12 +629,35 @@ $text: text of the mail &$list: List object (defaults to NULL, change it to an object instance and return false override the list derivative used) +'FileDeleteComplete': When a file is deleted +$file: reference to the deleted file +$oldimage: in case of the deletion of an old image, the name of the old file +$article: in case all revisions of the file are deleted a reference to the article + associated with the file. +$user: user who performed the deletion +$reason: reason + 'FileUpload': When a file upload occurs $file : Image object representing the file that was uploaded +'FileUndeleteComplete': When a file is undeleted +$title: title object to the file +$fileVersions: array of undeleted versions. Empty if all versions were restored +$user: user who performed the undeletion +$reason: reason + +'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in. +&$user: user to promote. +&$promote: groups that will be added. + 'GetBlockedStatus': after loading blocking status of an user from the database $user: user (object) being checked +'GetCacheVaryCookies': get cookies that should vary cache options +$out: OutputPage object +&$cookies: array of cookies name, add a value to it if you want to add a cookie + that have to vary cache options + 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data $title: Title object of page $url: string value as output (out parameter, can modify) @@ -602,10 +692,41 @@ $result: User permissions error to add. If none, return true. 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only if expensive checks are enabled. -'ImageOpenShowImageInlineBefore': Call potential extension just before showing the image on an image page +'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki + image insertion. You can skip the default logic entirely by returning + false, or just modify a few things using call-by-reference. +&$this: Skin object +&$title: Title object of the image +&$file: File object, or false if it doesn't exist +&$frameParams: Various parameters with special meanings; see documentation in + includes/Linker.php for Linker::makeImageLink2 +&$handlerParams: Various parameters with special meanings; see documentation in + includes/Linker.php for Linker::makeImageLink2 +&$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current +&$res: Final HTML output, used if you return false + + +'ImageOpenShowImageInlineBefore': Call potential extension just before showing + the image on an image page $imagePage: ImagePage object ($this) $output: $wgOut +'ImagePageFileHistoryLine': called when a file history line is contructed +$file: the file +$line: the HTML of the history line +$css: the line CSS class + +'ImagePageFindFile': called when fetching the file associated with an image page +$page: ImagePage object +&$file: File object +&$displayFile: displayed File object + +'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect +$title: Title object ($wgTitle) +$request: WebRequest +$ignoreRedirect: boolean to skip redirect check +$target: Title/string of redirect target + 'InitPreferencesForm': called at the end of PreferencesForm's constructor $form: the PreferencesForm $request: the web request to initialized from @@ -641,6 +762,16 @@ $lang: laguage code (string) $specialPageAliases: associative array of magic words synonyms $lang: laguage code (string) +'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just before the return +&$url: the image url +&$alt: the image's alt text +&$img: the new image HTML (if returning false) + +'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return +&$url: the link url +&$text: the link text +&$link: the new link HTML (if returning false) + 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update &$linksUpdate: the LinkUpdate object @@ -654,6 +785,14 @@ $lang: laguage code (string) 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema +'LocalFile::getHistory': called before file history query performed +$file: the file +$tables: tables +$fields: select fields +$conds: conditions +$opts: query options +$join_conds: JOIN conditions + 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed. No return data is accepted; this hook is for auditing only. $user: the User object being authenticated against @@ -715,14 +854,35 @@ $article: $wgArticle $title: $wgTitle $user: $wgUser $request: $wgRequest +$this: The $mediawiki object 'MessagesPreLoad': When loading a message from the database $title: title of the message (string) $message: value (string), change it to the message you want to define 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more) +Note: this is only run for the Monobook skin. To add items to the toolbox +for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook +instead. $tools: array of tools +'NewRevisionFromEditComplete': called when a revision was inserted due to an edit +$article: the article edited +$rev: the new revision +$baseID: the revision ID this was based off, if any + +'NormalizeMessageKey': Called before the software gets the text of a message + (stuff in the MediaWiki: namespace), useful for changing WHAT message gets displayed +&$key: the message being looked up. Change this to something else to change what message gets displayed (string) +&$useDB: whether or not to look up the message in the database (bool) +&$langCode: the language code to get the message for (string) - or - + whether to use the content language (true) or site language (false) (bool) +&$transform: whether or not to expand variables and templates in the message (bool) + +'OpenSearchUrls': Called when constructing the OpenSearch description XML. +Hooks can alter or append to the array of URLs for search & suggestion formats. +&$urls: array of associative arrays with Url element attributes + 'OutputPageBeforeHTML': a page has been processed by the parser and the resulting HTML is about to be displayed. $parserOutput: the parserOutput (object) that corresponds to the page @@ -732,6 +892,12 @@ $text: the text that will be displayed, in HTML (string) $out: OutputPage instance (object) $parserOutput: parserOutput instance being added in $out +'OutputPageMakeCategoryLinks': links are about to be generated for the page's categories. + Implementations should return false if they generate the category links, so the default link generation is skipped. +$out: OutputPage instance (object) +$categories: associative array, keys are category names, values are category types ("normal" or "hidden") +$links: array, intended to hold the result. Must be an associative array with category types as keys and arrays of HTML links as values. + 'PageHistoryBeforeList': When a history page list is about to be constructed. $article: the article that the history is loading for @@ -739,6 +905,10 @@ $article: the article that the history is loading for $row: the revision row for this line $s: the string representing this parsed line +'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed +$pager: the pager +$queryInfo: the query parameters + 'PageRenderingHash': alter the parser cache option hash key A parser extension which depends on user options should install this hook and append its values to the key. @@ -767,8 +937,8 @@ $text: actual text 'ParserClearState': called at the end of Parser::clearState() $parser: Parser object being cleared -'ParserFirstCallInit': called when the ther parser initialises for the first time -$parser: Parser object being cleared +'ParserFirstCallInit': called when the parser initialises for the first time +&$parser: Parser object being cleared 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word $parser: Parser object @@ -788,6 +958,11 @@ $varCache: varaiable cache (array) $parser: Parser object $limitReport: text that will be included (without comment tags) +'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image. +$title: title object representing the file +$file: file object that will be used to create the image +&$params: 2-D array of parameters + 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc $parser: Parser object created @@ -815,7 +990,7 @@ $form : PreferencesForm object 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and AJAX search suggestions. Put results into &$results outparam and return false. -$ns : int namespace key to search in +$ns : array of int namespace keys to search in $search : search term (not guaranteed to be conveniently normalized) $limit : maximum number of results to return &$results : out param: array of page names (strings) @@ -845,11 +1020,21 @@ $out: output page to render to, probably $wgOut $form: the PreferencesForm $user: the User object to load preferences from +'RevisionInsertComplete': called after a revision is inserted into the DB +&$revision: the Revision +$data: the data stored in old_text. The meaning depends on $flags: if external + is set, it's the URL of the revision text in external storage; otherwise, + it's the revision text itself. In either case, if gzip is set, the revision + text is gzipped. +$flags: a comma-delimited list of strings representing the options used. May + include: utf8 (this will always be set for new revisions); gzip; external. + 'SavePreferences': called at the end of PreferencesForm::savePreferences; returning false prevents the preferences from being saved. $form: the PreferencesForm $user: the User object to save preferences to -$message: change this to set an error message (ignored if the hook does notreturn fals) +$message: change this to set an error message (ignored if the hook does not return false) +$old: old preferences of the user 'SearchUpdate': Prior to search update completion $id : Page id @@ -926,9 +1111,32 @@ $checkEdit: Whether or not the action=edit query should be added if appropriate. $sktemplate: SkinTemplate object $content_actions: array of tabs +'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more) +$tools: array of tools + 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions $id: User identifier +'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery() +$pager: The UsersPager instance +$query: The query array to be returned + +'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow() +$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes +$row: Database row object + +'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader() +$pager: The UsersPager instance +$out: The header HTML + +'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader() +$pager: The UsersPager instance +$out: The header HTML + +'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo() +$pager: The UsersPager instance +$query: The query array to be returned + 'SpecialMovepageAfterMove': called after moving a page $movePage: MovePageForm object $oldTitle: old title (object) @@ -955,9 +1163,27 @@ $funct: function called to execute the special page 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page $list: list (array) of core special pages +'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges +&$extraOpts: array of added items, to which can be added +$opts: FormOptions for this request + +'SpecialRecentChangesQuery': called when building sql query for SpecialRecentChanges +&$conds: array of where conditionals for query +&$tables: array of tables to be queried +&$join_conds: join conditions for the tables +$opts: FormOptions for this request + 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist $title: title object generated from the text entred by the user +'SpecialSearchResults': called before search result display when there are matches +$term: string of search term +&$titleMatches: empty or SearchResultSet object +&$textMatches: empty or SearchResultSet object + +'SpecialSearchNoResults': called before search result display when there are no matches +$term: string of search term + 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers $extTypes: associative array of extensions types @@ -1006,7 +1232,11 @@ string $tempName: filesystem path to the temporary file for checks string &$error: output: HTML error to show if upload canceled by returning false 'UploadComplete': Upon completion of a file upload -$image: Image object representing the file that was uploaded +$uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile. + +'UserArrayFromResult': called when creating an UserArray object from a database result +&$userArray: set this to an object to override the default object returned +$res: database result used to create the object 'userCan': To interrupt/advise the "user can do X to Y article" check. If you want to display an error message, try getUserPermissionsErrors. @@ -1031,8 +1261,35 @@ $template: SimpleTemplate instance for the form $user: User to get groups for &$groups: Current effective groups +'UserGetAllRights': after calculating a list of all available rights +&$rights: Array of rights, which may be added to. + +'UserGetEmail': called when getting an user email address +$user: User object +&$email: email, change this to override local email + +'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification +$user: User object +&$timestamp: timestamp, change this to override local email authentification timestamp + +'UserGetImplicitGroups': Called in User::getImplicitGroups() +&$groups: List of implicit (automatically-assigned) groups + +'UserGetRights': Called in User::getRights() +$user: User to get rights for +&$rights: Current rights + +'UserLoadDefaults': called when loading a default user +$user: user object +$name: user name + +'UserLoadFromSession': called to authenticate users on external/environmental means +$user: user object being loaded +&$result: set this to a boolean value to abort the normal authentification process + 'UserLoginComplete': after a user has logged in $user: the user object that was created on login +$inject_html: Any HTML to inject after the "logged in" message. 'UserLoginForm': change to manipulate the login form $template: SimpleTemplate instance for the form @@ -1042,23 +1299,34 @@ $user: the user object that is about to be logged out 'UserLogoutComplete': after a user has logged out $user: the user object _after_ logout (won't have name, ID, etc.) +$inject_html: Any HTML to inject after the "logged out" message. +$oldName: name of the user before logout (string) 'UserRights': After a user's group memberships are changed $user : User object that was changed $add : Array of strings corresponding to groups added $remove: Array of strings corresponding to groups removed - -'UserGetImplicitGroups': Called in User::getImplicitGroups() -&$groups: List of implicit (automatically-assigned) groups - -'UserGetRights': Called in User::getRights() -$user: User to get rights for -&$rights: Current rights 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s) $user: user retrieving new talks messages $talks: array of new talks page(s) +'UserSaveSettings': called when saving user settings +$user: User object + +'UserSetCookies': called when setting user cookies +$user: User object +&$session: session array, will be added to $_SESSION +&$cookies: cookies array mapping cookie name to its value + +'UserSetEmail': called when changing user email address +$user: User object +&$email: new email, change this to override new email address + +'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification +$user: User object +&$timestamp: new timestamp, change this to override local email authentification timestamp + 'UserToggles': called when initialising User::$mToggles, use this to add new toggles $toggles: array of toggles to add |