MediaWiki master
MediaWiki\Hook\TitleMoveHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onTitleMove (Title $old, Title $nt, User $user, $reason, Status &$status)
 This hook is called before moving an article (title).
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 16 of file TitleMoveHook.php.

Member Function Documentation

◆ onTitleMove()

MediaWiki\Hook\TitleMoveHook::onTitleMove ( Title $old,
Title $nt,
User $user,
$reason,
Status & $status )

This hook is called before moving an article (title).

Since
1.35
Parameters
Title$oldOld title
Title$ntNew title
User$userUser who does the move
string$reasonReason provided by the user
Status&$statusTo abort the move, add a fatal error to this object (i.e. call $status->fatal())
Returns
bool|void True or no return value to continue or false to abort

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