mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/AbuseFilter.git
synced 2024-11-14 17:55:00 +00:00
f3788c4f0c
This makes AbuseFilter use EditFilterMergedContent if support for the ContentHandler infrastructure is present. This means living without some nice bits of context, because EditFilterMergedContent doesn't provide an EditPage object. This requires core change I99a19c93 to work correctly. Change-Id: Ibb9d4c9a36b8a199213958b920902e8006c71fe8
46 lines
2 KiB
Plaintext
46 lines
2 KiB
Plaintext
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
|