summaryrefslogtreecommitdiff
path: root/modules/block
diff options
context:
space:
mode:
authorJennifer Hodgdon <yahgrp@poplarware.com>2013-08-12 12:56:38 -0700
committerJennifer Hodgdon <yahgrp@poplarware.com>2013-08-12 12:56:38 -0700
commit4c67cb91d4cc458af7d5ff553c89a8a18d80ab5b (patch)
tree93fccfd50a0a6f3c1773758fc01d47fcebe6258a /modules/block
parent479fe527b627531ee8d2de96e61640247ff60f17 (diff)
downloadbrdo-4c67cb91d4cc458af7d5ff553c89a8a18d80ab5b.tar.gz
brdo-4c67cb91d4cc458af7d5ff553c89a8a18d80ab5b.tar.bz2
Issue #1967802 by ebargtuo: Fix documentation of block view alter hooks
Diffstat (limited to 'modules/block')
-rw-r--r--modules/block/block.api.php10
1 files changed, 6 insertions, 4 deletions
diff --git a/modules/block/block.api.php b/modules/block/block.api.php
index 312eb11f2..e63994ebd 100644
--- a/modules/block/block.api.php
+++ b/modules/block/block.api.php
@@ -253,8 +253,9 @@ function hook_block_view($delta = '') {
* specific block.
*
* @param $data
- * An array of data, as returned from the hook_block_view() implementation of
- * the module that defined the block:
+ * The data as returned from the hook_block_view() implementation of the
+ * module that defined the block. This could be an empty array or NULL value
+ * (if the block is empty) or an array containing:
* - subject: The default localized title of the block.
* - content: Either a string or a renderable array representing the content
* of the block. You should check that the content is an array before trying
@@ -287,8 +288,9 @@ function hook_block_view_alter(&$data, $block) {
* specific block, rather than implementing hook_block_view_alter().
*
* @param $data
- * An array of data, as returned from the hook_block_view() implementation of
- * the module that defined the block:
+ * The data as returned from the hook_block_view() implementation of the
+ * module that defined the block. This could be an empty array or NULL value
+ * (if the block is empty) or an array containing:
* - subject: The localized title of the block.
* - content: Either a string or a renderable array representing the content
* of the block. You should check that the content is an array before trying