aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCash Costello <cash.costello@gmail.com>2011-11-05 08:01:31 -0400
committerCash Costello <cash.costello@gmail.com>2011-11-05 08:01:31 -0400
commit0d35f463fbc4ce7d50b6c1540f3c50eb4263440e (patch)
treed4ab5cfaf6c59eaecfdfdd19a99346da6b7e9b10
parent9afd9bfd044743d5907464b79c5904ced06cf21b (diff)
downloadelgg-0d35f463fbc4ce7d50b6c1540f3c50eb4263440e.tar.gz
elgg-0d35f463fbc4ce7d50b6c1540f3c50eb4263440e.tar.bz2
Refs #4053 improved documentation of page_handler()
-rw-r--r--engine/lib/pagehandler.php6
1 files changed, 5 insertions, 1 deletions
diff --git a/engine/lib/pagehandler.php b/engine/lib/pagehandler.php
index f331e2aae..aba921416 100644
--- a/engine/lib/pagehandler.php
+++ b/engine/lib/pagehandler.php
@@ -7,7 +7,11 @@
*/
/**
- * Turns the current page over to the page handler, allowing registered handlers to take over.
+ * Routes the request to a registered page handler
+ *
+ * This function sets the context based on the handler name (first segment of the
+ * URL). It also triggers a plugin hook 'route', $handler so that plugins can
+ * modify the routing or handle a request.
*
* @param string $handler The name of the handler type (eg 'blog')
* @param array $page The parameters to the page, as an array (exploded by '/' slashes)