- }
- }
-
- // This function executes a hook
- function do_hook ($name) {
- global $squirrelmail_plugin_hooks;
- $Data = func_get_args();
- if (isset($squirrelmail_plugin_hooks[$name]) &&
- is_array($squirrelmail_plugin_hooks[$name])) {
- foreach ($squirrelmail_plugin_hooks[$name] as $id => $function) {
- // Add something to set correct gettext domain for plugin
+ }
+ }
+}
+
+/**
+ * This function executes a hook.
+ * @param string $name Name of hook to fire
+ * @return mixed $data
+ */
+function do_hook ($name) {
+ global $squirrelmail_plugin_hooks, $currentHookName;
+ $data = func_get_args();
+ $currentHookName = $name;
+
+ if (isset($squirrelmail_plugin_hooks[$name])
+ && is_array($squirrelmail_plugin_hooks[$name])) {
+ foreach ($squirrelmail_plugin_hooks[$name] as $function) {
+ /* Add something to set correct gettext domain for plugin. */
+ if (function_exists($function)) {
+ $function($data);
+ }
+ }
+ }
+
+ $currentHookName = '';
+
+ /* Variable-length argument lists have a slight problem when */
+ /* passing values by reference. Pity. This is a workaround. */
+ return $data;
+}
+
+/**
+ * This function executes a hook and allows for parameters to be passed.
+ *
+ * @param string name the name of the hook
+ * @param mixed param the parameters to pass to the hook function
+ * @return mixed the return value of the hook function
+ */
+function do_hook_function($name,$parm=NULL) {
+ global $squirrelmail_plugin_hooks, $currentHookName;
+ $ret = '';
+ $currentHookName = $name;
+
+ if (isset($squirrelmail_plugin_hooks[$name])
+ && is_array($squirrelmail_plugin_hooks[$name])) {
+ foreach ($squirrelmail_plugin_hooks[$name] as $function) {
+ /* Add something to set correct gettext domain for plugin. */
+ if (function_exists($function)) {
+ $ret = $function($parm);
+ }
+ }
+ }
+
+ $currentHookName = '';
+
+ /* Variable-length argument lists have a slight problem when */
+ /* passing values by reference. Pity. This is a workaround. */
+ return $ret;
+}
+
+/**
+ * This function executes a hook, concatenating the results of each
+ * plugin that has the hook defined.
+ *
+ * @param string name the name of the hook
+ * @param mixed parm optional hook function parameters
+ * @return string a concatenation of the results of each plugin function
+ */
+function concat_hook_function($name,$parm=NULL) {
+ global $squirrelmail_plugin_hooks, $currentHookName;
+ $ret = '';
+ $currentHookName = $name;
+
+ if (isset($squirrelmail_plugin_hooks[$name])
+ && is_array($squirrelmail_plugin_hooks[$name])) {
+ foreach ($squirrelmail_plugin_hooks[$name] as $function) {
+ /* Concatenate results from hook. */