HookEvent::removeHook() method

Remove a hook by ID

To remove the hook that this event is for, call it with the $hookId argument as null or blank.

Example

// Remove this hook event, preventing it from executing again
$event->removeHook(null); 

Usage

$hookEvent = $event->removeHook($hookId);

Arguments

NameType(s)Description
hookIdstring, HookEvent, null

ID of hook to remove (ID is returned by the addHook() methods) Since 3.0.137 it may also be an array or CSV string of hook IDs to remove.

Return value


$event methods and properties

API reference based on ProcessWire core version 3.0.244

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer