X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=blobdiff_plain;f=docs%2Fhooks.txt;h=d93bb6ad07164b3d625b94d28d9d5f594abd856c;hb=0cd07c7ce70ebd19886b21e7725286063a939758;hp=bed562e11c81face53936ca04500207df239c085;hpb=d5460bce86a8dc6e2365860df8bed64155d8e486;p=lhc%2Fweb%2Fwiklou.git diff --git a/docs/hooks.txt b/docs/hooks.txt index bed562e11c..d93bb6ad07 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -234,6 +234,10 @@ MediaWiki 1.4rc1. This is a list of known events and parameters; please add to it if you're going to add events to the MediaWiki code. +'AbortAutoAccount': Return false to cancel automated local account creation, where normally authentication against an external auth plugin would be creating a local account. +$user: the User object about to be created (read-only, incomplete) +$message: out parameter: error message to be displayed to user + 'AbortAutoblock': Return false to cancel an autoblock. $autoblockip: The IP going to be autoblocked. $block: The block from which the autoblock is coming. @@ -256,7 +260,7 @@ $user: user who is doing the move $err: error message $reason: the reason for the move (added in 1.13) -'AbortNewAccount': Return false to cancel account creation. +'AbortNewAccount': Return false to cancel explicit account creation. $user: the User object about to be created (read-only, incomplete) $message: out parameter: error message to display on abort @@ -356,7 +360,7 @@ $tokenFunctions: array(action => callback) 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to the sites general information. -&$module: the current ApiQuerySiteInfo module +$module: the current ApiQuerySiteInfo module &$results: array of results, add things here 'APIQueryUsersTokens': use this hook to add custom token to list=users. @@ -550,13 +554,6 @@ $name: Image name being checked Change $bad and return false to override. If an image is "bad", it is not rendered inline in wiki pages or galleries in category pages. -'BeforeGalleryFindFile': before an image is fetched for a gallery -&$gallery,: the gallery object -&$nt: the image title -&$time: image timestamp (used to specify the file) -&$descQuery: query string to add to thumbnail URL -&$sha1: image base 36 sha1 (used to specify the file, $nt will be ignored if this is set) - 'BeforeInitialize': before anything is initialized in performRequestForTitle() &$title: Title being used for request &$article: The associated Article object @@ -569,24 +566,27 @@ $mediaWiki: Mediawiki object &$out: OutputPage object &$skin: Skin object +'BeforeParserFetchFileAndTitle': before an image is rendered by Parser +$parser: Parser object +$nt: the image title +&$time: the image timestamp (use '0' to force a broken thumbnail) +&$sha1: image base 36 sha1 (used to specify the file, $nt will be ignored if this is set) +&$descQuery: query string to add to thumbnail URL + 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser -&$parser: Parser object -&$title: title of the template +$parser: Parser object +$title: title of the template &$skip: skip this template and link it? &$id: the id of the revision being parsed -'BeforeParserMakeImageLinkObj': before an image is rendered by Parser -&$parser: Parser object -&$nt: the image title -&$skip: skip this image and link it? -&$time: the image timestamp -&$descQuery: query string to add to thumbnail URL -&$sha1: image base 36 sha1 (used to specify the file, $nt will be ignored if this is set) - 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser &$parser: Parser object &$ig: ImageGallery object +'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user +&$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account +&$injected_html: Any HTML to inject after the "logged in" message of a newly created user account + 'BitmapHandlerTransform': before a file is transformed, gives extension the possibility to transform it themselves $handler: BitmapHandler @@ -811,7 +811,7 @@ $editToken: The user's edit token. 'FetchChangesList': When fetching the ChangesList derivative for a particular user -&$user: User the list is being fetched for +$user: User the list is being fetched for &$skin: Skin object to be used with the list &$list: List object (defaults to NULL, change it to an object instance and return false override the list derivative used) @@ -877,6 +877,14 @@ $title: Title object of page $url: string value as output (out parameter, can modify) $query: query options passed to Title::getLocalURL() +'GetMetadataVersion': modify the image metadata version currently in use. This is + used when requesting image metadata from a ForiegnApiRepo. Media handlers + that need to have versioned metadata should add an element to the end of + the version array of the form 'handler_name=version'. Most media handlers + won't need to do this unless they broke backwards compatibility with a + previous version of the media handler metadata output. +&$version: Array of version strings + 'GetPreferences': modify user preferences $user: User whose preferences are being modified. &$preferences: Preferences description array, to be fed to an HTMLForm object @@ -1120,22 +1128,6 @@ $paramArray: Array of parameters that corresponds to logging.log_params field. &$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 - -'LogPageLogName': name of the logging page(s). -DEPRECATED: Use $wgLogNames -&$typeText: array of strings - -'LogPageLogHeader': strings used by wfMsg as a header. -DEPRECATED: Use $wgLogHeaders -&$headerText: array of strings - -'LogPageActionText': strings used by wfMsg as a header. -DEPRECATED: Use $wgLogActions -&$actionText: array of strings - 'MagicWordMagicWords': When defining new magic word. DEPRECATED: use $magicWords in a file listed in $wgExtensionMessagesFiles instead. @@ -1657,6 +1649,18 @@ target doesn't exist 'SpecialSearchProfiles': allows modification of search profiles &$profiles: profiles, which can be modified. +'SpecialSearchProfileForm': allows modification of search profile forms +$search: special page object +&$form: String: form html +$profile: String: current search profile +$term: String: search term +$opts: Array: key => value of hidden options for inclusion in custom forms + +'SpecialSearchSetupEngine': allows passing custom data to search engine +$search: special page object +$profile: String: current search profile +$engine: the search engine + 'SpecialSearchResults': called before search result display when there are matches $term: string of search term @@ -1998,5 +2002,14 @@ $obj: The XmlDumpWriter object. $row: The database row for the revision. $text: The revision text. +'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add + additional tags to extract. +&$items: Array containing information on which items to extract. See XMPInfo for details on the format. + +'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be + used to post-process the results. +&$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of + metadata tags returned (each tag is either a value, or an array of values). + More hooks might be available but undocumented, you can execute ./maintenance/findhooks.php to find hidden one.