mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/AbuseFilter.git
synced 2024-11-12 00:38:23 +00:00
6bc630cfef
Variables regarding title (full list in task description) are quite deceiving, since they use "text" instead of "title". As proposed in the task, this is the first patch to add aliases for those variables and slightly deprecate the old ones. In the future we may be able to replace every occurrence (either with a search function or directly on the database), but even a coexistence would be enough to avoid confusion. A wfDebug log is generated whenever a deprecated variable is parsed. The "article_" prefix is also changed to "title_", in the same way as above. Also, added a hook which other extension may use to specify their deprecated variables, which will be handled the same as core ones. Bug: T173889 Change-Id: I5c370b54e6516889624088e27928ad3a1f48a821
50 lines
2.2 KiB
Plaintext
50 lines
2.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-deprecatedVariables': Allows adding deprecated variables. If a filter uses an old variable, the parser
|
|
will automatically translate it to the new one.
|
|
&$deprecatedVariables: array of deprecated variables, syntax: [ 'old_name' => 'new_name' ]
|
|
|
|
'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
|