MediaWiki  master
MediaWiki\Hook\EditFilterMergedContentHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\Hook\EditFilterMergedContentHook:

Public Member Functions

 onEditFilterMergedContent (IContextSource $context, Content $content, Status $status, $summary, User $user, $minoredit)
 Use this hook for a post-section-merge edit filter. More...
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "EditFilterMergedContent" to register handlers implementing this interface.

Stability: stable
to implement

Definition at line 17 of file EditFilterMergedContentHook.php.

Member Function Documentation

◆ onEditFilterMergedContent()

MediaWiki\Hook\EditFilterMergedContentHook::onEditFilterMergedContent ( IContextSource  $context,
Content  $content,
Status  $status,
  $summary,
User  $user,
  $minoredit 
)

Use this hook for a post-section-merge edit filter.

This may be triggered by the EditPage or any other facility that modifies page content. Use the $status object to indicate whether the edit should be allowed and to provide a reason for disallowing it. $status->apiHookResult can be set to an array to be returned by api.php action=edit. This is used to deliver captchas.

Since
1.35
Parameters
IContextSource$context
Content$contentContent of the edit box
Status$statusStatus object to represent errors, etc.
string$summaryEdit summary for page
User$userUser whois performing the edit
bool$minoreditWhether the edit was marked as minor by the user.
Returns
bool|void True or no return value to continue or false to abort the edit. Returning true if $status->isOK() returns false means "don't save but continue user interaction", e.g. show the edit form.

The documentation for this interface was generated from the following file: