X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=docs%2Fhooks.txt;h=b7ea02cea37e54908ea4a81a9f1443c0c423f3ff;hb=51dc3ed889d86588a12feb81930f7f0d12b65c0c;hp=d832012df5b92194e374675431b4c11950c249ac;hpb=249454d777242108dbb61fbb32aa11cde6d4ea5e;p=lhc%2Fweb%2Fwiklou.git

diff --git a/docs/hooks.txt b/docs/hooks.txt
index d832012df5..b7ea02cea3 100644
--- a/docs/hooks.txt
+++ b/docs/hooks.txt
@@ -91,23 +91,29 @@ title-reversing if-blocks spread all over the codebase in showAnArticle,
 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
 file:
 
-	function reverseArticleTitle( $article ) {
+	function onArticleShow( &$article ) {
 		# ...
 	}
 
-	function reverseForExport( $article ) {
+	function onArticleDelete( &$article ) {
 		# ...
 	}
 
-The setup function for the extension just has to add its hook functions to the
-appropriate events:
-
-	setupTitleReversingExtension() {
-		global $wgHooks;
+	function onArticleExport( &$article ) {
+		# ...
+	}
 
-		$wgHooks['ArticleShow'][] = 'reverseArticleTitle';
-		$wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
-		$wgHooks['ArticleExport'][] = 'reverseForExport';
+General practice is to have a dedicated file for functions activated by hooks,
+which functions named 'onHookName'. In the example above, the file
+'ReverseHooks.php' includes the functions that should be activated by the
+'ArticleShow', 'ArticleDelete', and 'ArticleExport' hooks. The 'extension.json'
+file with the extension's registration just has to add its hook functions
+to the appropriate events:
+
+	"Hooks": {
+		"ArticleShow": "ReverseHooks:onArticleShow",
+		"ArticleDelete": "ReverseHooks::onArticleDelete",
+		"ArticleExport": "ReverseHooks::onArticleExport"
 	}
 
 Having all this code related to the title-reversion option in one place means
@@ -1720,6 +1726,11 @@ $contentHandler: ContentHandler for which the slot diff renderer is fetched.
 &$slotDiffRenderer: SlotDiffRenderer to change or replace.
 $context: IContextSource
 
+'GetUserBlock': Modify the block found by the block manager. This may be a
+single block or a composite block made from multiple blocks; the original
+blocks can be seen using CompositeBlock::getOriginalBlocks()
+&$block: AbstractBlock object
+
 '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
@@ -3205,6 +3216,9 @@ $request: WebRequest object for getting the value provided by the current user
 $sp: SpecialPage object, for context
 &$fields: Current HTMLForm fields descriptors
 
+'SpecialMuteSubmit': DEPRECATED since 1.34! Used only for instrumentation on SpecialMute
+$data: Array containing information about submitted options on SpecialMute form
+
 'SpecialNewpagesConditions': Called when building sql query for
 Special:NewPages.
 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
@@ -3490,6 +3504,12 @@ processing.
 &$archive: PageArchive object
 $title: Title object of the page that we're about to undelete
 
+'UndeletePageToolLinks': Add one or more links to edit page subtitle when a page
+has been previously deleted.
+$context: IContextSource (object)
+$linkRenderer: LinkRenderer instance
+&$links: Array of HTML strings
+
 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
 $title: title object related to the revision
 $rev: revision (object) that will be viewed
@@ -3691,7 +3711,7 @@ $newUGMs: An associative array (group name => UserGroupMembership object) of
 the user's current group memberships.
 
 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
-specific block exemptions).
+specific block exemptions if a user is already blocked).
 $user: User in question
 $title: Title of the page in question
 &$blocked: Out-param, whether or not the user is blocked from that page.