Fix #8629 : document $wgFilterCallback

diff --git a/RELEASE-NOTES b/RELEASE-NOTES
index 6b2216f..92a97dc 100644 (file)
--- a/RELEASE-NOTES
+++ b/RELEASE-NOTES
@@ -73,6 +73,7 @@ it from source control: http://www.mediawiki.org/wiki/Download_from_SVN
   the appropriate permission
 * (bug 8628) Add user-aware block list link to Special:Blockip
 * (bug 8643) Correctly escape the page-specific CSS class for non-Monobook skins
+* (bug 8629) Document $wgFilterCallback
 
 == Languages updated ==
 

diff --git a/includes/DefaultSettings.php b/includes/DefaultSettings.php
index 2f473ee..008ebe1 100644 (file)
--- a/includes/DefaultSettings.php
+++ b/includes/DefaultSettings.php
@@ -1622,7 +1622,17 @@ $wgExportAllowListContributors = false ;
 /** Text matching this regular expression will be recognised as spam
  * See http://en.wikipedia.org/wiki/Regular_expression */
 $wgSpamRegex = false;
-/** Similarly if this function returns true */
+/** Similarly you can get a function to do the job. The function will be given
+ * the following args:
+ *   - a Title object for the article the edit is made on
+ *   - the text submitted in the textarea (wpTextbox1)
+ *   - the section number.
+ * The return should be boolean indicating whether the edit matched some evilness:
+ *  - true : block it
+ *  - false : let it through
+ *
+ * For a complete example, have a look at the SpamBlacklist extension.
+ */
 $wgFilterCallback = false;
 
 /** Go button goes straight to the edit screen if the article doesn't exist. */