aboutsummaryrefslogtreecommitdiff
path: root/engine/handlers/action_handler.php
diff options
context:
space:
mode:
authorbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-09-17 18:46:58 +0000
committerbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-09-17 18:46:58 +0000
commit1ac20eae82da66f4e29480d97ff8e1d5312ed59b (patch)
tree0ae1125e6ffdf54dac63568352babe34a53ade21 /engine/handlers/action_handler.php
parentcb5df9222c274a6fcf9263cc5fb905b7a76add40 (diff)
downloadelgg-1ac20eae82da66f4e29480d97ff8e1d5312ed59b.tar.gz
elgg-1ac20eae82da66f4e29480d97ff8e1d5312ed59b.tar.bz2
Refs #2450: Added documentation for actions.
git-svn-id: http://code.elgg.org/elgg/trunk@6949 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'engine/handlers/action_handler.php')
-rw-r--r--engine/handlers/action_handler.php3
1 files changed, 3 insertions, 0 deletions
diff --git a/engine/handlers/action_handler.php b/engine/handlers/action_handler.php
index 8a1f1276b..a6bdaeae9 100644
--- a/engine/handlers/action_handler.php
+++ b/engine/handlers/action_handler.php
@@ -6,6 +6,9 @@
* from http://site/action/. Anything after 'action/' is considered the action
* and will be passed to {@link action()}.
*
+ * @warning This sets the input named 'action' to the current action. When calling
+ * an action, get_input('action') will always return the action name.
+ *
* @package Elgg.Core
* @subpackage Actions
* @link http://docs.elgg.org/Tutorials/Actions