aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2011-02-03 03:00:22 +0000
committerbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2011-02-03 03:00:22 +0000
commitb232f52a5273a44e28de239cbacc1e4e4b8cc8b3 (patch)
tree603bcf2bc9dc808a8cdea4eca146861e686639ce
parent4503c58bc954671503650223bbcabe7a2951d415 (diff)
downloadelgg-b232f52a5273a44e28de239cbacc1e4e4b8cc8b3.tar.gz
elgg-b232f52a5273a44e28de239cbacc1e4e4b8cc8b3.tar.bz2
Added more info to the @params documentation for elgg_register_action.
git-svn-id: http://code.elgg.org/elgg/trunk@7997 36083f99-b078-4883-b0ff-0f9b5a30f544
-rw-r--r--engine/lib/actions.php9
1 files changed, 5 insertions, 4 deletions
diff --git a/engine/lib/actions.php b/engine/lib/actions.php
index 0691e306a..8d91820fd 100644
--- a/engine/lib/actions.php
+++ b/engine/lib/actions.php
@@ -123,7 +123,7 @@ function action($action, $forwarder = "") {
* either by the URL http://elggsite.org/action/action_name or by calling
* {@link action()}.
*
- * $file must be the full path of the file to register, or a path relative
+ * $filename must be the full path of the file to register, or a path relative
* to the core actions/ dir.
*
* Actions should be namedspaced for your plugin. Example:
@@ -131,7 +131,7 @@ function action($action, $forwarder = "") {
* elgg_register_action('myplugin/save_settings', ...);
* </code>
*
- * @tip Put action files under the actions/ directory of your plugin.
+ * @tip Put action files under the actions/<plugin_name> directory of your plugin.
*
* @tip You don't need to include engine/start.php, call {@link gatekeeper()},
* or call {@link admin_gatekeeper()}.
@@ -145,8 +145,9 @@ function action($action, $forwarder = "") {
* </code>
*
* @param string $action The name of the action (eg "register", "account/settings/save")
- * @param string $filename Optionally, the filename where this action is located
- * @param string $access Who is allowed to execute this action
+ * @param string $filename Optionally, the filename where this action is located. If not specified,
+ * will assume the action is in elgg/actions/<action>.php
+ * @param string $access Who is allowed to execute this action: admin, public, or logged_in.
*
* @see action()
* @see http://docs.elgg.org/Actions