WoW API: hooksecurefunc

From AddOn Studio
Jump to navigation Jump to search

WoW API < hooksecurefunc

Creates a secure 'post hook' for the named function. Your hook will be called with the same arguments, but will not be able to affect the outcome of the original call.

hooksecurefunc([table,] "functionName", hookfunc)



Optional Table - if you're hooking a function on an object, provide a reference to the object.
String - the name of the function being hooked.
Function - your hook function.


hooksecurefunc("CastSpellByName", print); -- Hooks the global CastSpellByName
hooksecurefunc(GameTooltip, "SetUnitBuff", print); -- Hooks GameTooltip.SetUnitBuff


Hooks CastSpellByName and GameTooltip.SetUnitBuff without compromising their secure status. When those functions are called, prints their argument list into the default chat frame.


This is the only safe way to hook functions that execute protected functionality.

The hookfunc is invoked after the original function, and receives the same parameters; return values from hookfunc are discarded.

If another addon, or the same addon, replaces functionName after you use this function to hook it, hookfunc will no longer fire. ... except of course if your new function calls the old original!

hooksecurefunc("ToggleBackpack", function(...)
    print("ToggleBackpack called.")
ToggleBackpack = function(...)
    -- Do something different
ToggleBackpack() -- "ToggleBackpack called." never prints.

After hooksecurefunc() is used on a function, setfenv() throws an error when attempted on that function

You cannot "unhook" a function that is hooked with this function except by a UI reload. Calling hooksecurefunc() multiple times only adds more hooks to be called.

 hooksecurefunc("ToggleBackpack", function() print(1) end)
 hooksecurefunc("ToggleBackpack", function() print(2) end)
 > 1
 > 2

Also note that using hooksecurefunc() may not always produce the expected result. Keep in mind that it actually replaces the original function with a new one (the function reference changes).

For example, if you try to hook the global function "MacroFrame_OnHide" (after the macro frame has been displayed), your function will not be called when the macro frame is closed.

It's simply because in Blizzard_MacroUI.xml the OnHide function call is registered like this:

<OnHide function="MacroFrame_OnHide"/>

The function ID called when the frame is hidden is the former one, before you hooked "MacroFrame_OnHide". The workaround is to hook a function called by "MacroFrame_OnHide":

hooksecurefunc(MacroPopupFrame, "Hide", MyFunction)

However, when you want to hook a frame's script handler, it's better to use Frame:HookScript like this:

MacroPopupFrame:HookScript("OnHide", MyFunction) -- the client will call MacroFrame_OnHide(MacroPopupFrame) first followed by MyFunction(MacroPopupFrame)