summaryrefslogtreecommitdiff
path: root/modules/block
diff options
context:
space:
mode:
authorJennifer Hodgdon <yahgrp@poplarware.com>2013-08-13 07:51:08 -0700
committerJennifer Hodgdon <yahgrp@poplarware.com>2013-08-13 07:51:08 -0700
commit83c329fc8975d7a89b1cbc2d827fd8aea7b617bd (patch)
tree3caacb4c65000692ce86f88f9710d6e5d4b608cf /modules/block
parent4c67cb91d4cc458af7d5ff553c89a8a18d80ab5b (diff)
downloadbrdo-83c329fc8975d7a89b1cbc2d827fd8aea7b617bd.tar.gz
brdo-83c329fc8975d7a89b1cbc2d827fd8aea7b617bd.tar.bz2
Issue #2044791 by skipyT, alexandre.todorov, joachim: Clarify documentation of hook_block_view around empty return values
Diffstat (limited to 'modules/block')
-rw-r--r--modules/block/block.api.php6
1 files changed, 4 insertions, 2 deletions
diff --git a/modules/block/block.api.php b/modules/block/block.api.php
index e63994ebd..d8e129e2f 100644
--- a/modules/block/block.api.php
+++ b/modules/block/block.api.php
@@ -200,11 +200,13 @@ function hook_block_save($delta = '', $edit = array()) {
* within the module, defined in hook_block_info().
*
* @return
- * An array containing the following elements:
+ * Either an empty array so the block will not be shown or an array containing
+ * the following elements:
* - subject: The default localized title of the block. If the block does not
* have a default title, this should be set to NULL.
* - content: The content of the block's body. This may be a renderable array
- * (preferable) or a string containing rendered HTML content.
+ * (preferable) or a string containing rendered HTML content. If the content
+ * is empty the block will not be shown.
*
* For a detailed usage example, see block_example.module.
*