summaryrefslogtreecommitdiff
path: root/sites/all/modules/ctools/help/context-access.html
diff options
context:
space:
mode:
Diffstat (limited to 'sites/all/modules/ctools/help/context-access.html')
-rw-r--r--sites/all/modules/ctools/help/context-access.html12
1 files changed, 12 insertions, 0 deletions
diff --git a/sites/all/modules/ctools/help/context-access.html b/sites/all/modules/ctools/help/context-access.html
new file mode 100644
index 000000000..95a8d7fbe
--- /dev/null
+++ b/sites/all/modules/ctools/help/context-access.html
@@ -0,0 +1,12 @@
+<p>Access plugins allow context based access control to pages.</p>
+<pre> 'title' => Title of the plugin
+ 'description' => Description of the plugin
+ 'callback' => callback to see if there is access is available. params: $conf, $contexts, $account
+ 'required context' => zero or more required contexts for this access plugin
+ 'default' => an array of defaults or a callback giving defaults
+ 'settings form' => settings form. params: &$form, &$form_state, $conf
+ settings form validate
+ settings form submit
+</pre>
+
+<p><strong>Warning:</strong> your settings array will be stored <strong>in the meny system</strong> to reduce loads, so be <strong>trim</strong>.</p> \ No newline at end of file