Manual:Hooks/EditFilterMerged

EditFilterMerged
Available from version 1.12.0 Removed in version 1.29.0 Post-section-merge edit filter
Define function:	public static function onEditFilterMerged( $editor, $text, &$error, $summary ) { ... }
Attach hook:	In extension.json: { "Hooks": { "EditFilterMerged": "MediaWiki\\Extension\\MyExtension\\Hooks::onEditFilterMerged" } }
Called from:	File(s): EditPage.php
Interface:	EditFilterMergedHook.php

For more information about attaching hooks, see Manual:Hooks .
For examples of extensions using this hook, see Category:EditFilterMerged extensions.

Details

• $editor: EditPage instance (object)
• $text: content of the revised article
• &$error: error message to return (broken until MW 1.16alpha)
• $summary: edit summary provided for edit

Notes

• As of MW 1.16alpha (r55681), you have the same two options for filtering edits as with the EditFilter hook:
  • Return false to halt editing. You'll need to handle error messages, etc. yourself.
  • Return true and modify $error (set to a value other than ''). This will cause the page to stay in edit mode and will cause the contents of $error to be displayed above the edit box. Note: $error should be wikitext.
• In earlier versions, your only option is to return false to halt editing (handling error messages yourself). Setting $error will not force the page to stay in edit mode.

• $text is the entire article, after incorporating the submitted text (the contents of the edit box) into the rest of the article; any sections of the article that the editor was not revising have been combined with the submitted text.

See also

• EditFilter