MediaWiki\Block\Hook\GetAllBlockActionsHook Interface Reference

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

Inheritance diagram for MediaWiki\Block\Hook\GetAllBlockActionsHook:

Public Member Functions
	onGetAllBlockActions (&$actions)
	Use this hook to add an action or actions that may be blocked by a partial block.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 12 of file GetAllBlockActionsHook.php.

Member Function Documentation

onGetAllBlockActions()

MediaWiki\Block\Hook\GetAllBlockActionsHook::onGetAllBlockActions

(

&

$actions

)

Use this hook to add an action or actions that may be blocked by a partial block.

Add an item to the $actions array with:

• key: unique action string (as it appears in the code)
• value: unique integer ID

The ID must be 100 or greater (IDs below 100 are reserved for core actions), must not conflict with other extension IDs, and must be documented at: https://www.mediawiki.org/wiki/Manual:Hooks/GetAllBlockActions

Since

1.37

Parameters

int[]

&$actions

Array of actions, which may be added to

Returns

bool|void True or no return value to continue; callers of this hook should not abort it

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/block/Hook/GetAllBlockActionsHook.php