shopp('purchase.item-type')

Display the item type of the current purchased item.

shopp('purchase', 'item-type', '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 item type if return option is used.

Alternative Forms

shopp('purchase.item-type', 'options...');

Description

Display the item type of the current purchased item.

The item type is not translated into your native language.

The item type will be one of:

  • Shipped – a shipped item
  • Virtual – a virtual (intangible) item
  • Download – a downloadable item
  • Donation – a donation
  • Subscription – a subscription item
  • Membership – a membership (coming in a later version)

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('purchase', 'item-type');
if ( 'Donation' == shopp('purchase', 'get-item-type') ) {
    // do stuff for Donation products
}
// use _e() to translate
_e( shopp('purchase', 'get-item-type'), 'Shopp' );

See Also

You must be logged in to post a comment.

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

Skip to toolbar