X-Git-Url: https://git.heureux-cyclage.org/index.php?a=blobdiff_plain;f=docs%2Fhooks.txt;h=950cb5f0b6abf30bc1fc1113289b289e9a5a68d5;hb=d87135d706004373b2cfdc4c588ce6d80358631f;hp=e844e891c9ac25f1523575353811714ddd1bf94b;hpb=4bed2c4a9515433400ec4cc25052822c8ef40640;p=lhc%2Fweb%2Fwiklou.git diff --git a/docs/hooks.txt b/docs/hooks.txt index e844e891c9..950cb5f0b6 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -283,6 +283,11 @@ $article: Article object $user: the User object that was created. (Parameter added in 1.7) $byEmail: true when account was created "by email" (added in 1.12) +'AfterFinalPageOutput': At the end of OutputPage::output() but before +final ob_end_flush() which will send the buffered output to the client. +This allows for last-minute modification of the output within the buffer +by using ob_get_clean(). + 'AfterImportPage': When a page import is completed $title: Title under which the revisions were imported $origTitle: Title provided by the XML file @@ -410,9 +415,14 @@ token types. used to retrieve this type of tokens. 'ArticleAfterFetchContent': after fetching content of an article from +the database. DEPRECATED, use ArticleAfterFetchContentObject instead. +$article: the article (object) being loaded from the database +&$content: the content (string) of the article + +'ArticleAfterFetchContentObject': 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 +&$content: the content of the article, as a Content object 'ArticleConfirmDelete': before writing the confirmation form for article deletion @@ -460,7 +470,7 @@ Wiki::articleFromTitle() $title: title (object) used to create the article object $article: article (object) that will be returned -'ArticleInsertComplete': After a new article is created +'ArticleInsertComplete': After a new article is created. DEPRECATED, use ArticleContentInsertComplete $article: WikiPage created $user: User creating the article $text: New content @@ -471,6 +481,17 @@ $section: (No longer used) $flags: Flags passed to Article::doEdit() $revision: New Revision of the article +'ArticleContentInsertComplete': After a new article is created +$article: WikiPage created +$user: User creating the article +$content: New content as a Content object +$summary: Edit summary/comment +$isMinor: Whether or not the edit was marked as minor +$isWatch: (No longer used) +$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) @@ -519,7 +540,7 @@ $user: the user who did the rollback $revision: the revision the page was reverted back to $current: the reverted revision -'ArticleSave': before an article is saved +'ArticleSave': before an article is saved. DEPRECATED, use ArticleContentSave instead $article: the WikiPage (object) being saved $user: the user (object) saving the article $text: the new article text @@ -528,7 +549,16 @@ $isminor: minor flag $iswatch: watch flag $section: section # -'ArticleSaveComplete': After an article has been updated +'ArticleContentSave': before an article is saved. +$article: the WikiPage (object) being saved +$user: the user (object) saving the article +$content: the new article content, as a Content object +$summary: the article summary (comment) +$isminor: minor flag +$iswatch: watch flag +$section: section # + +'ArticleSaveComplete': After an article has been updated. DEPRECATED, use ArticleContentSaveComplete instead. $article: WikiPage modified $user: User performing the modification $text: New content @@ -541,6 +571,19 @@ $revision: New Revision of the article $status: Status object about to be returned by doEdit() $baseRevId: the rev ID (or false) this edit was based on +'ArticleContentSaveComplete': After an article has been updated +$article: WikiPage modified +$user: User performing the modification +$content: New content, as a Content object +$summary: Edit summary/comment +$isMinor: Whether or not the edit was marked as minor +$isWatch: (No longer used) +$section: (No longer used) +$flags: Flags passed to Article::doEdit() +$revision: New Revision of the article +$status: Status object about to be returned by doEdit() +$baseRevId: the rev ID (or false) this edit was based on + '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 @@ -567,11 +610,19 @@ object to both indicate that the output is done and what parser output was used. follwed an redirect $article: target article (object) -'ArticleViewCustom': allows to output the text of the article in a different format than wikitext +'ArticleViewCustom': allows to output the text of the article in a different format than wikitext. +DEPRECATED, use ArticleContentViewCustom instead. +Note that it is preferrable to implement proper handing for a custom data type using the ContentHandler facility. $text: text of the page $title: title of the page $output: reference to $wgOut +'ArticleContentViewCustom': allows to output the text of the article in a different format than wikitext. +Note that it is preferrable to implement proper handing for a custom data type using the ContentHandler facility. +$content: content of the page, as a Content object +$title: title of the page +$output: reference to $wgOut + 'AuthPluginAutoCreate': Called when creating a local account for an user logged in from an external authentication method $user: User object created locally @@ -703,6 +754,16 @@ the collation given in $collationName. 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully $user: user (object) whose email is being confirmed +'ContentHandlerDefaultModelFor': Called when the default content model is determiend +for a given title. May be used to assign a different model for that title. +$title: the Title in question +&$model: the model name. Use with CONTENT_MODEL_XXX constants. + +'ContentHandlerForModelID': Called when a ContentHandler is requested for a given +cointent model name, but no entry for that model exists in $wgContentHandlers. +$modeName: the requested content model name +&$handler: set this to a ContentHandler object, if desired. + 'ContribsPager::getQueryInfo': Before the contributions query is about to run &$pager: Pager object for contributions &$queryInfo: The query for the contribs Pager @@ -776,12 +837,19 @@ $section: Section being edited &$error: Error message to return $summary: Edit summary for page -'EditFilterMerged': Post-section-merge edit filter +'EditFilterMerged': Post-section-merge edit filter. +DEPRECATED, use EditFilterMergedContent instead. $editor: EditPage instance (object) $text: content of the edit box &$error: error message to return $summary: Edit summary for page +'EditFilterMergedContent': Post-section-merge edit filter +$editor: EditPage instance (object) +$content: content of the edit box, as a Content object +&$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 @@ -844,14 +912,28 @@ $title: title of page being edited &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2' 'EditPageGetDiffText': Allow modifying the wikitext that will be used in -"Show changes" +"Show changes". DEPRECATED. Use EditPageGetDiffContent instead. +Note that it is preferrable to implement diff handling for different data types using the ContentHandler facility. $editPage: EditPage object &$newtext: wikitext that will be used as "your version" -'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed +'EditPageGetDiffContent': Allow modifying the wikitext that will be used in +"Show changes". +Note that it is preferrable to implement diff handling for different data types using the ContentHandler facility. +$editPage: EditPage object +&$newtext: wikitext that will be used as "your version" + +'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed. +DEPRECATED. Use EditPageGetPreviewContent instead. +Note that it is preferrable to implement previews for different data types using the COntentHandler facility. $editPage: EditPage object &$toparse: wikitext that will be parsed +'EditPageGetPreviewContent': Allow modifying the wikitext that will be previewed. +Note that it is preferrable to implement previews for different data types using the COntentHandler facility. +$editPage: EditPage object +&$content: Content object to be previewed (may be replaced by hook function) + 'EditPageNoSuchSection': When a section edit request is given for an non-existent section &$editpage: The current EditPage object &$res: the HTML of the error text @@ -1702,7 +1784,8 @@ $query : Original query. 'ShowMissingArticle': Called when generating the output for a non-existent page $article: The article object corresponding to the page -'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views +'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views. +DEPRECATED, use the ContentHandler facility to handle CSS and JavaScript! $text: Text being shown $title: Title of the custom script/stylesheet page $output: Current OutputPage object @@ -2321,6 +2404,13 @@ One, and only one hook should set this, and return false. &$opts: Options to use for the query &$join: Join conditions +'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when + a page is deleted. Called in WikiPage::getDeletionUpdates(). + Note that updates specific to a content model should be provided by the + respective ContentHandler's getDeletionUpdates() method. +$page: the WikiPage +&$updates: the array of DataUpdate objects. Hook function may want to add to it. + 'wfShellWikiCmd': Called when generating a shell-escaped command line string to run a MediaWiki cli script. &$script: MediaWiki cli script path