X-Git-Url: https://git.cyclocoop.org/?a=blobdiff_plain;f=docs%2Fhooks.txt;h=a2929974696b7982894b5db8f4221d86c5eeaec7;hb=21bafdfa24c40af12fa7c4733c1097ee09d75374;hp=3670cbe5a1dfebb83a825935e0e508ffb114b008;hpb=a8ed7dd4d365dc74ae533ddfe9642d4d87d7c72d;p=lhc%2Fweb%2Fwiklou.git diff --git a/docs/hooks.txt b/docs/hooks.txt index 3670cbe5a1..a292997469 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -270,6 +270,12 @@ $reason: the reason for the move (added in 1.13) $user: the User object about to be created (read-only, incomplete) &$msg: out parameter: HTML to display on abort +'AbortChangePassword': Return false to cancel password change. +$user: the User object to which the password change is occuring +$mOldpass: the old password provided by the user +$newpass: the new password provided by the user +&$abortMsg: the message identifier for abort reason + 'ActionBeforeFormDisplay': Before executing the HTMLForm object. $name: name of the action &$form: HTMLForm object @@ -371,6 +377,11 @@ result. &$module: ApiBase Module object &$properties: Array of properties +'APIGetPossibleErrors': Use this hook to modify the module's list of possible +errors. +$module: ApiBase Module object +&$possibleErrors: Array of possible errors + 'APIQueryAfterExecute': After calling the execute() method of an action=query submodule. Use this to extend core API modules. &$module: Module object @@ -482,7 +493,8 @@ $logEntry: the ManualLogEntry used to record the deletion 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page was changed. -$wikiPage: WikiPage (object) of the user talk page +&$wikiPage: WikiPage (object) of the user talk page +$recipient: User (object) who's talk page was edited 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an article has been changed. @@ -1132,6 +1144,15 @@ $title: Title object of page $url: string value as output (out parameter, can modify) $query: query options passed to Title::getFullURL() +'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated +by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom +output. +&$output: string for the output timestamp +$timestamp: MWTimestamp object of the current (user-adjusted) timestamp +$relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp +$user: User whose preferences are being used to make timestamp +$lang: Language that will be used to render the timestamp + 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging. $title: Title object of page $url: string value as output (out parameter, can modify) @@ -1172,6 +1193,14 @@ to do this unless they broke backwards compatibility with a previous version of the media handler metadata output. &$version: Array of version strings +'GetNewMessagesAlert': Disable or modify the new messages alert +&$newMessagesAlert: An empty string by default. If the user has new talk page +messages, this should be populated with an alert message to that effect +$newtalks: An empty array if the user has no new messages or an array containing +links and revisions if there are new messages (See User::getNewMessageLinks) +$user: The user object of the user who is loading the page +$out: OutputPage object (to check what type of page the user is on) + 'GetPreferences': Modify user preferences. $user: User whose preferences are being modified. &$preferences: Preferences description array, to be fed to an HTMLForm object @@ -1369,6 +1398,16 @@ $lang: language code (string) &$names: array of language code => language name $code language of the preferred translations +'LanguageLinks': Manipulate a page's language links. This is called +in various places to allow extensions to define the effective language +links for a page. +$title: The page's Title. +&$links: Associative array mapping language codes to prefixed links of the + form "language:title". +&$linkFlags: Associative array mapping prefixed links to arrays of flags. + Currently unused, but planned to provide support for marking individual + language links in the UI, e.g. for featured articles. + 'LinkBegin': Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on @@ -2272,6 +2311,7 @@ $special: the special page object &$tables: array of tables to be queried &$join_conds: join conditions for the tables &$fields: array of query fields +$values: array of variables with watchlist options 'TestCanonicalRedirect': Called when about to force a redirect to a canonical URL for a title when we have no other parameters on the URL. Gives a chance for