Manual:Hooks/ArticleSaveComplete

From MediaWiki.org
Jump to: navigation, search
ArticleSaveComplete
Available from version 1.4.0
Occurs after the save article request has been processed.
Define function:
public static function onArticleSaveComplete( &$article, &$user, $text, $summary,<br />$minoredit, $watchthis, $sectionanchor, &$flags, $revision, &$status, $baseRevId ) { ... }
Attach hook:
$wgHooks['ArticleSaveComplete'][] = 'MyExtensionHooks::onArticleSaveComplete';
Called from: File(s): WikiPage.php

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


Details[edit | edit source]

  • $article: the article (object) saved
  • $user: the user (object) who saved the article
  • $text: the new article text
  • $summary: the article summary (comment)
  • $minoredit: minor flag
  • $watchthis: not used as of 1.8
  • $section: not used as of 1.8
  • $flags: bitfield, see includes/Article.php for details
  • $revision: the new Revision object that was just saved or NULL if the user clicked save without changing any page text (only v1.11.0 and newer).
  • $status: the Status object that will be returned by Article::doEdit() (since 1.14.0)
  • $baseRevId: revision ID on which this edit is based (since 1.15.0)

The function should return true to continue hook processing or false to abort. This hook will be triggered both by edits made through the edit page, and by edits made through the API.

Notes[edit | edit source]

This did not apply to newly uploaded images until v1.4.5.

  • Version 1.4.x - 1.5.x: included in EditPage.php and Image.php.
  • Version 1.6.x - 1.10.x:included in Article::updateArticle() and Article::insertArticle().
  • Version 1.11+: included in Article::doEdit().
  • Version 1.18+: moved to WikiPage.php

insertNewArticle() and updateArticle() will watch/unwatch pages after doEdit() (and hence ArticleSaveComplete) are run.

Example handler[edit | edit source]

/**
 * Occurs after the save article request has been processed.
 * @see https://www.mediawiki.org/wiki/Manual:Hooks/ArticleSaveComplete
 *
 * @param WikiPage $article
 * @param User $user
 * @param string $text
 * @param string $summary
 * @param boolean $minoredit
 * @param boolean $watchthis
 * @param $sectionanchor deprecated
 * @param integer $flags
 * @param Revision $revision
 * @param Status $status
 * @param integer $baseRevId
 *
 * @return boolean
 */
public static function onArticleSaveComplete( WikiPage &$article, User &$user, $text, $summary,
		$minoredit, $watchthis, $sectionanchor, &$flags, Revision $revision, Status &$status, $baseRevId ) {
 
}

See also[edit | edit source]