summaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2011-02-04 20:09:15 +0000
committerDries Buytaert <dries@buytaert.net>2011-02-04 20:09:15 +0000
commit7aabab90cf6f979ab72f45a31dd5033496d22f67 (patch)
tree2488e74ab33fffe41ffa4d26ad229bfd908362fb /modules
parent6a69b824b63210a6026403f476aaad0b4c0145cc (diff)
downloadbrdo-7aabab90cf6f979ab72f45a31dd5033496d22f67.tar.gz
brdo-7aabab90cf6f979ab72f45a31dd5033496d22f67.tar.bz2
- Patch #1045606 by droplet, montesq: hook_block_info() doc should use visibility constants.
Diffstat (limited to 'modules')
-rw-r--r--modules/block/block.api.php12
1 files changed, 6 insertions, 6 deletions
diff --git a/modules/block/block.api.php b/modules/block/block.api.php
index 7b2ce0571..8d74d94e3 100644
--- a/modules/block/block.api.php
+++ b/modules/block/block.api.php
@@ -77,12 +77,12 @@
* enabled theme, the block will be disabled.
* - 'visibility': (optional) Initial value for the visibility flag, which
* tells how to interpret the 'pages' value. Possible values are:
- * - 0: Show on all pages except listed pages. 'pages' lists the paths where
- * the block should not be shown.
- * - 1: Show only on listed pages. 'pages' lists the paths where the block
- * should be shown.
- * - 2: Use custom PHP code to determine visibility. 'pages' gives the PHP
- * code to use.
+ * - BLOCK_VISIBILITY_NOTLISTED: Show on all pages except listed pages.
+ * 'pages' lists the paths where the block should not be shown.
+ * - BLOCK_VISIBILITY_LISTED: Show only on listed pages. 'pages' lists the
+ * paths where the block should be shown.
+ * - BLOCK_VISIBILITY_PHP: Use custom PHP code to determine visibility.
+ * 'pages' gives the PHP code to use.
* Most modules do not provide an initial value for 'visibility' or 'pages',
* and any value provided can be modified by a user on the block
* configuration screen.