X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=docs%2Fhooks.txt;h=8485b024b72dc28056e0a0113105a5a4305a6662;hb=925fe0df015458a330d320c9f1a0014d32ff8866;hp=62b22e153f2bc1d8ad05f361b6a938f5a824ec99;hpb=77e2873f2eef2c3a1a5f879e812ecc8c4ec7ea42;p=lhc%2Fweb%2Fwiklou.git
diff --git a/docs/hooks.txt b/docs/hooks.txt
index 62b22e153f..8485b024b7 100644
--- a/docs/hooks.txt
+++ b/docs/hooks.txt
@@ -74,9 +74,7 @@ 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 ) {
-
if ( Hooks::run( 'ArticleShow', array( &$article ) ) ) {
-
# code to actually show the article goes here
Hooks::run( 'ArticleShowComplete', array( &$article ) );
@@ -1155,6 +1153,9 @@ $page: SpecialPage object for contributions
&$ret: the HTML line
$row: the DB row for this line
&$classes: the classes to add to the surrounding
+&$attribs: associative array of other HTML attributes for the element.
+ Currently only data attributes reserved to MediaWiki are allowed
+ (see Sanitizer::isReservedDataAttribute).
'ContributionsToolLinks': Change tool links above Special:Contributions
$id: User identifier
@@ -1200,6 +1201,9 @@ $page: SpecialPage object for DeletedContributions
&$ret: the HTML line
$row: the DB row for this line
&$classes: the classes to add to the surrounding
+&$attribs: associative array of other HTML attributes for the element.
+ Currently only data attributes reserved to MediaWiki are allowed
+ (see Sanitizer::isReservedDataAttribute).
'DifferenceEngineAfterLoadNewText': called in DifferenceEngine::loadNewText()
after the new revision's content has been loaded into the class member variable
@@ -1512,6 +1516,9 @@ $changesList: EnhancedChangesList object
$block: An array of RecentChange objects in that block
$rc: The RecentChange object for this line
&$classes: An array of classes to change
+&$attribs: associative array of other HTML attributes for the element.
+ Currently only data attributes reserved to MediaWiki are allowed
+ (see Sanitizer::isReservedDataAttribute).
'EnhancedChangesListModifyBlockLineData': to alter data used to build
a non-grouped recent change line in EnhancedChangesList.
@@ -1999,6 +2006,16 @@ $file: the File object or false if broken link
&$attribs: the attributes to be applied
&$ret: the value to return if your hook returns false
+'LogEventsListLineEnding': Called before a Special:Log line is finished
+$page: the LogEventsList object
+&$ret: the HTML line
+$entry: the DatabaseLogEntry object for this row
+&$classes: the classes to add to the surrounding
+&$attribs: associative array of other HTML attributes for the element.
+ Currently only data attributes reserved to MediaWiki are allowed
+ (see Sanitizer::isReservedDataAttribute).
+
+
'HtmlPageLinkRendererBegin':
Used when generating internal and interwiki links in
LinkRenderer, before processing starts. Return false to skip default
@@ -2284,6 +2301,16 @@ $title: the diff page title (nullable)
$old: the ?old= param value from the url
$new: the ?new= param value from the url
+'NewPagesLineEnding': Called before a NewPages line is finished.
+$page: the SpecialNewPages object
+&$ret: the HTML line
+$row: the database row for this page (the recentchanges record and a few extras - see
+ NewPagesPager::getQueryInfo)
+&$classes: the classes to add to the surrounding
+&$attribs: associative array of other HTML attributes for the element.
+ Currently only data attributes reserved to MediaWiki are allowed
+ (see Sanitizer::isReservedDataAttribute).
+
'NewRevisionFromEditComplete': Called when a revision was inserted due to an
edit.
$wikiPage: the WikiPage edited
@@ -2296,7 +2323,10 @@ return false to omit the line from RecentChanges and Watchlist special pages.
&$changeslist: The OldChangesList instance.
&$s: HTML of the form "..." containing one RC entry.
$rc: The RecentChange object.
-&$classes: array of css classes for the element
+&$classes: array of css classes for the element.
+&$attribs: associative array of other HTML attributes for the element.
+ Currently only data attributes reserved to MediaWiki are allowed
+ (see Sanitizer::isReservedDataAttribute).
'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
can alter or append to the array of URLs for search & suggestion formats.
@@ -2404,6 +2434,9 @@ $historyAction: the action object
&$row: the revision row for this line
&$s: the string representing this parsed line
&$classes: array containing the element classes
+&$attribs: associative array of other HTML attributes for the element.
+ Currently only data attributes reserved to MediaWiki are allowed
+ (see Sanitizer::isReservedDataAttribute).
'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
any output is generated, to allow batch lookups for prefetching information
@@ -2417,7 +2450,8 @@ constructed.
&$pager: the pager
&$queryInfo: the query parameters
-'PageRenderingHash': Alter the parser cache option hash key. A parser extension
+'PageRenderingHash': NOTE: Consider using ParserOptionsRegister instead.
+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.
&$confstr: reference to a hash key string which can be modified
@@ -2541,6 +2575,16 @@ $file: file object that will be used to create the image
&$params: 2-D array of parameters
$parser: Parser object that called the hook
+'ParserOptionsRegister': Register additional parser options. Note that if you
+change the default value for an option, all existing parser cache entries will
+be invalid. To avoid bugs, you'll need to handle that somehow (e.g. with the
+RejectParserCacheValue hook) because MediaWiki won't do it for you.
+&$defaults: Set the default value for your option here.
+&$inCacheKey: To fragment the parser cache on your option, set a truthy value here.
+&$lazyLoad: To lazy-initialize your option, set it null in $defaults and set a
+ callable here. The callable is passed the ParserOptions object and the option
+ name.
+
'ParserSectionCreate': Called each time the parser creates a document section
from wikitext. Use this to apply per-section modifications to HTML (like
wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
@@ -2613,6 +2657,7 @@ $formData: array of user submitted data
$form: PreferencesForm object, also a ContextSource
$user: User object with preferences to be saved set
&$result: boolean indicating success
+$oldUserOptions: array with user old options (before save)
'PreferencesGetLegend': Override the text used for the