unb_lib/plugin.lib.php contents

Plug-in functions

Functions

UnbBeginPlugin Temporary store the current plug-in's name for further function calls.
This function must be called by a plug-in script for internal management.

UnbCallHook Call all functions registered for a hook ID

UnbCallHookN Call all functions registered for a hook ID with no data passed.
Since the hook functions will require a parameter to be passed, a local empty string is used.

UnbCurrentHook Returns the currently processed hook ID.
Can be called from hook handling functions that are assigned to multiple hooks.

UnbDebugHooks Show debug output of current hook registration

UnbEndPlugin This function must be called by a plug-in script for internal management.

UnbPluginEnabled Called by a plug-in to determine whether it's enabled.
A plug-in is generally enabled when it's there, but it can be disabled manually by
a board configuration option (disable_plugins) or version conflicts. Also improperly
coded plug-ins (i.e. if the description information is missing) may be disabled.

UnbPluginMeta Store meta data of a plug-in

UnbRegisterHook Register a new plug-in hook function

UnbUnregisterHook Unregister a plug-in hook function

Classes

No classes in this file.

Constants

No constants in this file.

UnbBeginPlugin	Temporary store the current plug-in's name for further function calls. This function must be called by a plug-in script for internal management.
UnbCallHook	Call all functions registered for a hook ID
UnbCallHookN	Call all functions registered for a hook ID with no data passed. Since the hook functions will require a parameter to be passed, a local empty string is used.
UnbCurrentHook	Returns the currently processed hook ID. Can be called from hook handling functions that are assigned to multiple hooks.
UnbDebugHooks	Show debug output of current hook registration
UnbEndPlugin	This function must be called by a plug-in script for internal management.
UnbPluginEnabled	Called by a plug-in to determine whether it's enabled. A plug-in is generally enabled when it's there, but it can be disabled manually by a board configuration option (disable_plugins) or version conflicts. Also improperly coded plug-ins (i.e. if the description information is missing) may be disabled.
UnbPluginMeta	Store meta data of a plug-in
UnbRegisterHook	Register a new plug-in hook function
UnbUnregisterHook	Unregister a plug-in hook function