Drupal专业开发指南 第9章 Drupal区块（Drupal block）（2） 区块钩子方法

 

                                                     使用区块钩子

 

译者： 老葛，eskalate科技公司

在用代码创建区块时，我们在钩子方法 hook_block（）中处理所有的逻辑。通过这个钩子，你可以创建一个单独的区块或者一组区块。任何模块都可以通过其钩子方法创建区块。让我们看下该函数的方法签名：

function hook_block($op = 'list', $delta = 0, $edit = array())

 

参数列表

区块钩子中使用的参数在接下来的部分讨论。

$op:这一参数用于定义一个区块在传递过来时所处的阶段。通过参数$op来定义一个操作阶段，这一模型在Drupal中是常用的框架---例如hook_nodeapi()和hook_user()中都用到。

$op的可能值如下：

list：返回包含模块定义的所有区块的数组。数组的键值是delta(在本模块定义的区块范围内，它是唯一标识符)。那么每个数据元素的值是一个提供了区块重要数据的一个数组，list的可能值和默认值，如下：

    info：一个可国际化的字符串（例如，通过t()包装），为站点管理员提供了一个合适的描述。

    status：区块启用为True，禁用为FALSE，默认为FALSE。

    region：默认区域为左栏。

    weight：它控制着区块在它的区域内的放置次序。重量越小，位置越靠前，水平方向是靠左方，垂直方向是靠上方。重量越大，越靠后。默认值为0.

    pages：定义节点所在的默认页面。默认是一个空字符串。Pages的值是通过换行分隔的Drupal路径，*为通配符。例如，路径blog为日志首页，而blog/*则为每个个人日志页面。<front>代表首页。

    custom：TRUE代表着这个区块是通过后台接口创建的，而FALSE则代表着它是通过模块实现的区块。

    title:区块的默认标题。

    configure:返回一个用于区块特定设定的表单字段的数组。它整合了默认后台接口的表单数组，从而使你能够扩展区块的配置方式。如果你实现了它，你同时还需要实现保存(save)操作$op(参看下面)。

    save：当配置表单提交时被调用。当你的模块可以保存你在配置操作$op中收集的定制化的区块的配置信息时，使用该操作。你想保存的操作包含在变量$edit中。

    view：区块被显示。返回一个包含区块标题和内容的数组。

 

$delta:这是返回的区块ID。这里你可以使用一个整数或者一个字符串，注意当操作$op的状态为list时，$delta被忽略。

$edit: 当操作为保存时，$edit包含了从区块配置表单提交过来的表单数据。