Refs #4053 improved documentation of page_handler()

diff --git a/engine/lib/pagehandler.php b/engine/lib/pagehandler.php
index f331e2aae367dac07be1555c443332634cd7db93..aba921416caf88fb7603f3cdd460d7433033efd8 100644 (file)
--- 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)