函数hook_checkout_pane()位于uc_cart.module模块中:
<?php
hook_checkout_pane()
?>
描述:
Ubercart的结算页面,汇集了所有启用了的结算窗格。结算窗格可以用来显示订单信息,从用户那里收集数据,或者与其它窗格进行交互。模块可以使用hook_checkout_pane()来定义结算窗格,通过特定的回调函数来进行逻辑处理和显示窗格。对于每个窗格,里面的一些设置都可以在结算设置页面进行配置,当然,在钩子函数中你需要声明这些设置的默认值。
默认的窗格定义在uc_cart.module模块的uc_cart_checkout_pane()函数中。这些窗格包括,显示购物车内容的窗格,收集用户重要信息的窗格,一个交货地址窗格,一个支付地址窗格,还有订单评论。其它的模块也提供了一些交货和支付方面的窗格。
返回值:
结算窗格数组的数组,使用以下键:
键 |
类型 |
值 |
id |
string |
结算窗格的内部ID,可以使用a-z, 0-9, 和- 或者_. |
title |
string |
显示在结算表单的窗格的名称。 |
desc |
string |
在管理页面显示的窗格的简短描述。 |
callback |
string |
该窗格的回调函数。结算窗格回调函数的更多文档和例子可参看这一页面。 |
weight |
int |
窗格的默认重量,这个决定了它在结算表单中显示的顺序。 |
enabled |
bool |
可选。窗格的默认启用情况。默认为TRUE。 |
process |
bool |
可选。当结算表单提交时,这个窗格是否需要进行处理。默认为TRUE。 |
collapsible |
bool |
可选。这个窗格是否显示为可伸缩的字段集。默认为TRUE。 |
例如:
<?php
// Taken from uc_cart_checkout_pane() in uc_cart.module.
function uc_cart_checkout_pane() {
$panes[] = array(
'id' => 'cart',
'callback' => 'uc_checkout_pane_cart',
'title' => t('Cart Contents'),
'desc' => t("Display the contents of a customer's shopping cart."),
'weight' => 1,
'process' => FALSE,
'collapsible' => FALSE,
);
return $panes;
}
?>
还可参看:
结算系统文档-里面包含了结算窗格回调函数的文档。
提示追踪 – 一个基本的模块,演示了如何创建一个结算窗格,保存收集的信息,以及将窗格显示在订单页面。