X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=docs%2Fhooks.txt;h=eae869197e478562c2f18aa932ced01a02c1c08b;hb=4b06ec132ae8618a25b874ea98d1daa76e8e0e39;hp=6f98b7e162d7c1e9d48a5a116fffc3f2679b1fe3;hpb=25370b6d0e905b98aea7507886247df0e4026f5f;p=lhc%2Fweb%2Fwiklou.git diff --git a/docs/hooks.txt b/docs/hooks.txt index 6f98b7e162..eae869197e 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -68,7 +68,7 @@ email notification when an article is shown may add: 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: @@ -270,7 +270,7 @@ is enabled ( $wgUseAjax = true; ). 'AlternateEdit': before checking if an user can edit a page and before showing the edit form ( EditPage::edit() ). This is triggered on &action=edit. -$EditPage : the EditPage object +$EditPage: the EditPage object 'APIAfterExecute': after calling the execute() method of an API module. Use this to extend core API modules. @@ -282,7 +282,7 @@ fail, returning an error message or an 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 +&$resultArr : data in this array will be added to the API result 'APIGetAllowedParams': use this hook to modify a module's parameters. &$module: Module object @@ -507,6 +507,14 @@ rendered inline in wiki pages or galleries in category pages. &$nt: the image title &$time: image timestamp +'BeforeInitialize': before anything is initialized in performRequestForTitle() +&$title: Title being used for request +&$article: The associated Article object +&$output: OutputPage object +&$user: User +$request: WebRequest object +$this: Mediawiki object + 'BeforePageDisplay': Prior to outputting a page &$out: OutputPage object &$skin: Skin object @@ -613,7 +621,7 @@ $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 +&$error: error message to return $summary: Edit summary for page 'EditFormPreloadText': Allows population of the edit form when creating @@ -623,7 +631,7 @@ new pages 'EditPage::attemptSave': called before an article is saved, that is before insertNewArticle() is called -&$editpage_Obj: the current EditPage object +$editpage_Obj: the current EditPage object 'EditPage::importFormData': allow extensions to read additional data posted in the form @@ -970,7 +978,8 @@ DEPRECATED: Use $wgLogActions &$actionText: array of strings 'MagicWordMagicWords': When defining new magic word. -DEPRECATED: Use LanguageGetMagic hook instead +DEPRECATED: use $magicWords in a file listed in +$wgExtensionMessagesFiles instead. $magicWords: array of strings 'MagicWordwgVariableIDs': When definig new magic words IDs. @@ -1017,6 +1026,13 @@ Useful for updating caches. $title: name of the page changed. $text: new contents of the page. +'ModifyExportQuery': Modify the query used by the exporter. +$db: The database object to be queried. +&$tables: Tables in the query. +&$conds: Conditions in the query. +&$opts: Options for the query. +&$join_conds: Join conditions for the query. + '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 @@ -1125,6 +1141,7 @@ $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) +$frame: PPFrame object to use for expanding any template variables 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word @@ -1219,6 +1236,13 @@ $text: Text being shown $title: Title of the custom script/stylesheet page $output: Current OutputPage object +'ShowSearchHitTitle': Customise display of search hit title/link. +&$title: Title to link to +&$text: Text to use for the link +$result: The search result +$terms: The search terms entered +$page: The SpecialSearch object. + 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed &$siteNotice: HTML returned as the sitenotice Return true to allow the normal method of notice selection/rendering to work, @@ -1353,6 +1377,15 @@ $newTitle: new title (object) hook to remove a core special page $list: list (array) of core special pages +'SpecialRandomGetRandomTitle': called during the execution of Special:Random, +use this to change some selection criteria or substitute a different title +&$randstr: The random number from wfRandom() +&$isRedir: Boolean, whether to select a redirect or non-redirect +&$namespaces: An array of namespace indexes to get the title from +&$extra: An array of extra SQL statements +&$title: If the hook returns false, a Title object to use instead of the +result from the normal query + 'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges &$extraOpts: array of added items, to which can be added @@ -1369,6 +1402,9 @@ $opts: FormOptions for this request target doesn't exist $title: title object generated from the text entred by the user +'SpecialSearchProfiles': allows modification of search profiles +&$profiles: profiles, which can be modified. + 'SpecialSearchResults': called before search result display when there are matches $term: string of search term @@ -1379,6 +1415,10 @@ $term: string of search term no matches $term: string of search term +'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics +&$extraStats: Array to save the new stats + ( $extraStats[''] => ; ) + 'SpecialUploadComplete': Called after successfully uploading a file from Special:Upload $form: The UploadForm object @@ -1443,8 +1483,8 @@ 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 -$uploadForm: Upload form object. File can be accessed by - $uploadForm->mLocalFile. +$uploadBase: UploadBase (or subclass) object. File can be accessed by + $uploadBase->getLocalFile(). 'User::mailPasswordInternal': before creation and mailing of a user's new temporary password @@ -1469,7 +1509,6 @@ $result: Pointer to result returned if hook returns false. If null is returned, $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 @@ -1515,7 +1554,7 @@ $user: User object &$groups: List of implicit (automatically-assigned) groups 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time -*&$reservedUsernames: $wgReservedUsernames +&$reservedUsernames: $wgReservedUsernames 'UserGetRights': Called in User::getRights() $user: User to get rights for @@ -1635,5 +1674,19 @@ One, and only one hook should set this, and return false. query pages to be updated with maintenance/updateSpecialPages.php $query: $wgQueryPages itself +'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra + metadata to be added. +$obj: The XmlDumpWriter object. +&$out: The output string. +$row: The database row for the page. +$title: The title of the page. + +'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra + metadata. +$obj: The XmlDumpWriter object. +&$out: The text being output. +$row: The database row for the revision. +$text: The revision text. + More hooks might be available but undocumented, you can execute ./maintenance/findhooks.php to find hidden one.