shopp('product.description')

Displays the product description.

shopp('product', 'description', 'options')

@param string $object the object or object.tag combination, if object.tag is used, the tag parameter can be omitted
@param string $tag the tag, can be hyphenated or not. Prefix with 'get' as shorthand for the return=true option
@param mixed $options associative array, or url-style name=value pairs separated by ampersands (&). Each pair is passed to the theme api tag as an option.
@returns void by default, the product description markup if the return option is used.

Alternative Forms

shopp('product.description', 'options');

Description

Displays the product description.

When this tag is used on a single product page, the WordPress query will populate the product description. When this tag is used inside the product loop on a collection page, the description must be explicitly loaded as a load option of shopp(‘collection’,’has-products’). This is because the description field can often contain a lot of data, and adds significantly to the loaded memory on collection pages.

Universal Options

All Theme API calls have these options.

  • return: when set to true, 1, or on, this option forces the tag to return the value instead of displaying/echoing the value to the page. Alternatively, prefix the tag parameter with get to get the same effect. All theme api tags that return a boolean value will return by default.
  • echo: when set to false, 0, or off, this option forces the tag to display the value to the page. This is the default for all non-boolean tags.
  • is: when set to true, 1, or on, this option will evaluate the return of the theme api call as a boolean true or false value. See how values are converted to boolean.

Options

None

Examples

shopp('product', 'description');
// assign the product description to a variable
$description = shopp('product.get-description');

Used on product collection page

if ( shopp('collection','has-products','load=description') ) {
    while ( shopp('collection','products') ) {
        shopp('product', 'description');
    }
}

See Also

You must be logged in to post a comment.

© Ingenesis Limited. Shopp™ is a registered trademark of Ingenesis Limited.

Skip to toolbar