function uc_product_get_description in Ubercart 7.3

Same name and namespace in other branches

1. 8.4 uc_product/uc_product.module \uc_product_get_description()
2. 6.2 uc_product/uc_product.module \uc_product_get_description()

Returns HTML for the product description.

Modules adding information use hook_uc_product_description() and modules wanting to alter the output before rendering can do so by implementing hook_uc_product_description_alter(). By default, all descriptions supplied by modules via hook_uc_product_description() are concatenated together.

NOTE: hook_uc_product_description() supercedes the deprecated hook_cart_item_description().

Parameters

$product: Product.

Return value

HTML rendered product description.

4 calls to uc_product_get_description()

hook_uc_cart_display in uc_cart/uc_cart.api.php

Controls the display of an item in the cart.

UcOrderProductController::buildContent in uc_order/uc_order.controller.inc

Overrides EntityAPIController::buildContent().

uc_product_kit_uc_cart_display in uc_product_kit/uc_product_kit.module

Implements hook_uc_cart_display().

uc_product_uc_cart_display in uc_product/uc_product.module

Implements hook_uc_cart_display().

File

uc_product/uc_product.module, line 1479

The product module for Ubercart.

Code

function uc_product_get_description($product) {

  // Run through implementations of hook_uc_product_description().
  $description = module_invoke_all('uc_product_description', $product);

  // Now allow alterations via hook_uc_product_description_alter().
  drupal_alter('uc_product_description', $description, $product);
  return drupal_render($description);
}