summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSam Boyer2008-08-30 10:18:42 (GMT)
committer Sam Boyer2008-08-30 10:18:42 (GMT)
commit9c3d32f0db7ee4cc328beafe1caea98fc41fe4ac (patch)
tree25cc86438e1eb42f033f7fe4bc4050f917d21521
parente00bb2ca9d9cbbe181cfb58d8440e8c569ee58f5 (diff)
backported docblock updates to hook loading function
-rw-r--r--includes/plugins.inc15
1 files changed, 11 insertions, 4 deletions
diff --git a/includes/plugins.inc b/includes/plugins.inc
index d5b0a17..b548f3d 100644
--- a/includes/plugins.inc
+++ b/includes/plugins.inc
@@ -1415,11 +1415,18 @@ function panels_panels_include_directory($plugin_type) {
}
/**
- * Load plugin info for all hooks; this is handled separately from plugins
- * from files. This caches so we don't find ourselves building it repeatedly.
+ * Load plugin info for the provided hook; this is handled separately from
+ * plugins from files.
*
- * NOTE: This hook does work, but if you are implementing Panels in a client,
- * @see panels_get_include_directories() as it is the preferred method.
+ * IMPORTANT: The hooks invoked by this function do work, but it is _not_ the
+ * preferred method, as it is left up to the module invoking the hook to handle
+ * including separate .inc files with potentially unneeded functions - and there
+ * is no way for any entity external to the Panels engine to know if that
+ * inclusion is necessary. Consequently, hook_panels_include_directory() should
+ * be used unless some aspect of the client's implementation is incompatible
+ * with that approach.
+ *
+ * @see panels_get_include_directories()
*
* @ingroup HookInvokers
*