wiki.techinc.nl/includes/Hook/MediaWikiPerformActionHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

38 lines
1 KiB
PHP

<?php
namespace MediaWiki\Hook;
use Article;
use MediaWiki;
use OutputPage;
use Title;
use User;
use WebRequest;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "MediaWikiPerformAction" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface MediaWikiPerformActionHook {
/**
* Use this hook to override MediaWiki::performAction(). Use this to do
* something completely different, after the basic globals have been set up, but
* before ordinary actions take place.
*
* @since 1.35
*
* @param OutputPage $output Context output
* @param Article $article Article on which the action will be performed
* @param Title $title Title on which the action will be performed
* @param User $user Context user
* @param WebRequest $request Context request
* @param MediaWiki $mediaWiki
* @return bool|void True or no return value to continue or false to abort
*/
public function onMediaWikiPerformAction( $output, $article, $title, $user,
$request, $mediaWiki
);
}