wiki.techinc.nl/includes/Storage/Hook/PageContentSaveHook.php
James D. Forrester 1d0b7ae1e2 Namespace User under \MediaWiki\User
Bug: T166010
Change-Id: I7257302b485588af31384d4f7fc8e30551f161f1
2023-09-19 19:18:16 +00:00

40 lines
1.5 KiB
PHP

<?php
namespace MediaWiki\Storage\Hook;
use Content;
use MediaWiki\CommentStore\CommentStoreComment;
use MediaWiki\User\User;
use StatusValue;
use WikiPage;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "PageContentSave" to register handlers implementing this interface.
*
* @deprecated since 1.35 Use MultiContentSave instead
* @ingroup Hooks
*/
interface PageContentSaveHook {
/**
* This hook is called before an article is saved.
*
* @since 1.35
*
* @param WikiPage $wikiPage WikiPage being saved
* @param User $user User saving the article
* @param Content $content New article content
* @param CommentStoreComment &$summary Edit comment. Can be replaced with a new one.
* @param bool $isminor Whether the edit was marked as minor
* @param null $iswatch Previously a watch flag. Currently unused, always null.
* @param null $section Previously the section number being edited. Currently unused, always null.
* @param int $flags All EDIT_… flags (including EDIT_MINOR) as an integer number.
* See WikiPage::doUserEditContent documentation for flags' definition.
* @param StatusValue $status StatusValue object for the hook handlers resulting status.
* Either set $status->fatal() or return false to abort the save action.
* @return bool|void True or no return value to continue or false to abort
*/
public function onPageContentSave( $wikiPage, $user, $content, &$summary,
$isminor, $iswatch, $section, $flags, $status
);
}