diff options
author | Jennifer Hodgdon <yahgrp@poplarware.com> | 2014-04-16 16:08:57 -0700 |
---|---|---|
committer | Jennifer Hodgdon <yahgrp@poplarware.com> | 2014-04-16 16:08:57 -0700 |
commit | d2481b8ce8b59d6024f1c9deb464d04ca29f54ad (patch) | |
tree | 927c8dde5273c3a7d088064e5564d1186c6bc1c2 /modules/block | |
parent | 3fbabe4158dd64da32f456ea80b502c6b3500736 (diff) | |
download | brdo-d2481b8ce8b59d6024f1c9deb464d04ca29f54ad.tar.gz brdo-d2481b8ce8b59d6024f1c9deb464d04ca29f54ad.tar.bz2 |
Issue #2195357 by Rajendar Reddy, GoddamnNoise, Pol: Fix docs in hook_block_info()
Diffstat (limited to 'modules/block')
-rw-r--r-- | modules/block/block.api.php | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/modules/block/block.api.php b/modules/block/block.api.php index d8e129e2f..d7453b24b 100644 --- a/modules/block/block.api.php +++ b/modules/block/block.api.php @@ -87,13 +87,13 @@ * and any value provided can be modified by a user on the block * configuration screen. * - pages: (optional) See 'visibility' above. A string that contains one or - * more page paths separated by '\n', '\r', or '\r\n' when 'visibility' is - * set to BLOCK_VISIBILITY_NOTLISTED or BLOCK_VISIBILITY_LISTED, or custom - * PHP code when 'visibility' is set to BLOCK_VISIBILITY_PHP. Paths may use - * '*' as a wildcard (matching any number of characters); '<front>' - * designates the site's front page. For BLOCK_VISIBILITY_PHP, the PHP - * code's return value should be TRUE if the block is to be made visible or - * FALSE if the block should not be visible. + * more page paths separated by "\n", "\r", or "\r\n" when 'visibility' is + * set to BLOCK_VISIBILITY_NOTLISTED or BLOCK_VISIBILITY_LISTED (example: + * "<front>\nnode/1"), or custom PHP code when 'visibility' is set to + * BLOCK_VISIBILITY_PHP. Paths may use '*' as a wildcard (matching any + * number of characters); '<front>' designates the site's front page. For + * BLOCK_VISIBILITY_PHP, the PHP code's return value should be TRUE if the + * block is to be made visible or FALSE if the block should not be visible. * * For a detailed usage example, see block_example.module. * |