« Back to Product

Documentation

UnregisterHook

Require: IP-Symcon >= 8.2

 boolean UnregisterHook (string $Address) 

Parameters

Address

Address of the hook

Returns

If the command could be executed successfully, the result is TRUE, otherwise FALSE.

Description

This function unregisters a previously registered WebHook with the address in WebHook Control. Since registered WebHooks are transient, it is normally not necessary to use UnregisterHook. Unless, for example, you want to change the hook in ApplyChanges during runtime. In this case, the old hook can be unregistered and the new one registered.

Warning

This function can only be used for IPSModuleStrict.

Example

// IPSModuleStrict
public function ApplyChanges(): void {
...
    $this->UnregisterHook('my-module');
...
}
Any questions?