MediaWiki\ChangeTags\Hook\ListRestrictedTagsHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onListRestrictedTags (array &$restrictedTags)
	This hook is called when building the map of rights-restricted change tags to the rights that can view them.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 12 of file ListRestrictedTagsHook.php.

Member Function Documentation

onListRestrictedTags()

MediaWiki\ChangeTags\Hook\ListRestrictedTagsHook::onListRestrictedTags

(

array &

$restrictedTags

)

This hook is called when building the map of rights-restricted change tags to the rights that can view them.

A restricted tag is one whose name starts with ChangeTagsStore::PRIVATE_TAG_PREFIX. A rights-restricted tag that is not present in the map is visible to no-one.

Parameters

array<string,string|string[]>

&$restrictedTags Map of tag name to the right(s) required to view the tag. A viewer may see the tag if they have any of the listed rights. All keys MUST use the ChangeTagsStore::PRIVATE_TAG_PREFIX prefix.

Since

1.47

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/ChangeTags/Hook/ListRestrictedTagsHook.php