MediaWiki  master
MediaWiki\Hook\ArticleRevisionVisibilitySetHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\ArticleRevisionVisibilitySetHook:

Public Member Functions

 onArticleRevisionVisibilitySet ( $title, $ids, $visibilityChangeMap)
 This hook is called when changing visibility of one or more revisions of an article. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file ArticleRevisionVisibilitySetHook.php.

Member Function Documentation

◆ onArticleRevisionVisibilitySet()

MediaWiki\Hook\ArticleRevisionVisibilitySetHook::onArticleRevisionVisibilitySet (   $title,
  $ids,
  $visibilityChangeMap 
)

This hook is called when changing visibility of one or more revisions of an article.

Since
1.35
Parameters
Title$titleTitle of the article
int[]$idsIDs to set the visibility for
array$visibilityChangeMapMap of revision ID to oldBits and newBits. This array can be examined to determine exactly what visibility bits have changed for each revision. This array is of the form: [id => ['oldBits' => $oldBits, 'newBits' => $newBits], ... ]
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


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