diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/globals.txt | 10 | ||||
| -rw-r--r-- | docs/hooks.txt | 387 |
2 files changed, 373 insertions, 24 deletions
diff --git a/docs/globals.txt b/docs/globals.txt index ecc5ab33..8320eec0 100644 --- a/docs/globals.txt +++ b/docs/globals.txt @@ -72,3 +72,13 @@ $wgParser $wgLoadBalancer A LoadBalancer object, manages database connections. + +$wgRequest + WebRequest object, to get request data + +$wgMemc, $messageMemc, $parserMemc + Object caches + +$wgMessageCache + Message cache, to manage interface messages + diff --git a/docs/hooks.txt b/docs/hooks.txt index 9614bead..9e27a8d0 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -245,12 +245,19 @@ $password: the password being submitted, not yet checked for validity default is LoginForm::ABORTED. Note that the client may be using a machine API rather than the HTML user interface. +'AbortMove': allows to abort moving an article (title) +$old: old title +$nt: new title +$user: user who is doing the move +$err: error message + 'AbortNewAccount': Return false to cancel account creation. $user: the User object about to be created (read-only, incomplete) $message: out parameter: error message to display on abort 'AddNewAccount': after a user account is created $user: the User object that was created. (Parameter added in 1.7) +$byEmail: true when account was created "by email" (added in 1.12) 'AjaxAddScript': Called in output page just before the initialisation of the javascript ajax engine. The hook is only called when ajax @@ -261,6 +268,10 @@ before showing the edit form ( EditPage::edit() ). This is triggered on &action=edit. $EditPage : the EditPage object +'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 + 'ArticleDelete': before an article is deleted $article: the article (object) being deleted $user: the user (object) deleting the article @@ -271,6 +282,16 @@ $article: the article that was deleted $user: the user that deleted the article $reason: the reason the article was deleted +'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed +$article: article (object) of the user talk page + +'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries +$article: article (object) being modified + +'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle() +$title: title (object) used to create the article object +$article: article (object) that will be returned + 'ArticleInsertComplete': After an article is created $article: Article created $user: User creating the article @@ -282,6 +303,18 @@ $section: (No longer used) $flags: Flags passed to Article::doEdit() $revision: New Revision of the article +'ArticleMergeComplete': after merging to article using Special:Mergehistory +$targetTitle: target title (object) +$destTitle: destination title (object) + +'ArticlePageDataAfter': after loading data of an article from the database +$article: article (object) whose data were loaded +$row: row (object) returned from the database server + +'ArticlePageDataBefore': before loading data of an article from the database +$article: article (object) that data will be loaded +$fields: fileds (array) to load from the database + 'ArticleProtect': before an article is protected $article: the article being protected $user: the user doing the protection @@ -296,6 +329,19 @@ $protect: boolean whether it was a protect or an unprotect $reason: Reason for protect $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 +$title: the article title +$revision: the revision +$oldPageID: the page ID of the revision when archived (may be null) + +'ArticleRollbackComplete': after an article rollback is completed +$article: the article that was edited +$user: the user who did the rollback +$revision: the revision the page was reverted back to + 'ArticleSave': before an article is saved $article: the article (object) being saved $user: the user (object) saving the article @@ -327,20 +373,24 @@ $section: section # wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) ); -'ArticleUndeleted': When one or more revisions of an article are restored +'ArticleUndelete': When one or more revisions of an article are restored $title: Title corresponding to the article restored $create: Whether or not the restoration caused the page to be created (i.e. it didn't exist before) -'ArticleViewHeader': Before the parser cache is about to be tried for article viewing. -&$pcache: whether to try the parser cache or not -&$outputDone: whether the output for this page finished or not - 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page &$article: the article &$sectionanchor: The section anchor link (e.g. "#overview" ) &$extraq: Extra query parameters which can be added via hooked functions +'ArticleViewHeader': Before the parser cache is about to be tried for article viewing. +&$article: the article +&$pcache: whether to try the parser cache or not +&$outputDone: whether the output for this page finished or not + +'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect +$article: target article (object) + '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 @@ -348,6 +398,12 @@ Gives a chance for an extension to set it programattically to a variable class. '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 +$user: user +$result: result of checking autopromote condition + 'BadImage': When checking against the bad image list $name: Image name being checked &$bad: Whether or not the image is "bad" @@ -379,6 +435,13 @@ $out: OutputPage object &$parser: Parser object &$ig: ImageGallery object +'BeforeWatchlist': Override watchlist display or add extra SQL clauses. +$nondefaults: Assoc array with the following keys: + days, hideOwn, hideBots, hideMinor, namespace +$wgUser: wgUser. +&$hookSql: a string which will be inserted without sanitation into the SQL query + used to get the watchlist, at the end of the WHERE part. + 'BlockIp': before an IP address or user is blocked $block: the Block object about to be saved $user: the user _doing_ the block (not the one being blocked) @@ -394,6 +457,14 @@ $output: OutputPage object in use 'CategoryPageView': before viewing a categorypage in CategoryPage::view $catpage: CategoryPage instance +'ChangesListInsertArticleLink': Override or augment link to article in RC list. +&$this: ChangesList instance. +&$articlelink: HTML of link to article (already filled-in). +&$s: HTML of row that is being constructed. +&$rc: RecentChange instance. +$unpatrolled: Whether or not we are showing unpatrolled changes. +$watched: Whether or not the change is watched by the user. + 'ContributionsToolLinks': Change tool links above Special:Contributions $id: User identifier $title: User page title @@ -412,30 +483,46 @@ $diff: DifferenceEngine object that's calling $oldRev: Revision object of the "old" revision (may be null/invalid) $newRev: Revision object of the "new" revision -'EditPage::attemptSave': called before an article is -saved, that is before insertNewArticle() is called -&$editpage_Obj: the current EditPage object +'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article +$article: article (object) being viewed +$oldid: oldid (int) being viewed + +'EditFilter': Perform checks on an edit +$editor: Edit form (see includes/EditPage.php) +$text: Contents of the edit box +$section: Section being edited +&$error: Error message to return + +'EditFilterMerged': Post-section-merge edit filter +$editor: EditPage instance (object) +$text: content of the edit box +$error: error message to return 'EditFormPreloadText': Allows population of the edit form when creating new pages &$text: Text to preload with &$title: Title object representing the page being created +'EditPage::attemptSave': called before an article is +saved, that is before insertNewArticle() is called +&$editpage_Obj: the current EditPage object + 'EditPage::showEditForm:fields': allows injection of form field into edit form &$editor: the EditPage instance for reference &$out: an OutputPage instance to write to return value is ignored (should always return true) -'EditFilter': Perform checks on an edit -$editor: Edit form (see includes/EditPage.php) -$text: Contents of the edit box -$section: Section being edited -&$error: Error message to return +'EditPage::showEditForm:initial': before showing the edit form +$editor: EditPage instance (object) Return false to halt editing; you'll need to handle error messages, etc. yourself. Alternatively, modifying $error and returning true will cause the contents of $error to be echoed at the top of the edit form as wikitext. Return true without altering $error to allow the edit to proceed. +'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" + 'EditSectionLink': Override the return value of Linker::editSectionLink() $skin: Skin rendering the UI $title: Title being linked to @@ -478,20 +565,42 @@ false override the list derivative used) 'FileUpload': When a file upload occurs $file : Image object representing the file that was uploaded +'GetBlockedStatus': after loading blocking status of an user from the database +$user: user (object) being checked + +'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) +$query: query options passed to Title::getFullURL() + 'GetInternalURL': modify fully-qualified URLs used for squid cache purging $title: Title object of page $url: string value as output (out parameter, can modify) $query: query options passed to Title::getInternalURL() +'GetLinkColours': modify the CSS class of an array of page links +$linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id. +&$colours: (output) array of CSS classes, indexed by prefixed DB keys + 'GetLocalURL': modify local URLs as output into page links $title: Title object of page $url: string value as output (out parameter, can modify) $query: query options passed to Title::getLocalURL() -'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) -$query: query options passed to Title::getFullURL() +'getUserPermissionsErrors': Add a permissions error when permissions errors are + checked for. Use instead of userCan for most cases. Return false if the + user can't do it, and populate $result with the reason in the form of + array( messagename, param1, param2, ... ). For consistency, error messages + should be plain text with no special coloring, bolding, etc. to show that + they're errors; presenting them properly to the user as errors is done by + the caller. +$title: Title object being checked against +$user : Current user object +$action: Action being checked +$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 $imagePage: ImagePage object ($this) @@ -507,20 +616,62 @@ after noinclude/includeonly/onlyinclude and other processing. &$text: string containing partially parsed text &$this->mStripState: Parser's internal StripState object +'IsFileCacheable': Override the result of Article::isFileCacheable() (if true) +$article: article (object) being checked + +'IsTrustedProxy': Override the result of wfIsTrustedProxy() +$ip: IP being check +$result: Change this value to override the result of wfIsTrustedProxy() + +'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins- +tance to return false if the domain name doesn't match your organization +$addr: The e-mail address entered by the user +&$result: Set this and return false to override the internal checks + 'isValidPassword': Override the result of User::isValidPassword() -$password: Desired password +$password: The password entered by the user &$result: Set this and return false to override the internal checks $user: User the password is being validated for +'LanguageGetMagic': Use this to define synonyms of magic words depending of the language +$magicExtensions: associative array of magic words synonyms +$lang: laguage code (string) + +'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language +$specialPageAliases: associative array of magic words synonyms +$lang: laguage code (string) + +'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update +&$linksUpdate: the LinkUpdate object + +'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed +&$linksUpdate: the LinkUpdate object + 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction. &$linksUpdate: the LinkUpdate object +'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages + +'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema + '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 $password: the password being submitted and found wanting $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc) +'LogLine': Processes a single log entry on Special:Log +$log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type + database field. +$log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds + to logging.log_action database field. +$title: Title object that corresponds to logging.log_namespace and logging.log_title database fields. +$paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0] + appears to contain anything. +&$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI. +&$revert: string that is displayed in the UI, similar to $comment. +$time: timestamp of the log entry (added in 1.12) + 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes &$type: array of strings @@ -533,6 +684,12 @@ $retval: a LoginForm class constant with authenticateUserData() return value (SU 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions &$actionText: array of strings +'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead +$magicWords: array of strings + +'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead +$variableIDs: array of strings + 'MarkPatrolled': before an edit is marked patrolled $rcid: ID of the revision to be marked patrolled $user: the user (object) marking the revision as patrolled @@ -550,11 +707,31 @@ $mathRenderer: instance of MathRenderer $errmsg: error message, in HTML (string). Nonempty indicates failure of rendering the formula +'MediaWikiPerformAction': Override MediaWiki::performAction(). +Use this to do something completely different, after the basic +globals have been set up, but before ordinary actions take place. +$output: $wgOut +$article: $wgArticle +$title: $wgTitle +$user: $wgUser +$request: $wgRequest + +'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) +$tools: array of tools + '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 $text: the text that will be displayed, in HTML (string) +'OutputPageParserOutput': after adding a parserOutput to $wgOut +$out: OutputPage instance (object) +$parserOutput: parserOutput instance being added in $out + 'PageHistoryBeforeList': When a history page list is about to be constructed. $article: the article that the history is loading for @@ -567,6 +744,53 @@ $s: the string representing this parsed line this hook and append its values to the key. $hash: reference to a hash key string which can be modified +'ParserAfterStrip': Same as ParserBeforeStrip + +'ParserAfterTidy': Called after Parser::tidy() in Parser::parse() +$parser: Parser object being used +$text: text that'll be returned + +'ParserBeforeInternalParse': called at the beginning of Parser::internalParse() +$parser: Parser object +$text: text to parse +$stripState: StripState instance being used + +'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?) +$parser: parser object +$text: text being parsed +$stripState: stripState used (object) + +'ParserBeforeTidy': called before tidy and custom tags replacements +$parser: Parser object being used +$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 + +'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word +$parser: Parser object +$varCache: array to store the value in case of multiples calls of the same magic word +$index: index (string) of the magic +$ret: value of the magic word (the hook should set it) + +'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word +$parser: Parser object +$time: actual time (timestamp) + +'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it +$parser: Parser object +$varCache: varaiable cache (array) + +'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed +$parser: Parser object +$limitReport: text that will be included (without comment tags) + +'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc +$parser: Parser object created + 'ParserTestTables': alter the list of tables to duplicate when parser tests are run. Use when page save hooks require the presence of custom tables to ensure that tests continue to run properly. @@ -589,10 +813,30 @@ the built-in rate limiting checks are used, if enabled. $form : PreferencesForm object &$html : HTML to append to +'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 +$search : search term (not guaranteed to be conveniently normalized) +$limit : maximum number of results to return +&$results : out param: array of page names (strings) + +'PrefsEmailAudit': called when user changes his email address +$user: User (object) changing his email address +$oldaddr: old email address (string) +$newaddr: new email address (string) + +'PrefsPasswordAudit': called when user changes his password +$user: User (object) changing his passoword +$newPass: new password +$error: error (string) 'badretype', 'wrongpassword', 'error' or 'success' + 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw &$obj: RawPage object &$text: The text that's going to be the output +'RecentChange_save': called at the end of RecenChange::save() +$recentChange: RecentChange object + 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm $form: the PreferencesForm $out: output page to render to, probably $wgOut @@ -613,6 +857,10 @@ $namespace : Page namespace $title : Page title $text : Current text being indexed +'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches +$term : Search term string +&$title : Outparam; set to $title object and return false for a match + 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views $text: Text being shown $title: Title of the custom script/stylesheet page @@ -632,6 +880,20 @@ $skin: Skin object &$text: bottomScripts Text Append to $text to add additional text/scripts after the stock bottom scripts. +'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle() +$skin: Skin object +&$subpages: Subpage links HTML +If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates. +If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run. + +'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page +$sktemplate: SkinTemplate object +$content_actions: array of tabs + +'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab +$sktemplate: SkinTemplate object +$nav_urls: array of tabs + 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates &$content_actions: Content actions [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php @@ -641,9 +903,64 @@ for an example] &$sktemplate: SkinTemplate object &$tpl: Template engine object +'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs +$sktemplate: SkinTemplate object +$res: set to true to prevent active tabs + +'SkinTemplateSetupPageCss': use this to provide per-page CSS +$out: Css to return + +'SkinTemplateTabAction': Override SkinTemplate::tabAction(). + You can either create your own array, or alter the parameters for the normal one. +&$this: The SkinTemplate instance. +$title: Title instance for the page. +$message: Visible label of tab. +$selected: Whether this is a selected tab. +$checkEdit: Whether or not the action=edit query should be added if appropriate. +&$classes: Array of CSS classes to apply. +&$query: Query string to add to link. +&$text: Link text. +&$result: Complete assoc. array if you want to return true. + +'SkinTemplateTabs': called when finished to build the actions tabs +$sktemplate: SkinTemplate object +$content_actions: array of tabs + 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions $id: User identifier +'SpecialMovepageAfterMove': called after moving a page +$movePage: MovePageForm object +$oldTitle: old title (object) +$newTitle: new title (object) + +'SpecialPageExecuteAfterPage': called after executing a special page +Warning: Not all the special pages call this hook +$specialPage: SpecialPage object +$par: paramter passed to the special page (string) +$funct: function called to execute the special page + +'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page +Warning: Not all the special pages call this hook +$specialPage: SpecialPage object +$par: paramter passed to the special page (string) +$funct: function called to execute the special page + +'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution +Warning: Not all the special pages call this hook +$specialPage: SpecialPage object +$par: paramter passed to the special page (string) +$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 + +'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 + +'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers +$extTypes: associative array of extensions types + 'TitleMoveComplete': after moving an article (title) $old: old title $nt: new title @@ -651,6 +968,10 @@ $user: user who did the move $pageid: database ID of the page that's been moved $redirid: database ID of the created redirect +'UndeleteShowRevision': called when showing a revision in Special:Undelete +$title: title object related to the revision +$rev: revision (object) that will be viewed + 'UnknownAction': An unknown "action" has occured (useful for defining your own actions) $action: action name @@ -687,16 +1008,29 @@ 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 -'UserCan': To interrupt/advise the "user can do X to Y article" check +'userCan': To interrupt/advise the "user can do X to Y article" check. + If you want to display an error message, try getUserPermissionsErrors. $title: Title object being checked against $user : Current user object $action: Action being checked $result: Pointer to result returned if hook returns false. If null is returned, - UserCan checks are continued by internal code + userCan checks are continued by internal code. + +'UserCanSendEmail': To override User::canSendEmail() permission check +$user: User (object) whose permission is being checked +&$canSend: bool set on input, can override on output + + +'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it +$user: User (object) that'll clear the message 'UserCreateForm': change to manipulate the login form $template: SimpleTemplate instance for the form +'UserEffectiveGroups': Called in User::getEffectiveGroups() +$user: User to get groups for +&$groups: Current effective groups + 'UserLoginComplete': after a user has logged in $user: the user object that was created on login @@ -721,9 +1055,12 @@ $remove: Array of strings corresponding to groups removed $user: User to get rights for &$rights: Current rights -'UserEffectiveGroups': Called in User::getEffectiveGroups() -$user: User to get groups for -&$groups: Current effective groups +'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s) +$user: user retrieving new talks messages +$talks: array of new talks page(s) + +'UserToggles': called when initialising User::$mToggles, use this to add new toggles +$toggles: array of toggles to add 'WatchArticle': before a watch is added to an article $user: user that will watch @@ -733,6 +1070,8 @@ $article: article object to be watched $user: user that watched $article: article object watched +'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php +$query: $wgQueryPages itself More hooks might be available but undocumented, you can execute -./maintenance/findhooks.php to find hidden one.
\ No newline at end of file +./maintenance/findhooks.php to find hidden one. |