函数hook_order_pane()位于uc_order.module模块中:
<?php
hook_order_pane()
?>
描述:
这个钩子是用来向订单查看和管理界面添加窗格的。默认的窗格包含了地址的显示和编辑区域,产品,评论,等等。当开发者需要向订单显示或者修改一些自定义的数据时,就可以使用这个钩子来完成。例如,使用了一个自定义的结算窗格,来查找客户期望的交货日期的Drupal网店,可以创建一个相应的订单窗格,来将数据显示到订单界面上。
在钩子hook_order_pane()中,可以定义一些新的订单窗格,并为它们提供一点信息。对于这个钩子可以定义订单窗格的哪些部分,可参看下面的返回值部分。
订单窗格的要点是它的回调函数(这个也在这个钩子中声明)。回调函数负责处理在哪些页面显示哪些内容,以及可以操作哪些数据。这些都超出了这个API页面的范围,为了了解回调函数中可以包含什么内容,你可以点击这里。
返回值:
函数应该返回一个关联数组,里面包含了你模块定义的订单窗格。这些数组包含了下面的键/值对:
键/ |
类型 |
值 |
id |
string |
订单窗格的内部ID |
callback |
string |
订单窗格回调函数的名称,在各种操作中调用 |
title |
string |
|
desc |
string |
|
class |
string |
|
weight |
integer |
|
show |
array |
|
示例:
<?php
/**
* Implementation of hook_order_pane().
*/
function uc_payment_order_pane() {
$panes[] = array(
'id' => 'payment',
'callback' => 'uc_order_pane_payment',
'title' => t('Payment'),
'desc' => t('Specify and collect payment for an order.'),
'class' => 'pos-left',
'weight' => 4,
'show' => array('view', 'edit', 'customer'),
);
return $panes;
}
?>