WoW:API hooksecurefunc - Revision history

Move page script: Move page script moved page API hooksecurefunc to WoW:API hooksecurefunc without leaving a redirect

2023-08-15T04:46:40Z

Move page script moved page API hooksecurefunc to API hooksecurefunc without leaving a redirect

← Older revision

Revision as of 04:46, 15 August 2023

WoWWiki>Metalmiser: Fixed minor typo; exemple to example.

2010-09-03T07:03:47Z

Fixed minor typo; exemple to example.

← Older revision		Revision as of 07:03, 3 September 2010
Line 43:		Line 43:
	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).		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 ~~exemple~~, 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.		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:		It's simply because in Blizzard_MacroUI.xml the OnHide function call is registered like this:

WoWWiki>Egingell: /* Notes */ No reason to prefix code with ">". Also, added note about :HookScript() being better than this function when you want to hook a frame's script handler.

2009-07-02T22:21:53Z

Notes: No reason to prefix code with ">". Also, added note about :HookScript() being better than this function when you want to hook a frame's script handler.

← Older revision		Revision as of 22:21, 2 July 2009
Line 46:		Line 46:

	It's simply because in Blizzard_MacroUI.xml the OnHide function call is registered like this:		It's simply because in Blizzard_MacroUI.xml the OnHide function call is registered like this:
	> <OnHide function="MacroFrame_OnHide"/>		<OnHide function="MacroFrame_OnHide"/>
	The function ID called when the frame is hidden is the former one, before you ~~hoocked~~ "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":		The workaround is to hook a function called by "MacroFrame_OnHide":
	> hooksecurefunc(MacroPopupFrame, "Hide", MyFunction);		hooksecurefunc(MacroPopupFrame, "Hide", MyFunction)
			However, when you want to hook a frame's script handler, it's better to use [[API_Frame_HookScript\|Frame:HookScript]] like this:
			MacroPopupFrame:HookScript("OnHide", MyFunction) -- the client will call MacroFrame_OnHide(MacroPopupFrame) first followed by MyFunction(MacroPopupFrame)

WoWWiki>Archarodim: Added a note about hooking Blizzard frame event handler

2009-07-02T07:47:14Z

Added a note about hooking Blizzard frame event handler

← Older revision		Revision as of 07:47, 2 July 2009
Line 36:		Line 36:
	hooksecurefunc("ToggleBackpack", function() print(1) end)		hooksecurefunc("ToggleBackpack", function() print(1) end)
	hooksecurefunc("ToggleBackpack", function() print(2) end)		hooksecurefunc("ToggleBackpack", function() print(2) end)

	ToggleBackpack()		ToggleBackpack()
	> 1		> 1
	> 2		> 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 exemple, 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 hoocked "MacroFrame_OnHide".
			The workaround is to hook a function called by "MacroFrame_OnHide":
			> hooksecurefunc(MacroPopupFrame, "Hide", MyFunction);

WoWWiki>Starlightblunder: /* Example */ Use the 3.0 print.

2009-02-21T21:11:59Z

Example: Use the 3.0 print.

← Older revision		Revision as of 21:11, 21 February 2009
Line 11:		Line 11:

	==Example==		==Example==
	~~local echoHook = function (...)~~		hooksecurefunc("CastSpellByName", print); -- Hooks the global CastSpellByName
	~~local msg = "";~~		hooksecurefunc(GameTooltip, "SetUnitBuff", print); -- Hooks GameTooltip.SetUnitBuff
	~~for k,v in pairs({...}) do msg = msg .. k .. "=[" .. tostring(v) .."] "; end;~~
	~~DEFAULT_CHAT_FRAME:AddMessage("[Echo] " .. msg);~~
	~~end;~~
	hooksecurefunc("CastSpellByName", ~~echoHook~~); -- Hooks the global CastSpellByName
	hooksecurefunc(GameTooltip, "SetUnitBuff", ~~echoHook~~); -- Hooks GameTooltip.SetUnitBuff
	===Result===		===Result===
	Hooks CastSpellByName and GameTooltip.SetUnitBuff without compromising their secure status. When those functions are called, prints their argument list into the default chat frame.		Hooks CastSpellByName and GameTooltip.SetUnitBuff without compromising their secure status. When those functions are called, prints their argument list into the default chat frame.

WoWWiki>Mikk: /* Notes */

2008-12-07T06:54:40Z

Notes

← Older revision		Revision as of 06:54, 7 December 2008
Line 26:		Line 26:
	The ''hookfunc'' is invoked after the original function, and receives the same parameters; return values from hookfunc are discarded.		The ''hookfunc'' is invoked after the original function, and receives the same parameters; return values from hookfunc are discarded.

	~~You can only hook a global function using this function.~~		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!

	If another addon, or the same addon, replaces ''functionName'' after you use this function to hook it, ''hookfunc'' will no longer fire.
	hooksecurefunc("ToggleBackpack", function(...)		hooksecurefunc("ToggleBackpack", function(...)
	print("ToggleBackpack called.")		print("ToggleBackpack called.")
Line 39:		Line 37:
	After hooksecurefunc() is used on a function, setfenv() throws an error when attempted on that function		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.		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.
	~~-- this doesn~~'~~t work as expected~~
			hooksecurefunc("ToggleBackpack", function() print(1) end)
	~~-- Make SetItemRef output the item to the chat frame~~		hooksecurefunc("ToggleBackpack", function() print(2) end)
	hooksecurefunc(~~'SetItemRef'~~, function(~~item~~)		ToggleBackpack()
	~~ChatFrame1:AddMessage~~(~~item~~)		> 1
	)		> 2

	~~-- unhook, maybe. I don't think do. It produces an error and SetItemRef~~(~~) still prints to the chat frame.~~
	~~-- Error:~~ "~~hooksecurefunc('SetItemRef', nil)...~~"~~:1: Usage: hooksecurefunc([table~~,~~] "~~function~~", hookfunc~~)
	~~hooksecurefunc~~(~~'SetItemRef', nil~~)

	~~-- change the hook? Nope. No error, but SetItemRef(~~) ~~still prints to the chat frame and then the item is saved to MySavedVariable.~~
	~~hooksecurefunc('SetItemRef', function~~(~~item~~)
	~~MySavedVariable = item~~
	)

WoWWiki>Egingell at 09:06, 22 July 2008

2008-07-22T09:06:01Z

@@ Line 13: / Line 13: @@
   local echoHook = function (...)
    local msg = "";
-   table.foreach({...}, function(k,v) msg = msg .. k .. "=[" .. tostring(v) .."] "; end);
+   for k,v in pairs({...}) do msg = msg .. k .. "=[" .. tostring(v) .."] "; end;
    DEFAULT_CHAT_FRAME:AddMessage("[Echo] " .. msg);
   end;
@@ Line 24: / Line 24: @@
 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.
+The ''hookfunc'' is invoked after the original function, and receives the same parameters; return values from hookfunc are discarded.
 After hooksecurefunc() is used on a function, setfenv() throws an error when attempted on that function

WoWWiki>Brodrick: /* Example */

2007-01-04T21:53:25Z

Example

← Older revision		Revision as of 21:53, 4 January 2007
Line 12:		Line 12:
	==Example==		==Example==
	local echoHook = function (...)		local echoHook = function (...)
	local msg = , "";		local msg = "";
	table.foreach({...}, function(k,v) msg = msg .. k .. "=[" .. tostring(v) .."] "; end);		table.foreach({...}, function(k,v) msg = msg .. k .. "=[" .. tostring(v) .."] "; end);
	DEFAULT_CHAT_FRAME:AddMessage("[Echo] " .. msg);		DEFAULT_CHAT_FRAME:AddMessage("[Echo] " .. msg);

WoWWiki>Starlightblunder at 01:32, 28 December 2006

2006-12-28T01:32:56Z

← Older revision		Revision as of 01:32, 28 December 2006
Line 1:		Line 1:
	{{wowapi}}__NOTOC__		{{wowapi}}__NOTOC__
	Creates a secure 'post hook' for the named function. ~~The hookfunc is invoked after~~ the ~~original function~~, ~~and receives~~ the ~~same parameters. Return values from hookfunc are discarded. This is~~ the ~~only safe way to hook functions that execute protected functionality~~.		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)		hooksecurefunc([table,] "functionName", hookfunc)

	===~~Takes~~===		==Parameters==
	:;table : ~~table which~~ functionName ~~exists on~~		===Arguments===
			:;table : Optional Table - if you're hooking a function on an object, provide a reference to the object.
			:;functionName : String - the name of the function being hooked.
			:;hookfunc : Function - your hook function.

	:;"~~functionName~~" : the ~~name of~~ the ~~function being hooked~~		==Example==
			local echoHook = function (...)
			local msg = , "";
			table.foreach({...}, function(k,v) msg = msg .. k .. "=[" .. tostring(v) .."] "; end);
			DEFAULT_CHAT_FRAME:AddMessage("[Echo] " .. msg);
			end;
			hooksecurefunc("CastSpellByName", echoHook); -- Hooks the global CastSpellByName
			hooksecurefunc(GameTooltip, "SetUnitBuff", echoHook); -- Hooks GameTooltip.SetUnitBuff
			===Result===
			Hooks CastSpellByName and GameTooltip.SetUnitBuff without compromising their secure status. When those functions are called, prints their argument list into the default chat frame.

	~~:;hookfunc : the hook function~~		==Notes==
	==~~=Returns=~~==		This is the only safe way to hook functions that execute protected functionality.
	~~: Nothing~~

	~~===Details===~~		The hookfunc is invoked after the original function, and receives the same parameters; return values from hookfunc are discarded.
	* After hooksecurefunc() is used on a function, setfenv() throws an error when attempted on that function
			After hooksecurefunc() is used on a function, setfenv() throws an error when attempted on that function

WoWWiki>Endx7 at 06:04, 26 December 2006

2006-12-26T06:04:50Z

New page

{{wowapi}}__NOTOC__
Creates a secure 'post hook' for the named function. The hookfunc is invoked after the original function, and receives the same parameters. Return values from hookfunc are discarded. This is the only safe way to hook functions that execute protected functionality.
hooksecurefunc([table,] "functionName", hookfunc)

===Takes===
:;table : table which functionName exists on

:;"functionName" : the name of the function being hooked

:;hookfunc : the hook function
===Returns===
: Nothing

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