MediaWiki\Block\Hook\SpreadAnyEditBlockHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onSpreadAnyEditBlock ( $user, bool &$blockWasSpread)
	Use this hook to spread any blocks that are not provided by core when User::spreadAnyEditBlock is called.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file SpreadAnyEditBlockHook.php.

Member Function Documentation

onSpreadAnyEditBlock()

MediaWiki\Block\Hook\SpreadAnyEditBlockHook::onSpreadAnyEditBlock	(		$user,
		bool &	$blockWasSpread )

Use this hook to spread any blocks that are not provided by core when User::spreadAnyEditBlock is called.

Since

1.43

Parameters

User	$user	The user to check for blocks that should be spread
bool	&$blockWasSpread	Whether any block was spread

Returns

bool|void True or no return value to continue, or false to cancel

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/block/Hook/SpreadAnyEditBlockHook.php