diff options
Diffstat (limited to 'www/wiki/extensions/AbuseFilter/hooks.txt')
| -rw-r--r-- | www/wiki/extensions/AbuseFilter/hooks.txt | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/www/wiki/extensions/AbuseFilter/hooks.txt b/www/wiki/extensions/AbuseFilter/hooks.txt new file mode 100644 index 00000000..e3cd9c95 --- /dev/null +++ b/www/wiki/extensions/AbuseFilter/hooks.txt @@ -0,0 +1,45 @@ +This document describes how event hooks work in the AbuseFilter extension. + +For a more comprehensive guide to hooks, navigate to your root MediaWiki +directory and read docs/hooks.txt. + +== Events and parameters == +This is a list of known events and parameters; please add to it if you're going +to add events to the AbuseFilter extension. + +'AbuseFilter-builder': Allows overwriting of the builder values returned by AbuseFilter::getBuilderValues +&$realValues: Builder values + +'AbuseFilter-computeVariable': Like AbuseFilter-interceptVariable but called if the requested method wasn't found. +Return true to indicate that the method is known to the hook and was computed successful. +$method: Method to generate the variable +$vars: AbuseFilterVariableHolder +$parameters: Parameters with data to compute the value +&$result: Result of the computation + +'AbuseFilter-contentToString': Called when converting a Content object to a string to which +filters can be applied. If the hook function returns true, Content::getTextForSearchIndex() +will be used for non-text content. +$content: The Content object +&$text: Set this to the desired text. + +'AbuseFilter-filterAction': Allows overwriting of abusefilter variables in AbuseFilter::filterAction just +before they're checked against filters. +$vars: AbuseFilterVariableHolder with variables +$title: Title object + +'AbuseFilter-generateTitleVars': Allows altering the variables generated for a title +$vars: AbuseFilterVariableHolder +$title: Title object +$prefix: Variable name prefix + +'AbuseFilter-generateUserVars': Allows altering the variables generated for a specific user +$vars: AbuseFilterVariableHolder +$user: User object + +'AbuseFilter-interceptVariable': Called before a variable is set in AFComputedVariable::compute to be able to set +it before the core code runs. Return false to make the function return right after. +$method: Method to generate the variable +$vars: AbuseFilterVariableHolder +$parameters: Parameters with data to compute the value +&$result: Result of the computation |