From 0d35f463fbc4ce7d50b6c1540f3c50eb4263440e Mon Sep 17 00:00:00 2001
From: Cash Costello <cash.costello@gmail.com>
Date: Sat, 5 Nov 2011 08:01:31 -0400
Subject: Refs #4053 improved documentation of page_handler()

---
 engine/lib/pagehandler.php | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'engine/lib/pagehandler.php')

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)
-- 
cgit v1.2.3