summaryrefslogtreecommitdiff
path: root/modules/block/block.api.php
diff options
context:
space:
mode:
Diffstat (limited to 'modules/block/block.api.php')
-rw-r--r--modules/block/block.api.php6
1 files changed, 6 insertions, 0 deletions
diff --git a/modules/block/block.api.php b/modules/block/block.api.php
index e8a589742..9cc2f602e 100644
--- a/modules/block/block.api.php
+++ b/modules/block/block.api.php
@@ -57,6 +57,12 @@
* - DRUPAL_CACHE_GLOBAL: The block is the same for every user on every
* page where it is visible.
* - DRUPAL_NO_CACHE: The block should not get cached.
+ * - 'properties': (optional) Array of additional metadata to add to the
+ * block. Common properties include:
+ * - 'administrative': Boolean which categorizes this block as usable in
+ * an administrative context. This might include blocks which help an
+ * administrator approve/deny comments, or view recently created
+ * user accounts.
* - 'weight': (optional) Initial value for the ordering weight of this block.
* Most modules do not provide an initial value, and any value provided can
* be modified by a user on the block configuration screen.