Updated documentation and cleaned up code for trigger_plugin_hook().

git-svn-id: http://code.elgg.org/elgg/trunk@6210 36083f99-b078-4883-b0ff-0f9b5a30f544

diff --git a/engine/lib/elgglib.php b/engine/lib/elgglib.php
index ea2ca9f743e336a48dced079a736324e445bdb0a..ec683414e12d8e70c5ffef7f6f8e4cb5fce3d787 100644 (file)
--- a/engine/lib/elgglib.php
+++ b/engine/lib/elgglib.php
@@ -176,7 +176,7 @@ function elgg_does_viewtype_fallback($viewtype) {
        if (isset($CONFIG->viewtype) && isset($CONFIG->viewtype->fallback)) {
                return in_array($viewtype, $CONFIG->viewtype->fallback);
        }
-       
+
        return FALSE;
 }
 
@@ -1352,9 +1352,9 @@ function set_template_handler($function_name) {
 /**
  * Extends a view.
  *
- * The addititional views are displayed before or after the primary view. 
- * Priorities less than 500 are displayed before the primary view and 
- * greater than 500 after. The default priority is 501. 
+ * The addititional views are displayed before or after the primary view.
+ * Priorities less than 500 are displayed before the primary view and
+ * greater than 500 after. The default priority is 501.
  *
  * @param string $view The view to extend.
  * @param string $view_extension This view is added to $view
@@ -1413,7 +1413,7 @@ function elgg_unextend_view($view, $view_extension) {
        }
 
        unset($CONFIG->views->extensions[$view][$priority]);
-       
+
        return TRUE;
 }
 
@@ -2037,61 +2037,49 @@ function unregister_plugin_hook($hook, $entity_type, $function) {
 
 /**
  * Triggers a plugin hook, with various parameters as an array. For example, to provide
- * a 'foo' hook that concerns an entity of type 'bar', with a parameter called 'param1'
+ * a 'foo' hook that concerns the type 'bar', with a parameter called 'param1'
  * with value 'value1', that by default returns true, you'd call:
  *
  * trigger_plugin_hook('foo', 'bar', array('param1' => 'value1'), true);
  *
  * @see register_plugin_hook
- * @param string $hook The name of the hook to trigger
- * @param string $entity_type The name of the entity type to trigger it for (or "all", or "none")
+ * @param string $hook The name of the hook to trigger (NB: "all" will trigger for all $types regardless of $hook value)
+ * @param string $type The type of the hook to trigger (NB: "all" will trigger for all $hooks regardless of $type value)
  * @param array $params Any parameters. It's good practice to name the keys, i.e. by using array('name' => 'value', 'name2' => 'value2')
  * @param mixed $returnvalue An initial return value
  * @return mixed|null The cumulative return value for the plugin hook functions
  */
-function trigger_plugin_hook($hook, $entity_type, $params = null, $returnvalue = null) {
+function trigger_plugin_hook($hook, $type, $params = null, $returnvalue = null) {
        global $CONFIG;
 
-       //if (!isset($CONFIG->hooks) || !isset($CONFIG->hooks[$hook]) || !isset($CONFIG->hooks[$hook][$entity_type]))
-       //      return $returnvalue;
-
-       if (!empty($CONFIG->hooks[$hook][$entity_type]) && is_array($CONFIG->hooks[$hook][$entity_type])) {
-               foreach($CONFIG->hooks[$hook][$entity_type] as $hookfunction) {
-                       $temp_return_value = $hookfunction($hook, $entity_type, $returnvalue, $params);
+       if (!empty($CONFIG->hooks[$hook][$type]) && is_array($CONFIG->hooks[$hook][$type])) {
+               foreach($CONFIG->hooks[$hook][$type] as $hookfunction) {
+                       $temp_return_value = $hookfunction($hook, $type, $returnvalue, $params);
                        if (!is_null($temp_return_value)) {
                                $returnvalue = $temp_return_value;
                        }
                }
        }
-       //else
-       //if (!isset($CONFIG->hooks['all'][$entity_type]))
-       //      return $returnvalue;
 
-       if (!empty($CONFIG->hooks['all'][$entity_type]) && is_array($CONFIG->hooks['all'][$entity_type])) {
-               foreach($CONFIG->hooks['all'][$entity_type] as $hookfunction) {
-                       $temp_return_value = $hookfunction($hook, $entity_type, $returnvalue, $params);
+       if (!empty($CONFIG->hooks['all'][$type]) && is_array($CONFIG->hooks['all'][$type])) {
+               foreach($CONFIG->hooks['all'][$type] as $hookfunction) {
+                       $temp_return_value = $hookfunction($hook, $type, $returnvalue, $params);
                        if (!is_null($temp_return_value)) $returnvalue = $temp_return_value;
                }
        }
-       //else
-       //if (!isset($CONFIG->hooks[$hook]['all']))
-       //      return $returnvalue;
 
        if (!empty($CONFIG->hooks[$hook]['all']) && is_array($CONFIG->hooks[$hook]['all'])) {
                foreach($CONFIG->hooks[$hook]['all'] as $hookfunction) {
-                       $temp_return_value = $hookfunction($hook, $entity_type, $returnvalue, $params);
+                       $temp_return_value = $hookfunction($hook, $type, $returnvalue, $params);
                        if (!is_null($temp_return_value)) {
                                $returnvalue = $temp_return_value;
                        }
                }
        }
-       //else
-       //if (!isset($CONFIG->hooks['all']['all']))
-       //      return $returnvalue;
 
        if (!empty($CONFIG->hooks['all']['all']) && is_array($CONFIG->hooks['all']['all'])) {
                foreach($CONFIG->hooks['all']['all'] as $hookfunction) {
-                       $temp_return_value = $hookfunction($hook, $entity_type, $returnvalue, $params);
+                       $temp_return_value = $hookfunction($hook, $type, $returnvalue, $params);
                        if (!is_null($temp_return_value)) {
                                $returnvalue = $temp_return_value;
                        }
@@ -3176,7 +3164,7 @@ function elgg_walled_garden_index() {
                'body' => $login,
                'sysmessages' => system_messages(NULL, ''),
        ));
-       
+
        // @hack Index must exit to keep plugins from continuing to extend
        exit;
        return TRUE;