You are here

function hook_shipping_type in Ubercart 6.2

Same name and namespace in other branches
  1. 5 docs/hooks.php \hook_shipping_type()

Defines shipping types for shipping methods.

This hook defines a shipping type that this module is designed to handle. These types are specified by a machine- and human-readable name called 'id', and 'title' respectively. Shipping types may be set for individual products, manufacturers, and for the entire store catalog. Shipping modules should be careful to use the same shipping type ids as other similar shipping modules (i.e., FedEx and UPS both operate on "small package" shipments). Modules that do not fulfill orders may not need to implement this hook.

Return value

An array of shipping types keyed by a machine-readable name.

7 functions implement hook_shipping_type()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

uc_product_get_shipping_type in shipping/uc_quote/uc_quote.module
Gets a product's shipping type.
uc_quote_condition_product_shipping_type in shipping/uc_quote/uc_quote.module
Returns TRUE if the order has a product of the chosen shipping type.
uc_quote_get_shipping_type in shipping/uc_quote/uc_quote.module
Retrieves shipping type information from the database.
uc_quote_set_shipping_type in shipping/uc_quote/uc_quote.module
Stores the shipping type of products and manufacturers.
uc_quote_shipping_type in shipping/uc_quote/uc_quote.module
Implements hook_shipping_type().

... See full list

File

docs/hooks.php, line 1423
These are the hooks that are invoked by the Ubercart core.

Code

function hook_shipping_type() {
  $weight = variable_get('uc_quote_type_weight', array(
    'small_package' => 0,
  ));
  $types = array();
  $types['small_package'] = array(
    'id' => 'small_package',
    'title' => t('Small packages'),
    'weight' => $weight['small_package'],
  );
  return $types;
}